📚 API Documentation

Introduction

The Bodegaly API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

https://api.bodegaly.com/v1

Authentication

The Bodegaly API uses API keys to authenticate requests. You can view and manage your API keys in the Admin Panel.

curl https://api.bodegaly.com/v1/orders \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Rate Limits

The API is rate limited to prevent abuse. The default rate limit is:

• Starter Plan: 100 requests per minute
• Professional Plan: 500 requests per minute
• Enterprise Plan: 2000 requests per minute

Orders

Create an Order

{
  "storeId": "uuid",
  "customerId": "uuid",
  "type": "Delivery",
  "items": [
    {
      "productId": "uuid",
      "quantity": 2,
      "price": 9.99
    }
  ],
  "deliveryAddress": "123 Main St",
  "deliveryCity": "New York",
  "deliveryState": "NY",
  "deliveryZipCode": "10001"
}

Get Order by ID

curl https://api.bodegaly.com/v1/orders/uuid \
  -H "Authorization: Bearer YOUR_API_KEY"

Products

List Products

curl https://api.bodegaly.com/v1/products?storeId=uuid \
  -H "Authorization: Bearer YOUR_API_KEY"

Webhooks

Webhooks allow you to receive real-time notifications when events occur in your Bodegaly account.

Supported Events

• order.created - Triggered when a new order is created
• order.updated - Triggered when an order status changes
• payment.succeeded - Triggered when a payment is successful
• payment.failed - Triggered when a payment fails

Error Codes

SDKs & Libraries

npm install bodegaly-node

pip install bodegaly

composer require bodegaly/bodegaly-php

gem install bodegaly