Skip to main content
POST
/
order
Create Order
curl --request POST \
  --url https://api.satsuma.ai/order \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tip": 123,
  "customer": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "address": {
      "city": "<string>",
      "region": "NY",
      "country": "US",
      "street_address": "<string>",
      "street_address_detail": "<string>",
      "postal_code": "<string>"
    },
    "phone_number": "+12345678901"
  },
  "items": [
    {
      "product_id": "<string>",
      "quantity": 2
    }
  ],
  "location_id": "<string>",
  "fulfillment_method": "Delivery",
  "dropoff_instructions": "<string>"
}'
{
  "data": {
    "id": "<string>",
    "status": "Pending",
    "currency": "USD",
    "tip": 123,
    "subtotal": 123,
    "tax": 123,
    "total": 123,
    "customer": {
      "id": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "address": {
        "street_number": "<string>",
        "street_name": "<string>",
        "street_address": "<string>",
        "street_address_detail": "<string>",
        "city": "<string>",
        "region": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      }
    },
    "fees": [
      {
        "type": "DeliveryFee",
        "amount": 123
      }
    ],
    "items": [
      {
        "quantity": 123,
        "price": 123,
        "product_id": "<string>",
        "product_name": "<string>"
      }
    ],
    "merchant_id": "<string>",
    "location_id": "<string>",
    "fulfillment_method": "Delivery",
    "fee_total": 123,
    "dropoff_instructions": "<string>"
  },
  "messages": [
    {
      "context": "<string>",
      "level": "Information",
      "text": "<string>",
      "data": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication

Body

application/json

Create order request

customer
object
required

Customer information

items
object[]
required

List of items

location_id
string
required

Location ID

fulfillment_method
enum<string>
required

Fulfillment method

Available options:
Delivery,
Pickup,
Shipping
tip
number

Tip amount

dropoff_instructions
string

Dropoff instructions

Response

201 - application/json

Created

data
object
messages
object[]