Orders

Create fulfillment for all items on an order

Commerce7 Fulfillment parity: creates an order fulfillment record and automatically marks every order line as fulfilled.

Path Parameters

id*string

Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*||

fulfillmentDate*string

Formatdate-time

packageCount*integer

Range0 <= value

sendTransactionEmail*boolean

shipped?

pickedUp?

Response Body

`application/json`

curl -X POST "https://example.com/order/string/fulfillment/all" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "type": "Shipped",    "fulfillmentDate": "2019-08-24T14:15:22Z",    "packageCount": 0,    "sendTransactionEmail": true  }'

{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "locationId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "lineItems": [    {      "id": "string",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0        }      ]    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "fulfillments": [    {      "id": "string",      "type": "Shipped",      "fulfillmentDate": "2019-08-24T14:15:22Z",      "packageCount": 0,      "items": [        {          "sku": "string",          "quantityFulfilled": 1        }      ],      "shipped": {        "trackingNumbers": [          "string"        ],        "carrier": "string"      },      "pickedUp": {        "pickedUpBy": "string"      }    }  ]}

Create a shipping, pickup, or no-fulfillment-required record

Commerce7 Fulfillment parity: create the documented fulfillment variant on the order and return the updated order object.

Path Parameters

id*string

Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*|string|string

fulfillmentDate*string

Formatdate-time

packageCount*integer

Range0 <= value

sendTransactionEmail*boolean

items*array<>

shipped*

Response Body

`application/json`

curl -X POST "https://example.com/order/string/fulfillment" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "fulfillmentDate": "2019-08-24T14:15:22Z",    "packageCount": 0,    "sendTransactionEmail": true,    "type": "Shipped",    "items": [      {        "sku": "string",        "quantityFulfilled": 1      }    ],    "shipped": {      "trackingNumbers": [        "string"      ]    }  }'

{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "locationId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "lineItems": [    {      "id": "string",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0        }      ]    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "fulfillments": [    {      "id": "string",      "type": "Shipped",      "fulfillmentDate": "2019-08-24T14:15:22Z",      "packageCount": 0,      "items": [        {          "sku": "string",          "quantityFulfilled": 1        }      ],      "shipped": {        "trackingNumbers": [          "string"        ],        "carrier": "string"      },      "pickedUp": {        "pickedUpBy": "string"      }    }  ]}

Delete a fulfillment record

Commerce7 Fulfillment parity: removes the fulfillment record from the order and returns a 204 response.

Path Parameters

id*string

Fulfillment id

Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

curl -X DELETE "https://example.com/order/string/fulfillment/{id}" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

Empty

List orders

Exact Commerce7-style singular order list path.

Query Parameters

q?string

locationId?string

createdAfter?string

Formatdate-time

createdBefore?string

Formatdate-time

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

`application/json`

curl -X GET "https://example.com/order" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

{  "orders": [    {      "id": "string",      "orderNumber": 0,      "customerId": "string",      "customerName": "string",      "guestName": "string",      "locationId": "string",      "assignedStaffUserId": "string",      "status": "draft",      "source": "pos",      "fulfillmentMode": "dine_in",      "tableId": "string",      "sectionId": "string",      "serviceAreaId": "string",      "tableLabel": "string",      "seatCount": 0,      "note": "string",      "fundraising": {        "campaignId": "string",        "campaignCode": "string",        "campaignName": "string",        "causeName": "string",        "contributionType": "round_up",        "contributionValue": 0,        "contributionAmountCents": 0      },      "lineItems": [        {          "id": "string",          "lineType": "catalog",          "sendStatus": "new",          "productId": "string",          "title": "string",          "quantity": 1,          "unitPrice": 0,          "taxRateBps": 0,          "taxCode": "food",          "category": "string",          "salesCategory": "string",          "openItemScope": "food",          "pricingStrategyApplied": "base",          "menuId": "string",          "sizeName": "string",          "seatId": "string",          "seatNumber": 1,          "course": "string",          "diningOption": "dine_in",          "diningOptionLabel": "string",          "prepTimeSeconds": 0,          "modifiers": [            {              "productId": "string",              "title": "string",              "priceDelta": 0,              "quantity": 1,              "groupId": "string",              "groupTitle": "string",              "portionId": "string",              "portionLabel": "string",              "portionPriceMultiplier": 0,              "pricingStrategy": "no_charge",              "openPriceAmount": 0,              "sizeName": "string",              "sequenceOrdinal": 1,              "preModifierOptionId": "string",              "preModifierLabel": "string",              "preModifierPosition": "prefix",              "displayLabel": "string",              "defaultApplied": true,              "modifiers": [                null              ],              "routing": {                "prepStationIds": [                  "string"                ],                "assemblyLineId": "string",                "immediatePrepStationIds": [                  "string"                ],                "modifierRouting": "with_parent",                "ticketDestination": "prep_only",                "appliedRuleIds": [                  "string"                ]              }            }          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          },          "voidReasonId": "string",          "voidReasonName": "string",          "voidedAt": "string",          "voidedByStaffUserId": "string",          "voidedByStaffName": "string",          "giftCardSale": {            "cardType": "Physical",            "code": "string",            "recipientName": "string",            "recipientEmail": "string",            "recipientPhone": "string",            "fromName": "string",            "purchaserEmail": "string",            "purchaserPhone": "string",            "giftMessage": "string",            "notes": "string",            "deliveryChannel": "email",            "deliveryDestination": "string",            "deliveryScheduledAt": "2019-08-24T14:15:22Z",            "notifyPurchaserWhenOpened": true          }        }      ],      "appliedDiscounts": [        {          "id": "string",          "sourceType": "promotion",          "sourceId": "string",          "code": "string",          "title": "string",          "scope": "order",          "lineItemId": "string",          "actionMessage": "string",          "appliesTo": "Store",          "appliesToObjectIds": [            "string"          ],          "combinability": "combinable",          "stackingScope": "order",          "requiresManagerApproval": true,          "managerApprovedByStaffUserId": "string",          "excludesServiceCharges": true,          "serviceChargeInteraction": "pre_discount",          "eligibilitySummary": "string",          "discountType": "amount",          "value": 0,          "amount": 0        }      ],      "subtotal": 0,      "discountTotal": 0,      "taxTotal": 0,      "tipTotal": 0,      "total": 0,      "balanceDue": 0,      "paymentIntentIds": [        "string"      ],      "submittedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "offPremise": {        "channel": {          "kind": "first_party",          "provider": "string"        },        "customer": {          "customerId": "string",          "firstName": "string",          "lastName": "string",          "phone": "string",          "email": "user@example.com"        },        "quote": {          "strategy": "manual",          "quoteTimeApplies": true,          "quotedAt": "2019-08-24T14:15:22Z",          "scheduledFor": "2019-08-24T14:15:22Z",          "promisedFulfillmentAt": "2019-08-24T14:15:22Z",          "takeoutQuoteMinutes": 0,          "deliveryQuoteMinutes": 0,          "takeoutThrottlingMinutes": 0,          "deliveryThrottlingMinutes": 0,          "throttlingAppliedMinutes": 0,          "leadTimeHours": 0,          "minimumLeadTimeSatisfied": true,          "withinConfiguredOrderingHours": true,          "quoteExemptionReason": "third_party_channel"        },        "readyAt": "2019-08-24T14:15:22Z",        "staging": {          "state": "pending",          "batchId": "string",          "batchLabel": "string",          "stagingArea": "string",          "stagingSlot": "string",          "handoffZone": "string",          "batchReadyAt": "2019-08-24T14:15:22Z",          "stagedAt": "2019-08-24T14:15:22Z",          "readyBy": {            "staffUserId": "string",            "displayName": "string"          }        },        "guestMessaging": {          "enabled": true,          "preferredChannel": "sms",          "notifications": [            {              "event": "batch_ready",              "template": "order_ready",              "channel": "sms",              "status": "pending",              "recipient": "string",              "subject": "string",              "body": "string",              "updatedAt": "2019-08-24T14:15:22Z",              "sentAt": "2019-08-24T14:15:22Z",              "failureReason": "string"            }          ],          "lastUpdatedAt": "2019-08-24T14:15:22Z"        },        "pickup": {          "kind": "standard",          "state": "pending",          "stagedAt": "2019-08-24T14:15:22Z",          "arrivedAt": "2019-08-24T14:15:22Z",          "completedAt": "2019-08-24T14:15:22Z",          "curbside": {            "vehicleMakeModel": "string",            "vehicleColor": "string",            "instructions": "string",            "parkingSpot": "string",            "arrivalNote": "string"          }        },        "delivery": {          "addressId": "string",          "addressLabel": "string",          "state": "pending",          "instructions": "string",          "deliveryNotes": "string",          "stagedAt": "2019-08-24T14:15:22Z",          "dispatchedAt": "2019-08-24T14:15:22Z",          "deliveredAt": "2019-08-24T14:15:22Z",          "dispatchNote": "string",          "dispatch": {            "assignmentMode": "unassigned",            "assignedDriver": {              "staffUserId": "string",              "displayName": "string"            },            "dispatchedBy": {              "staffUserId": "string",              "displayName": "string"            },            "courierName": "string",            "courierPhone": "string",            "vehicleLabel": "string",            "assignedAt": "2019-08-24T14:15:22Z"          }        },        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    }  ],  "total": 0}

Create order

Exact Commerce7-style singular order creation path.

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customerId?string

locationId*string

assignedStaffUserId?string

fulfillmentMode*||||

tableId?string

sectionId?string

serviceAreaId?string

tableLabel?string

seatCount?integer

note?string

source?|||

serviceTimestamp?string

Formatdate-time

lineItems*array<|>

appliedDiscounts?array<>

discountTotal?integer

Range0 <= value

tipTotal?integer

Range0 <= value

offPremise?

fundraising?

Response Body

`application/json`

curl -X POST "https://example.com/order" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "locationId": "string",    "fulfillmentMode": "dine_in",    "lineItems": [      {        "productId": "string",        "quantity": 1      }    ]  }'

{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "customerName": "string",  "guestName": "string",  "locationId": "string",  "assignedStaffUserId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "fundraising": {    "campaignId": "string",    "campaignCode": "string",    "campaignName": "string",    "causeName": "string",    "contributionType": "round_up",    "contributionValue": 0,    "contributionAmountCents": 0  },  "lineItems": [    {      "id": "string",      "lineType": "catalog",      "sendStatus": "new",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "taxCode": "food",      "category": "string",      "salesCategory": "string",      "openItemScope": "food",      "pricingStrategyApplied": "base",      "menuId": "string",      "sizeName": "string",      "seatId": "string",      "seatNumber": 1,      "course": "string",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "prepTimeSeconds": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0,          "quantity": 1,          "groupId": "string",          "groupTitle": "string",          "portionId": "string",          "portionLabel": "string",          "portionPriceMultiplier": 0,          "pricingStrategy": "no_charge",          "openPriceAmount": 0,          "sizeName": "string",          "sequenceOrdinal": 1,          "preModifierOptionId": "string",          "preModifierLabel": "string",          "preModifierPosition": "prefix",          "displayLabel": "string",          "defaultApplied": true,          "modifiers": [            null          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          }        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "immediatePrepStationIds": [          "string"        ],        "modifierRouting": "with_parent",        "ticketDestination": "prep_only",        "appliedRuleIds": [          "string"        ]      },      "voidReasonId": "string",      "voidReasonName": "string",      "voidedAt": "string",      "voidedByStaffUserId": "string",      "voidedByStaffName": "string",      "giftCardSale": {        "cardType": "Physical",        "code": "string",        "recipientName": "string",        "recipientEmail": "string",        "recipientPhone": "string",        "fromName": "string",        "purchaserEmail": "string",        "purchaserPhone": "string",        "giftMessage": "string",        "notes": "string",        "deliveryChannel": "email",        "deliveryDestination": "string",        "deliveryScheduledAt": "2019-08-24T14:15:22Z",        "notifyPurchaserWhenOpened": true      }    }  ],  "appliedDiscounts": [    {      "id": "string",      "sourceType": "promotion",      "sourceId": "string",      "code": "string",      "title": "string",      "scope": "order",      "lineItemId": "string",      "actionMessage": "string",      "appliesTo": "Store",      "appliesToObjectIds": [        "string"      ],      "combinability": "combinable",      "stackingScope": "order",      "requiresManagerApproval": true,      "managerApprovedByStaffUserId": "string",      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "eligibilitySummary": "string",      "discountType": "amount",      "value": 0,      "amount": 0    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "offPremise": {    "channel": {      "kind": "first_party",      "provider": "string"    },    "customer": {      "customerId": "string",      "firstName": "string",      "lastName": "string",      "phone": "string",      "email": "user@example.com"    },    "quote": {      "strategy": "manual",      "quoteTimeApplies": true,      "quotedAt": "2019-08-24T14:15:22Z",      "scheduledFor": "2019-08-24T14:15:22Z",      "promisedFulfillmentAt": "2019-08-24T14:15:22Z",      "takeoutQuoteMinutes": 0,      "deliveryQuoteMinutes": 0,      "takeoutThrottlingMinutes": 0,      "deliveryThrottlingMinutes": 0,      "throttlingAppliedMinutes": 0,      "leadTimeHours": 0,      "minimumLeadTimeSatisfied": true,      "withinConfiguredOrderingHours": true,      "quoteExemptionReason": "third_party_channel"    },    "readyAt": "2019-08-24T14:15:22Z",    "staging": {      "state": "pending",      "batchId": "string",      "batchLabel": "string",      "stagingArea": "string",      "stagingSlot": "string",      "handoffZone": "string",      "batchReadyAt": "2019-08-24T14:15:22Z",      "stagedAt": "2019-08-24T14:15:22Z",      "readyBy": {        "staffUserId": "string",        "displayName": "string"      }    },    "guestMessaging": {      "enabled": true,      "preferredChannel": "sms",      "notifications": [        {          "event": "batch_ready",          "template": "order_ready",          "channel": "sms",          "status": "pending",          "recipient": "string",          "subject": "string",          "body": "string",          "updatedAt": "2019-08-24T14:15:22Z",          "sentAt": "2019-08-24T14:15:22Z",          "failureReason": "string"        }      ],      "lastUpdatedAt": "2019-08-24T14:15:22Z"    },    "pickup": {      "kind": "standard",      "state": "pending",      "stagedAt": "2019-08-24T14:15:22Z",      "arrivedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "curbside": {        "vehicleMakeModel": "string",        "vehicleColor": "string",        "instructions": "string",        "parkingSpot": "string",        "arrivalNote": "string"      }    },    "delivery": {      "addressId": "string",      "addressLabel": "string",      "state": "pending",      "instructions": "string",      "deliveryNotes": "string",      "stagedAt": "2019-08-24T14:15:22Z",      "dispatchedAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "dispatchNote": "string",      "dispatch": {        "assignmentMode": "unassigned",        "assignedDriver": {          "staffUserId": "string",          "displayName": "string"        },        "dispatchedBy": {          "staffUserId": "string",          "displayName": "string"        },        "courierName": "string",        "courierPhone": "string",        "vehicleLabel": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Upsert order

Exact Commerce7-style upsert path.

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id?string

customerId?string

locationId*string

assignedStaffUserId?string

fulfillmentMode*||||

tableId?string

sectionId?string

serviceAreaId?string

tableLabel?string

seatCount?integer

note?string

source?|||

serviceTimestamp?string

Formatdate-time

lineItems*array<|>

appliedDiscounts?array<>

discountTotal?integer

Range0 <= value

tipTotal?integer

Range0 <= value

offPremise?

fundraising?

Response Body

`application/json`

curl -X PUT "https://example.com/order/upsert" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "locationId": "string",    "fulfillmentMode": "dine_in",    "lineItems": [      {        "productId": "string",        "quantity": 1      }    ]  }'

{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "customerName": "string",  "guestName": "string",  "locationId": "string",  "assignedStaffUserId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "fundraising": {    "campaignId": "string",    "campaignCode": "string",    "campaignName": "string",    "causeName": "string",    "contributionType": "round_up",    "contributionValue": 0,    "contributionAmountCents": 0  },  "lineItems": [    {      "id": "string",      "lineType": "catalog",      "sendStatus": "new",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "taxCode": "food",      "category": "string",      "salesCategory": "string",      "openItemScope": "food",      "pricingStrategyApplied": "base",      "menuId": "string",      "sizeName": "string",      "seatId": "string",      "seatNumber": 1,      "course": "string",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "prepTimeSeconds": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0,          "quantity": 1,          "groupId": "string",          "groupTitle": "string",          "portionId": "string",          "portionLabel": "string",          "portionPriceMultiplier": 0,          "pricingStrategy": "no_charge",          "openPriceAmount": 0,          "sizeName": "string",          "sequenceOrdinal": 1,          "preModifierOptionId": "string",          "preModifierLabel": "string",          "preModifierPosition": "prefix",          "displayLabel": "string",          "defaultApplied": true,          "modifiers": [            null          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          }        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "immediatePrepStationIds": [          "string"        ],        "modifierRouting": "with_parent",        "ticketDestination": "prep_only",        "appliedRuleIds": [          "string"        ]      },      "voidReasonId": "string",      "voidReasonName": "string",      "voidedAt": "string",      "voidedByStaffUserId": "string",      "voidedByStaffName": "string",      "giftCardSale": {        "cardType": "Physical",        "code": "string",        "recipientName": "string",        "recipientEmail": "string",        "recipientPhone": "string",        "fromName": "string",        "purchaserEmail": "string",        "purchaserPhone": "string",        "giftMessage": "string",        "notes": "string",        "deliveryChannel": "email",        "deliveryDestination": "string",        "deliveryScheduledAt": "2019-08-24T14:15:22Z",        "notifyPurchaserWhenOpened": true      }    }  ],  "appliedDiscounts": [    {      "id": "string",      "sourceType": "promotion",      "sourceId": "string",      "code": "string",      "title": "string",      "scope": "order",      "lineItemId": "string",      "actionMessage": "string",      "appliesTo": "Store",      "appliesToObjectIds": [        "string"      ],      "combinability": "combinable",      "stackingScope": "order",      "requiresManagerApproval": true,      "managerApprovedByStaffUserId": "string",      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "eligibilitySummary": "string",      "discountType": "amount",      "value": 0,      "amount": 0    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "offPremise": {    "channel": {      "kind": "first_party",      "provider": "string"    },    "customer": {      "customerId": "string",      "firstName": "string",      "lastName": "string",      "phone": "string",      "email": "user@example.com"    },    "quote": {      "strategy": "manual",      "quoteTimeApplies": true,      "quotedAt": "2019-08-24T14:15:22Z",      "scheduledFor": "2019-08-24T14:15:22Z",      "promisedFulfillmentAt": "2019-08-24T14:15:22Z",      "takeoutQuoteMinutes": 0,      "deliveryQuoteMinutes": 0,      "takeoutThrottlingMinutes": 0,      "deliveryThrottlingMinutes": 0,      "throttlingAppliedMinutes": 0,      "leadTimeHours": 0,      "minimumLeadTimeSatisfied": true,      "withinConfiguredOrderingHours": true,      "quoteExemptionReason": "third_party_channel"    },    "readyAt": "2019-08-24T14:15:22Z",    "staging": {      "state": "pending",      "batchId": "string",      "batchLabel": "string",      "stagingArea": "string",      "stagingSlot": "string",      "handoffZone": "string",      "batchReadyAt": "2019-08-24T14:15:22Z",      "stagedAt": "2019-08-24T14:15:22Z",      "readyBy": {        "staffUserId": "string",        "displayName": "string"      }    },    "guestMessaging": {      "enabled": true,      "preferredChannel": "sms",      "notifications": [        {          "event": "batch_ready",          "template": "order_ready",          "channel": "sms",          "status": "pending",          "recipient": "string",          "subject": "string",          "body": "string",          "updatedAt": "2019-08-24T14:15:22Z",          "sentAt": "2019-08-24T14:15:22Z",          "failureReason": "string"        }      ],      "lastUpdatedAt": "2019-08-24T14:15:22Z"    },    "pickup": {      "kind": "standard",      "state": "pending",      "stagedAt": "2019-08-24T14:15:22Z",      "arrivedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "curbside": {        "vehicleMakeModel": "string",        "vehicleColor": "string",        "instructions": "string",        "parkingSpot": "string",        "arrivalNote": "string"      }    },    "delivery": {      "addressId": "string",      "addressLabel": "string",      "state": "pending",      "instructions": "string",      "deliveryNotes": "string",      "stagedAt": "2019-08-24T14:15:22Z",      "dispatchedAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "dispatchNote": "string",      "dispatch": {        "assignmentMode": "unassigned",        "assignedDriver": {          "staffUserId": "string",          "displayName": "string"        },        "dispatchedBy": {          "staffUserId": "string",          "displayName": "string"        },        "courierName": "string",        "courierPhone": "string",        "vehicleLabel": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Retrieve order

Path Parameters

id*string

Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

`application/json`

curl -X GET "https://example.com/order/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "customerName": "string",  "guestName": "string",  "locationId": "string",  "assignedStaffUserId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "fundraising": {    "campaignId": "string",    "campaignCode": "string",    "campaignName": "string",    "causeName": "string",    "contributionType": "round_up",    "contributionValue": 0,    "contributionAmountCents": 0  },  "lineItems": [    {      "id": "string",      "lineType": "catalog",      "sendStatus": "new",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "taxCode": "food",      "category": "string",      "salesCategory": "string",      "openItemScope": "food",      "pricingStrategyApplied": "base",      "menuId": "string",      "sizeName": "string",      "seatId": "string",      "seatNumber": 1,      "course": "string",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "prepTimeSeconds": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0,          "quantity": 1,          "groupId": "string",          "groupTitle": "string",          "portionId": "string",          "portionLabel": "string",          "portionPriceMultiplier": 0,          "pricingStrategy": "no_charge",          "openPriceAmount": 0,          "sizeName": "string",          "sequenceOrdinal": 1,          "preModifierOptionId": "string",          "preModifierLabel": "string",          "preModifierPosition": "prefix",          "displayLabel": "string",          "defaultApplied": true,          "modifiers": [            null          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          }        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "immediatePrepStationIds": [          "string"        ],        "modifierRouting": "with_parent",        "ticketDestination": "prep_only",        "appliedRuleIds": [          "string"        ]      },      "voidReasonId": "string",      "voidReasonName": "string",      "voidedAt": "string",      "voidedByStaffUserId": "string",      "voidedByStaffName": "string",      "giftCardSale": {        "cardType": "Physical",        "code": "string",        "recipientName": "string",        "recipientEmail": "string",        "recipientPhone": "string",        "fromName": "string",        "purchaserEmail": "string",        "purchaserPhone": "string",        "giftMessage": "string",        "notes": "string",        "deliveryChannel": "email",        "deliveryDestination": "string",        "deliveryScheduledAt": "2019-08-24T14:15:22Z",        "notifyPurchaserWhenOpened": true      }    }  ],  "appliedDiscounts": [    {      "id": "string",      "sourceType": "promotion",      "sourceId": "string",      "code": "string",      "title": "string",      "scope": "order",      "lineItemId": "string",      "actionMessage": "string",      "appliesTo": "Store",      "appliesToObjectIds": [        "string"      ],      "combinability": "combinable",      "stackingScope": "order",      "requiresManagerApproval": true,      "managerApprovedByStaffUserId": "string",      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "eligibilitySummary": "string",      "discountType": "amount",      "value": 0,      "amount": 0    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "offPremise": {    "channel": {      "kind": "first_party",      "provider": "string"    },    "customer": {      "customerId": "string",      "firstName": "string",      "lastName": "string",      "phone": "string",      "email": "user@example.com"    },    "quote": {      "strategy": "manual",      "quoteTimeApplies": true,      "quotedAt": "2019-08-24T14:15:22Z",      "scheduledFor": "2019-08-24T14:15:22Z",      "promisedFulfillmentAt": "2019-08-24T14:15:22Z",      "takeoutQuoteMinutes": 0,      "deliveryQuoteMinutes": 0,      "takeoutThrottlingMinutes": 0,      "deliveryThrottlingMinutes": 0,      "throttlingAppliedMinutes": 0,      "leadTimeHours": 0,      "minimumLeadTimeSatisfied": true,      "withinConfiguredOrderingHours": true,      "quoteExemptionReason": "third_party_channel"    },    "readyAt": "2019-08-24T14:15:22Z",    "staging": {      "state": "pending",      "batchId": "string",      "batchLabel": "string",      "stagingArea": "string",      "stagingSlot": "string",      "handoffZone": "string",      "batchReadyAt": "2019-08-24T14:15:22Z",      "stagedAt": "2019-08-24T14:15:22Z",      "readyBy": {        "staffUserId": "string",        "displayName": "string"      }    },    "guestMessaging": {      "enabled": true,      "preferredChannel": "sms",      "notifications": [        {          "event": "batch_ready",          "template": "order_ready",          "channel": "sms",          "status": "pending",          "recipient": "string",          "subject": "string",          "body": "string",          "updatedAt": "2019-08-24T14:15:22Z",          "sentAt": "2019-08-24T14:15:22Z",          "failureReason": "string"        }      ],      "lastUpdatedAt": "2019-08-24T14:15:22Z"    },    "pickup": {      "kind": "standard",      "state": "pending",      "stagedAt": "2019-08-24T14:15:22Z",      "arrivedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "curbside": {        "vehicleMakeModel": "string",        "vehicleColor": "string",        "instructions": "string",        "parkingSpot": "string",        "arrivalNote": "string"      }    },    "delivery": {      "addressId": "string",      "addressLabel": "string",      "state": "pending",      "instructions": "string",      "deliveryNotes": "string",      "stagedAt": "2019-08-24T14:15:22Z",      "dispatchedAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "dispatchNote": "string",      "dispatch": {        "assignmentMode": "unassigned",        "assignedDriver": {          "staffUserId": "string",          "displayName": "string"        },        "dispatchedBy": {          "staffUserId": "string",          "displayName": "string"        },        "courierName": "string",        "courierPhone": "string",        "vehicleLabel": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Set starting order number

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderNumber*integer

Range1 <= value

Response Body

`application/json`

curl -X PUT "https://example.com/order-number" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "orderNumber": 1  }'

{  "orderNumber": 1,  "updatedAt": "2019-08-24T14:15:22Z"}

List orders

Commerce7 basis: Orders and Fulfillment. This resource includes open-ticket behavior needed for dine-in service as well as completed order records.

Query Parameters

q?string

locationId?string

createdAfter?string

Formatdate-time

createdBefore?string

Formatdate-time

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

`application/json`

curl -X GET "https://example.com/orders" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

{  "orders": [    {      "id": "string",      "orderNumber": 0,      "customerId": "string",      "customerName": "string",      "guestName": "string",      "locationId": "string",      "assignedStaffUserId": "string",      "status": "draft",      "source": "pos",      "fulfillmentMode": "dine_in",      "tableId": "string",      "sectionId": "string",      "serviceAreaId": "string",      "tableLabel": "string",      "seatCount": 0,      "note": "string",      "fundraising": {        "campaignId": "string",        "campaignCode": "string",        "campaignName": "string",        "causeName": "string",        "contributionType": "round_up",        "contributionValue": 0,        "contributionAmountCents": 0      },      "lineItems": [        {          "id": "string",          "lineType": "catalog",          "sendStatus": "new",          "productId": "string",          "title": "string",          "quantity": 1,          "unitPrice": 0,          "taxRateBps": 0,          "taxCode": "food",          "category": "string",          "salesCategory": "string",          "openItemScope": "food",          "pricingStrategyApplied": "base",          "menuId": "string",          "sizeName": "string",          "seatId": "string",          "seatNumber": 1,          "course": "string",          "diningOption": "dine_in",          "diningOptionLabel": "string",          "prepTimeSeconds": 0,          "modifiers": [            {              "productId": "string",              "title": "string",              "priceDelta": 0,              "quantity": 1,              "groupId": "string",              "groupTitle": "string",              "portionId": "string",              "portionLabel": "string",              "portionPriceMultiplier": 0,              "pricingStrategy": "no_charge",              "openPriceAmount": 0,              "sizeName": "string",              "sequenceOrdinal": 1,              "preModifierOptionId": "string",              "preModifierLabel": "string",              "preModifierPosition": "prefix",              "displayLabel": "string",              "defaultApplied": true,              "modifiers": [                null              ],              "routing": {                "prepStationIds": [                  "string"                ],                "assemblyLineId": "string",                "immediatePrepStationIds": [                  "string"                ],                "modifierRouting": "with_parent",                "ticketDestination": "prep_only",                "appliedRuleIds": [                  "string"                ]              }            }          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          },          "voidReasonId": "string",          "voidReasonName": "string",          "voidedAt": "string",          "voidedByStaffUserId": "string",          "voidedByStaffName": "string",          "giftCardSale": {            "cardType": "Physical",            "code": "string",            "recipientName": "string",            "recipientEmail": "string",            "recipientPhone": "string",            "fromName": "string",            "purchaserEmail": "string",            "purchaserPhone": "string",            "giftMessage": "string",            "notes": "string",            "deliveryChannel": "email",            "deliveryDestination": "string",            "deliveryScheduledAt": "2019-08-24T14:15:22Z",            "notifyPurchaserWhenOpened": true          }        }      ],      "appliedDiscounts": [        {          "id": "string",          "sourceType": "promotion",          "sourceId": "string",          "code": "string",          "title": "string",          "scope": "order",          "lineItemId": "string",          "actionMessage": "string",          "appliesTo": "Store",          "appliesToObjectIds": [            "string"          ],          "combinability": "combinable",          "stackingScope": "order",          "requiresManagerApproval": true,          "managerApprovedByStaffUserId": "string",          "excludesServiceCharges": true,          "serviceChargeInteraction": "pre_discount",          "eligibilitySummary": "string",          "discountType": "amount",          "value": 0,          "amount": 0        }      ],      "subtotal": 0,      "discountTotal": 0,      "taxTotal": 0,      "tipTotal": 0,      "total": 0,      "balanceDue": 0,      "paymentIntentIds": [        "string"      ],      "submittedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "offPremise": {        "channel": {          "kind": "first_party",          "provider": "string"        },        "customer": {          "customerId": "string",          "firstName": "string",          "lastName": "string",          "phone": "string",          "email": "user@example.com"        },        "quote": {          "strategy": "manual",          "quoteTimeApplies": true,          "quotedAt": "2019-08-24T14:15:22Z",          "scheduledFor": "2019-08-24T14:15:22Z",          "promisedFulfillmentAt": "2019-08-24T14:15:22Z",          "takeoutQuoteMinutes": 0,          "deliveryQuoteMinutes": 0,          "takeoutThrottlingMinutes": 0,          "deliveryThrottlingMinutes": 0,          "throttlingAppliedMinutes": 0,          "leadTimeHours": 0,          "minimumLeadTimeSatisfied": true,          "withinConfiguredOrderingHours": true,          "quoteExemptionReason": "third_party_channel"        },        "readyAt": "2019-08-24T14:15:22Z",        "staging": {          "state": "pending",          "batchId": "string",          "batchLabel": "string",          "stagingArea": "string",          "stagingSlot": "string",          "handoffZone": "string",          "batchReadyAt": "2019-08-24T14:15:22Z",          "stagedAt": "2019-08-24T14:15:22Z",          "readyBy": {            "staffUserId": "string",            "displayName": "string"          }        },        "guestMessaging": {          "enabled": true,          "preferredChannel": "sms",          "notifications": [            {              "event": "batch_ready",              "template": "order_ready",              "channel": "sms",              "status": "pending",              "recipient": "string",              "subject": "string",              "body": "string",              "updatedAt": "2019-08-24T14:15:22Z",              "sentAt": "2019-08-24T14:15:22Z",              "failureReason": "string"            }          ],          "lastUpdatedAt": "2019-08-24T14:15:22Z"        },        "pickup": {          "kind": "standard",          "state": "pending",          "stagedAt": "2019-08-24T14:15:22Z",          "arrivedAt": "2019-08-24T14:15:22Z",          "completedAt": "2019-08-24T14:15:22Z",          "curbside": {            "vehicleMakeModel": "string",            "vehicleColor": "string",            "instructions": "string",            "parkingSpot": "string",            "arrivalNote": "string"          }        },        "delivery": {          "addressId": "string",          "addressLabel": "string",          "state": "pending",          "instructions": "string",          "deliveryNotes": "string",          "stagedAt": "2019-08-24T14:15:22Z",          "dispatchedAt": "2019-08-24T14:15:22Z",          "deliveredAt": "2019-08-24T14:15:22Z",          "dispatchNote": "string",          "dispatch": {            "assignmentMode": "unassigned",            "assignedDriver": {              "staffUserId": "string",              "displayName": "string"            },            "dispatchedBy": {              "staffUserId": "string",              "displayName": "string"            },            "courierName": "string",            "courierPhone": "string",            "vehicleLabel": "string",            "assignedAt": "2019-08-24T14:15:22Z"          }        },        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    }  ],  "page": {    "total": 0  }}

Create a draft or open order

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customerId?string

locationId*string

assignedStaffUserId?string

fulfillmentMode*||||

tableId?string

sectionId?string

serviceAreaId?string

tableLabel?string

seatCount?integer

note?string

source?|||

serviceTimestamp?string

Formatdate-time

lineItems*array<|>

appliedDiscounts?array<>

discountTotal?integer

Range0 <= value

tipTotal?integer

Range0 <= value

offPremise?

fundraising?

Response Body

`application/json`

curl -X POST "https://example.com/orders" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "locationId": "string",    "fulfillmentMode": "dine_in",    "lineItems": [      {        "productId": "string",        "quantity": 1      }    ]  }'

{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "customerName": "string",  "guestName": "string",  "locationId": "string",  "assignedStaffUserId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "fundraising": {    "campaignId": "string",    "campaignCode": "string",    "campaignName": "string",    "causeName": "string",    "contributionType": "round_up",    "contributionValue": 0,    "contributionAmountCents": 0  },  "lineItems": [    {      "id": "string",      "lineType": "catalog",      "sendStatus": "new",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "taxCode": "food",      "category": "string",      "salesCategory": "string",      "openItemScope": "food",      "pricingStrategyApplied": "base",      "menuId": "string",      "sizeName": "string",      "seatId": "string",      "seatNumber": 1,      "course": "string",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "prepTimeSeconds": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0,          "quantity": 1,          "groupId": "string",          "groupTitle": "string",          "portionId": "string",          "portionLabel": "string",          "portionPriceMultiplier": 0,          "pricingStrategy": "no_charge",          "openPriceAmount": 0,          "sizeName": "string",          "sequenceOrdinal": 1,          "preModifierOptionId": "string",          "preModifierLabel": "string",          "preModifierPosition": "prefix",          "displayLabel": "string",          "defaultApplied": true,          "modifiers": [            null          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          }        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "immediatePrepStationIds": [          "string"        ],        "modifierRouting": "with_parent",        "ticketDestination": "prep_only",        "appliedRuleIds": [          "string"        ]      },      "voidReasonId": "string",      "voidReasonName": "string",      "voidedAt": "string",      "voidedByStaffUserId": "string",      "voidedByStaffName": "string",      "giftCardSale": {        "cardType": "Physical",        "code": "string",        "recipientName": "string",        "recipientEmail": "string",        "recipientPhone": "string",        "fromName": "string",        "purchaserEmail": "string",        "purchaserPhone": "string",        "giftMessage": "string",        "notes": "string",        "deliveryChannel": "email",        "deliveryDestination": "string",        "deliveryScheduledAt": "2019-08-24T14:15:22Z",        "notifyPurchaserWhenOpened": true      }    }  ],  "appliedDiscounts": [    {      "id": "string",      "sourceType": "promotion",      "sourceId": "string",      "code": "string",      "title": "string",      "scope": "order",      "lineItemId": "string",      "actionMessage": "string",      "appliesTo": "Store",      "appliesToObjectIds": [        "string"      ],      "combinability": "combinable",      "stackingScope": "order",      "requiresManagerApproval": true,      "managerApprovedByStaffUserId": "string",      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "eligibilitySummary": "string",      "discountType": "amount",      "value": 0,      "amount": 0    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "offPremise": {    "channel": {      "kind": "first_party",      "provider": "string"    },    "customer": {      "customerId": "string",      "firstName": "string",      "lastName": "string",      "phone": "string",      "email": "user@example.com"    },    "quote": {      "strategy": "manual",      "quoteTimeApplies": true,      "quotedAt": "2019-08-24T14:15:22Z",      "scheduledFor": "2019-08-24T14:15:22Z",      "promisedFulfillmentAt": "2019-08-24T14:15:22Z",      "takeoutQuoteMinutes": 0,      "deliveryQuoteMinutes": 0,      "takeoutThrottlingMinutes": 0,      "deliveryThrottlingMinutes": 0,      "throttlingAppliedMinutes": 0,      "leadTimeHours": 0,      "minimumLeadTimeSatisfied": true,      "withinConfiguredOrderingHours": true,      "quoteExemptionReason": "third_party_channel"    },    "readyAt": "2019-08-24T14:15:22Z",    "staging": {      "state": "pending",      "batchId": "string",      "batchLabel": "string",      "stagingArea": "string",      "stagingSlot": "string",      "handoffZone": "string",      "batchReadyAt": "2019-08-24T14:15:22Z",      "stagedAt": "2019-08-24T14:15:22Z",      "readyBy": {        "staffUserId": "string",        "displayName": "string"      }    },    "guestMessaging": {      "enabled": true,      "preferredChannel": "sms",      "notifications": [        {          "event": "batch_ready",          "template": "order_ready",          "channel": "sms",          "status": "pending",          "recipient": "string",          "subject": "string",          "body": "string",          "updatedAt": "2019-08-24T14:15:22Z",          "sentAt": "2019-08-24T14:15:22Z",          "failureReason": "string"        }      ],      "lastUpdatedAt": "2019-08-24T14:15:22Z"    },    "pickup": {      "kind": "standard",      "state": "pending",      "stagedAt": "2019-08-24T14:15:22Z",      "arrivedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "curbside": {        "vehicleMakeModel": "string",        "vehicleColor": "string",        "instructions": "string",        "parkingSpot": "string",        "arrivalNote": "string"      }    },    "delivery": {      "addressId": "string",      "addressLabel": "string",      "state": "pending",      "instructions": "string",      "deliveryNotes": "string",      "stagedAt": "2019-08-24T14:15:22Z",      "dispatchedAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "dispatchNote": "string",      "dispatch": {        "assignmentMode": "unassigned",        "assignedDriver": {          "staffUserId": "string",          "displayName": "string"        },        "dispatchedBy": {          "staffUserId": "string",          "displayName": "string"        },        "courierName": "string",        "courierPhone": "string",        "vehicleLabel": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Retrieve an order

Path Parameters

id*string

Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

`application/json`

curl -X GET "https://example.com/orders/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "customerName": "string",  "guestName": "string",  "locationId": "string",  "assignedStaffUserId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "fundraising": {    "campaignId": "string",    "campaignCode": "string",    "campaignName": "string",    "causeName": "string",    "contributionType": "round_up",    "contributionValue": 0,    "contributionAmountCents": 0  },  "lineItems": [    {      "id": "string",      "lineType": "catalog",      "sendStatus": "new",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "taxCode": "food",      "category": "string",      "salesCategory": "string",      "openItemScope": "food",      "pricingStrategyApplied": "base",      "menuId": "string",      "sizeName": "string",      "seatId": "string",      "seatNumber": 1,      "course": "string",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "prepTimeSeconds": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0,          "quantity": 1,          "groupId": "string",          "groupTitle": "string",          "portionId": "string",          "portionLabel": "string",          "portionPriceMultiplier": 0,          "pricingStrategy": "no_charge",          "openPriceAmount": 0,          "sizeName": "string",          "sequenceOrdinal": 1,          "preModifierOptionId": "string",          "preModifierLabel": "string",          "preModifierPosition": "prefix",          "displayLabel": "string",          "defaultApplied": true,          "modifiers": [            null          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          }        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "immediatePrepStationIds": [          "string"        ],        "modifierRouting": "with_parent",        "ticketDestination": "prep_only",        "appliedRuleIds": [          "string"        ]      },      "voidReasonId": "string",      "voidReasonName": "string",      "voidedAt": "string",      "voidedByStaffUserId": "string",      "voidedByStaffName": "string",      "giftCardSale": {        "cardType": "Physical",        "code": "string",        "recipientName": "string",        "recipientEmail": "string",        "recipientPhone": "string",        "fromName": "string",        "purchaserEmail": "string",        "purchaserPhone": "string",        "giftMessage": "string",        "notes": "string",        "deliveryChannel": "email",        "deliveryDestination": "string",        "deliveryScheduledAt": "2019-08-24T14:15:22Z",        "notifyPurchaserWhenOpened": true      }    }  ],  "appliedDiscounts": [    {      "id": "string",      "sourceType": "promotion",      "sourceId": "string",      "code": "string",      "title": "string",      "scope": "order",      "lineItemId": "string",      "actionMessage": "string",      "appliesTo": "Store",      "appliesToObjectIds": [        "string"      ],      "combinability": "combinable",      "stackingScope": "order",      "requiresManagerApproval": true,      "managerApprovedByStaffUserId": "string",      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "eligibilitySummary": "string",      "discountType": "amount",      "value": 0,      "amount": 0    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "offPremise": {    "channel": {      "kind": "first_party",      "provider": "string"    },    "customer": {      "customerId": "string",      "firstName": "string",      "lastName": "string",      "phone": "string",      "email": "user@example.com"    },    "quote": {      "strategy": "manual",      "quoteTimeApplies": true,      "quotedAt": "2019-08-24T14:15:22Z",      "scheduledFor": "2019-08-24T14:15:22Z",      "promisedFulfillmentAt": "2019-08-24T14:15:22Z",      "takeoutQuoteMinutes": 0,      "deliveryQuoteMinutes": 0,      "takeoutThrottlingMinutes": 0,      "deliveryThrottlingMinutes": 0,      "throttlingAppliedMinutes": 0,      "leadTimeHours": 0,      "minimumLeadTimeSatisfied": true,      "withinConfiguredOrderingHours": true,      "quoteExemptionReason": "third_party_channel"    },    "readyAt": "2019-08-24T14:15:22Z",    "staging": {      "state": "pending",      "batchId": "string",      "batchLabel": "string",      "stagingArea": "string",      "stagingSlot": "string",      "handoffZone": "string",      "batchReadyAt": "2019-08-24T14:15:22Z",      "stagedAt": "2019-08-24T14:15:22Z",      "readyBy": {        "staffUserId": "string",        "displayName": "string"      }    },    "guestMessaging": {      "enabled": true,      "preferredChannel": "sms",      "notifications": [        {          "event": "batch_ready",          "template": "order_ready",          "channel": "sms",          "status": "pending",          "recipient": "string",          "subject": "string",          "body": "string",          "updatedAt": "2019-08-24T14:15:22Z",          "sentAt": "2019-08-24T14:15:22Z",          "failureReason": "string"        }      ],      "lastUpdatedAt": "2019-08-24T14:15:22Z"    },    "pickup": {      "kind": "standard",      "state": "pending",      "stagedAt": "2019-08-24T14:15:22Z",      "arrivedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "curbside": {        "vehicleMakeModel": "string",        "vehicleColor": "string",        "instructions": "string",        "parkingSpot": "string",        "arrivalNote": "string"      }    },    "delivery": {      "addressId": "string",      "addressLabel": "string",      "state": "pending",      "instructions": "string",      "deliveryNotes": "string",      "stagedAt": "2019-08-24T14:15:22Z",      "dispatchedAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "dispatchNote": "string",      "dispatch": {        "assignmentMode": "unassigned",        "assignedDriver": {          "staffUserId": "string",          "displayName": "string"        },        "dispatchedBy": {          "staffUserId": "string",          "displayName": "string"        },        "courierName": "string",        "courierPhone": "string",        "vehicleLabel": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Update an order in place

Path Parameters

id*string

Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customerId?string

locationId?string

assignedStaffUserId?string

fulfillmentMode?||||

tableId?string

sectionId?string

serviceAreaId?string

tableLabel?string

seatCount?integer

note?string

source?|||

serviceTimestamp?string

Formatdate-time

lineItems?array<|>

appliedDiscounts?array<>

discountTotal?integer

Range0 <= value

tipTotal?integer

Range0 <= value

offPremise?

fundraising?

Response Body

`application/json`

curl -X PUT "https://example.com/orders/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "customerName": "string",  "guestName": "string",  "locationId": "string",  "assignedStaffUserId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "fundraising": {    "campaignId": "string",    "campaignCode": "string",    "campaignName": "string",    "causeName": "string",    "contributionType": "round_up",    "contributionValue": 0,    "contributionAmountCents": 0  },  "lineItems": [    {      "id": "string",      "lineType": "catalog",      "sendStatus": "new",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "taxCode": "food",      "category": "string",      "salesCategory": "string",      "openItemScope": "food",      "pricingStrategyApplied": "base",      "menuId": "string",      "sizeName": "string",      "seatId": "string",      "seatNumber": 1,      "course": "string",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "prepTimeSeconds": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0,          "quantity": 1,          "groupId": "string",          "groupTitle": "string",          "portionId": "string",          "portionLabel": "string",          "portionPriceMultiplier": 0,          "pricingStrategy": "no_charge",          "openPriceAmount": 0,          "sizeName": "string",          "sequenceOrdinal": 1,          "preModifierOptionId": "string",          "preModifierLabel": "string",          "preModifierPosition": "prefix",          "displayLabel": "string",          "defaultApplied": true,          "modifiers": [            null          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          }        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "immediatePrepStationIds": [          "string"        ],        "modifierRouting": "with_parent",        "ticketDestination": "prep_only",        "appliedRuleIds": [          "string"        ]      },      "voidReasonId": "string",      "voidReasonName": "string",      "voidedAt": "string",      "voidedByStaffUserId": "string",      "voidedByStaffName": "string",      "giftCardSale": {        "cardType": "Physical",        "code": "string",        "recipientName": "string",        "recipientEmail": "string",        "recipientPhone": "string",        "fromName": "string",        "purchaserEmail": "string",        "purchaserPhone": "string",        "giftMessage": "string",        "notes": "string",        "deliveryChannel": "email",        "deliveryDestination": "string",        "deliveryScheduledAt": "2019-08-24T14:15:22Z",        "notifyPurchaserWhenOpened": true      }    }  ],  "appliedDiscounts": [    {      "id": "string",      "sourceType": "promotion",      "sourceId": "string",      "code": "string",      "title": "string",      "scope": "order",      "lineItemId": "string",      "actionMessage": "string",      "appliesTo": "Store",      "appliesToObjectIds": [        "string"      ],      "combinability": "combinable",      "stackingScope": "order",      "requiresManagerApproval": true,      "managerApprovedByStaffUserId": "string",      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "eligibilitySummary": "string",      "discountType": "amount",      "value": 0,      "amount": 0    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "offPremise": {    "channel": {      "kind": "first_party",      "provider": "string"    },    "customer": {      "customerId": "string",      "firstName": "string",      "lastName": "string",      "phone": "string",      "email": "user@example.com"    },    "quote": {      "strategy": "manual",      "quoteTimeApplies": true,      "quotedAt": "2019-08-24T14:15:22Z",      "scheduledFor": "2019-08-24T14:15:22Z",      "promisedFulfillmentAt": "2019-08-24T14:15:22Z",      "takeoutQuoteMinutes": 0,      "deliveryQuoteMinutes": 0,      "takeoutThrottlingMinutes": 0,      "deliveryThrottlingMinutes": 0,      "throttlingAppliedMinutes": 0,      "leadTimeHours": 0,      "minimumLeadTimeSatisfied": true,      "withinConfiguredOrderingHours": true,      "quoteExemptionReason": "third_party_channel"    },    "readyAt": "2019-08-24T14:15:22Z",    "staging": {      "state": "pending",      "batchId": "string",      "batchLabel": "string",      "stagingArea": "string",      "stagingSlot": "string",      "handoffZone": "string",      "batchReadyAt": "2019-08-24T14:15:22Z",      "stagedAt": "2019-08-24T14:15:22Z",      "readyBy": {        "staffUserId": "string",        "displayName": "string"      }    },    "guestMessaging": {      "enabled": true,      "preferredChannel": "sms",      "notifications": [        {          "event": "batch_ready",          "template": "order_ready",          "channel": "sms",          "status": "pending",          "recipient": "string",          "subject": "string",          "body": "string",          "updatedAt": "2019-08-24T14:15:22Z",          "sentAt": "2019-08-24T14:15:22Z",          "failureReason": "string"        }      ],      "lastUpdatedAt": "2019-08-24T14:15:22Z"    },    "pickup": {      "kind": "standard",      "state": "pending",      "stagedAt": "2019-08-24T14:15:22Z",      "arrivedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "curbside": {        "vehicleMakeModel": "string",        "vehicleColor": "string",        "instructions": "string",        "parkingSpot": "string",        "arrivalNote": "string"      }    },    "delivery": {      "addressId": "string",      "addressLabel": "string",      "state": "pending",      "instructions": "string",      "deliveryNotes": "string",      "stagedAt": "2019-08-24T14:15:22Z",      "dispatchedAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "dispatchNote": "string",      "dispatch": {        "assignmentMode": "unassigned",        "assignedDriver": {          "staffUserId": "string",          "displayName": "string"        },        "dispatchedBy": {          "staffUserId": "string",          "displayName": "string"        },        "courierName": "string",        "courierPhone": "string",        "vehicleLabel": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Advance an off-premise pickup or delivery workflow state

Path Parameters

id*string

Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

state*|||||

effectiveAt?string

Formatdate-time

note?string

parkingSpot?string

batchId?string

batchLabel?string

stagingArea?string

stagingSlot?string

handoffZone?string

assignmentMode?||

assignedStaffUserId?string

courierName?string

courierPhone?string

vehicleLabel?string

guestMessage?

Response Body

`application/json`

curl -X POST "https://example.com/orders/string/off-premise/state" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "state": "batch_ready"  }'

{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "customerName": "string",  "guestName": "string",  "locationId": "string",  "assignedStaffUserId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "fundraising": {    "campaignId": "string",    "campaignCode": "string",    "campaignName": "string",    "causeName": "string",    "contributionType": "round_up",    "contributionValue": 0,    "contributionAmountCents": 0  },  "lineItems": [    {      "id": "string",      "lineType": "catalog",      "sendStatus": "new",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "taxCode": "food",      "category": "string",      "salesCategory": "string",      "openItemScope": "food",      "pricingStrategyApplied": "base",      "menuId": "string",      "sizeName": "string",      "seatId": "string",      "seatNumber": 1,      "course": "string",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "prepTimeSeconds": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0,          "quantity": 1,          "groupId": "string",          "groupTitle": "string",          "portionId": "string",          "portionLabel": "string",          "portionPriceMultiplier": 0,          "pricingStrategy": "no_charge",          "openPriceAmount": 0,          "sizeName": "string",          "sequenceOrdinal": 1,          "preModifierOptionId": "string",          "preModifierLabel": "string",          "preModifierPosition": "prefix",          "displayLabel": "string",          "defaultApplied": true,          "modifiers": [            null          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          }        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "immediatePrepStationIds": [          "string"        ],        "modifierRouting": "with_parent",        "ticketDestination": "prep_only",        "appliedRuleIds": [          "string"        ]      },      "voidReasonId": "string",      "voidReasonName": "string",      "voidedAt": "string",      "voidedByStaffUserId": "string",      "voidedByStaffName": "string",      "giftCardSale": {        "cardType": "Physical",        "code": "string",        "recipientName": "string",        "recipientEmail": "string",        "recipientPhone": "string",        "fromName": "string",        "purchaserEmail": "string",        "purchaserPhone": "string",        "giftMessage": "string",        "notes": "string",        "deliveryChannel": "email",        "deliveryDestination": "string",        "deliveryScheduledAt": "2019-08-24T14:15:22Z",        "notifyPurchaserWhenOpened": true      }    }  ],  "appliedDiscounts": [    {      "id": "string",      "sourceType": "promotion",      "sourceId": "string",      "code": "string",      "title": "string",      "scope": "order",      "lineItemId": "string",      "actionMessage": "string",      "appliesTo": "Store",      "appliesToObjectIds": [        "string"      ],      "combinability": "combinable",      "stackingScope": "order",      "requiresManagerApproval": true,      "managerApprovedByStaffUserId": "string",      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "eligibilitySummary": "string",      "discountType": "amount",      "value": 0,      "amount": 0    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "offPremise": {    "channel": {      "kind": "first_party",      "provider": "string"    },    "customer": {      "customerId": "string",      "firstName": "string",      "lastName": "string",      "phone": "string",      "email": "user@example.com"    },    "quote": {      "strategy": "manual",      "quoteTimeApplies": true,      "quotedAt": "2019-08-24T14:15:22Z",      "scheduledFor": "2019-08-24T14:15:22Z",      "promisedFulfillmentAt": "2019-08-24T14:15:22Z",      "takeoutQuoteMinutes": 0,      "deliveryQuoteMinutes": 0,      "takeoutThrottlingMinutes": 0,      "deliveryThrottlingMinutes": 0,      "throttlingAppliedMinutes": 0,      "leadTimeHours": 0,      "minimumLeadTimeSatisfied": true,      "withinConfiguredOrderingHours": true,      "quoteExemptionReason": "third_party_channel"    },    "readyAt": "2019-08-24T14:15:22Z",    "staging": {      "state": "pending",      "batchId": "string",      "batchLabel": "string",      "stagingArea": "string",      "stagingSlot": "string",      "handoffZone": "string",      "batchReadyAt": "2019-08-24T14:15:22Z",      "stagedAt": "2019-08-24T14:15:22Z",      "readyBy": {        "staffUserId": "string",        "displayName": "string"      }    },    "guestMessaging": {      "enabled": true,      "preferredChannel": "sms",      "notifications": [        {          "event": "batch_ready",          "template": "order_ready",          "channel": "sms",          "status": "pending",          "recipient": "string",          "subject": "string",          "body": "string",          "updatedAt": "2019-08-24T14:15:22Z",          "sentAt": "2019-08-24T14:15:22Z",          "failureReason": "string"        }      ],      "lastUpdatedAt": "2019-08-24T14:15:22Z"    },    "pickup": {      "kind": "standard",      "state": "pending",      "stagedAt": "2019-08-24T14:15:22Z",      "arrivedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "curbside": {        "vehicleMakeModel": "string",        "vehicleColor": "string",        "instructions": "string",        "parkingSpot": "string",        "arrivalNote": "string"      }    },    "delivery": {      "addressId": "string",      "addressLabel": "string",      "state": "pending",      "instructions": "string",      "deliveryNotes": "string",      "stagedAt": "2019-08-24T14:15:22Z",      "dispatchedAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "dispatchNote": "string",      "dispatch": {        "assignmentMode": "unassigned",        "assignedDriver": {          "staffUserId": "string",          "displayName": "string"        },        "dispatchedBy": {          "staffUserId": "string",          "displayName": "string"        },        "courierName": "string",        "courierPhone": "string",        "vehicleLabel": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Retrieve customer receipt template settings

Query Parameters

locationId?string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

`application/json`

curl -X GET "https://example.com/orders/receipt-template" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

{  "id": "string",  "locationId": "string",  "templateNumber": "string",  "headerLines": [    "string"  ],  "footerLines": [    "string"  ],  "logoUrl": "string",  "showLargeOrderNumberInHeader": true,  "orderNumberDisplay": "show",  "showTabName": true,  "guestCountDisplay": "show",  "printGuestDetailsTakeout": "full",  "printGuestDetailsDelivery": "full",  "showFreeModifiersOnDineIn": true,  "showFreeItemsOnDineIn": true,  "itemModifiersDisplay": "always",  "itemModifiersLayout": "inline",  "showSpecialRequestsOnDineIn": true,  "serviceChargeFont": "normal",  "displayDiscountsAboveSubtotal": true,  "printPayments": true,  "itemizeQuickOrderReceipts": true,  "itemizeTableServiceReceipts": true,  "displayTipLine": true,  "gratuityTipLineText": "tip",  "combineItems": true,  "roomChargePrompt": "none",  "printPromoArea": true,  "displayTipPercentages": true,  "displayCharityTipLine": true,  "closedCheckReceiptMode": "automatic",  "creditCardReceiptCopies": "merchant_and_customer",  "houseAccountDisplay": "number",  "displayItemQuantity": "always",  "printBarcode": true,  "separatorStyle": "line",  "showOrderTimestamps": true,  "showLineItemDetails": true,  "showCourseOnReceipt": true,  "showSeatNumbersOnReceipt": true,  "showGuestOnReceipt": true,  "showItemCountFooter": true,  "widthChars": 20,  "updatedAt": "2019-08-24T14:15:22Z"}

Update customer receipt template settings

Query Parameters

locationId?string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

locationId?string

templateNumber?string

headerLines?array<string>

footerLines?array<string>

logoUrl?string|null

showLargeOrderNumberInHeader?boolean

orderNumberDisplay?|

showTabName?boolean

guestCountDisplay?|

printGuestDetailsTakeout?||

printGuestDetailsDelivery?||

showFreeModifiersOnDineIn?boolean

showFreeItemsOnDineIn?boolean

itemModifiersDisplay?|

itemModifiersLayout?|

showSpecialRequestsOnDineIn?boolean

serviceChargeFont?|

displayDiscountsAboveSubtotal?boolean

printPayments?boolean

itemizeQuickOrderReceipts?boolean

itemizeTableServiceReceipts?boolean

displayTipLine?boolean

gratuityTipLineText?|

combineItems?boolean

roomChargePrompt?|||

printPromoArea?boolean

displayTipPercentages?boolean

displayCharityTipLine?boolean

closedCheckReceiptMode?|

creditCardReceiptCopies?|

houseAccountDisplay?|

displayItemQuantity?|

printBarcode?boolean

separatorStyle?||

showOrderTimestamps?boolean

showLineItemDetails?boolean

showCourseOnReceipt?boolean

showSeatNumbersOnReceipt?boolean

showGuestOnReceipt?boolean

showItemCountFooter?boolean

widthChars?integer

Range20 <= value <= 80

Response Body

`application/json`

curl -X PUT "https://example.com/orders/receipt-template" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "locationId": "string",  "templateNumber": "string",  "headerLines": [    "string"  ],  "footerLines": [    "string"  ],  "logoUrl": "string",  "showLargeOrderNumberInHeader": true,  "orderNumberDisplay": "show",  "showTabName": true,  "guestCountDisplay": "show",  "printGuestDetailsTakeout": "full",  "printGuestDetailsDelivery": "full",  "showFreeModifiersOnDineIn": true,  "showFreeItemsOnDineIn": true,  "itemModifiersDisplay": "always",  "itemModifiersLayout": "inline",  "showSpecialRequestsOnDineIn": true,  "serviceChargeFont": "normal",  "displayDiscountsAboveSubtotal": true,  "printPayments": true,  "itemizeQuickOrderReceipts": true,  "itemizeTableServiceReceipts": true,  "displayTipLine": true,  "gratuityTipLineText": "tip",  "combineItems": true,  "roomChargePrompt": "none",  "printPromoArea": true,  "displayTipPercentages": true,  "displayCharityTipLine": true,  "closedCheckReceiptMode": "automatic",  "creditCardReceiptCopies": "merchant_and_customer",  "houseAccountDisplay": "number",  "displayItemQuantity": "always",  "printBarcode": true,  "separatorStyle": "line",  "showOrderTimestamps": true,  "showLineItemDetails": true,  "showCourseOnReceipt": true,  "showSeatNumbersOnReceipt": true,  "showGuestOnReceipt": true,  "showItemCountFooter": true,  "widthChars": 20,  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve POS modifier tool settings

Query Parameters

locationId?string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

`application/json`

curl -X GET "https://example.com/orders/modifier-tools" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

{  "id": "string",  "locationId": "string",  "courseOptions": [    {      "id": "string",      "title": "string",      "priceDelta": 0    }  ],  "seatOptions": [    {      "id": "string",      "title": "string",      "priceDelta": 0    }  ],  "specialRequestTemplates": [    {      "id": "string",      "title": "string",      "priceDelta": 0    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update POS modifier tool settings

Query Parameters

locationId?string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

locationId?string

courseOptions?array<>

seatOptions?array<>

specialRequestTemplates?array<>

Response Body

`application/json`

curl -X PUT "https://example.com/orders/modifier-tools" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "locationId": "string",  "courseOptions": [    {      "id": "string",      "title": "string",      "priceDelta": 0    }  ],  "seatOptions": [    {      "id": "string",      "title": "string",      "priceDelta": 0    }  ],  "specialRequestTemplates": [    {      "id": "string",      "title": "string",      "priceDelta": 0    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Render a printable customer receipt for an order

Path Parameters

id*string

Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

`application/json`

curl -X GET "https://example.com/orders/string/receipt" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

{  "orderId": "string",  "locationId": "string",  "template": {    "id": "string",    "locationId": "string",    "templateNumber": "string",    "headerLines": [      "string"    ],    "footerLines": [      "string"    ],    "logoUrl": "string",    "showLargeOrderNumberInHeader": true,    "orderNumberDisplay": "show",    "showTabName": true,    "guestCountDisplay": "show",    "printGuestDetailsTakeout": "full",    "printGuestDetailsDelivery": "full",    "showFreeModifiersOnDineIn": true,    "showFreeItemsOnDineIn": true,    "itemModifiersDisplay": "always",    "itemModifiersLayout": "inline",    "showSpecialRequestsOnDineIn": true,    "serviceChargeFont": "normal",    "displayDiscountsAboveSubtotal": true,    "printPayments": true,    "itemizeQuickOrderReceipts": true,    "itemizeTableServiceReceipts": true,    "displayTipLine": true,    "gratuityTipLineText": "tip",    "combineItems": true,    "roomChargePrompt": "none",    "printPromoArea": true,    "displayTipPercentages": true,    "displayCharityTipLine": true,    "closedCheckReceiptMode": "automatic",    "creditCardReceiptCopies": "merchant_and_customer",    "houseAccountDisplay": "number",    "displayItemQuantity": "always",    "printBarcode": true,    "separatorStyle": "line",    "showOrderTimestamps": true,    "showLineItemDetails": true,    "showCourseOnReceipt": true,    "showSeatNumbersOnReceipt": true,    "showGuestOnReceipt": true,    "showItemCountFooter": true,    "widthChars": 20,    "updatedAt": "2019-08-24T14:15:22Z"  },  "lines": [    {      "text": "string",      "align": "left",      "emphasis": "normal",      "role": "string"    }  ],  "plainText": "string"}

Submit an order for payment and fulfillment

Path Parameters

id*string

Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tipTotal?integer

Range0 <= value

note?string

assignedStaffUserId?string

Response Body

`application/json`

curl -X POST "https://example.com/orders/string/submit" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "customerName": "string",  "guestName": "string",  "locationId": "string",  "assignedStaffUserId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "fundraising": {    "campaignId": "string",    "campaignCode": "string",    "campaignName": "string",    "causeName": "string",    "contributionType": "round_up",    "contributionValue": 0,    "contributionAmountCents": 0  },  "lineItems": [    {      "id": "string",      "lineType": "catalog",      "sendStatus": "new",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "taxCode": "food",      "category": "string",      "salesCategory": "string",      "openItemScope": "food",      "pricingStrategyApplied": "base",      "menuId": "string",      "sizeName": "string",      "seatId": "string",      "seatNumber": 1,      "course": "string",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "prepTimeSeconds": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0,          "quantity": 1,          "groupId": "string",          "groupTitle": "string",          "portionId": "string",          "portionLabel": "string",          "portionPriceMultiplier": 0,          "pricingStrategy": "no_charge",          "openPriceAmount": 0,          "sizeName": "string",          "sequenceOrdinal": 1,          "preModifierOptionId": "string",          "preModifierLabel": "string",          "preModifierPosition": "prefix",          "displayLabel": "string",          "defaultApplied": true,          "modifiers": [            null          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          }        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "immediatePrepStationIds": [          "string"        ],        "modifierRouting": "with_parent",        "ticketDestination": "prep_only",        "appliedRuleIds": [          "string"        ]      },      "voidReasonId": "string",      "voidReasonName": "string",      "voidedAt": "string",      "voidedByStaffUserId": "string",      "voidedByStaffName": "string",      "giftCardSale": {        "cardType": "Physical",        "code": "string",        "recipientName": "string",        "recipientEmail": "string",        "recipientPhone": "string",        "fromName": "string",        "purchaserEmail": "string",        "purchaserPhone": "string",        "giftMessage": "string",        "notes": "string",        "deliveryChannel": "email",        "deliveryDestination": "string",        "deliveryScheduledAt": "2019-08-24T14:15:22Z",        "notifyPurchaserWhenOpened": true      }    }  ],  "appliedDiscounts": [    {      "id": "string",      "sourceType": "promotion",      "sourceId": "string",      "code": "string",      "title": "string",      "scope": "order",      "lineItemId": "string",      "actionMessage": "string",      "appliesTo": "Store",      "appliesToObjectIds": [        "string"      ],      "combinability": "combinable",      "stackingScope": "order",      "requiresManagerApproval": true,      "managerApprovedByStaffUserId": "string",      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "eligibilitySummary": "string",      "discountType": "amount",      "value": 0,      "amount": 0    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "offPremise": {    "channel": {      "kind": "first_party",      "provider": "string"    },    "customer": {      "customerId": "string",      "firstName": "string",      "lastName": "string",      "phone": "string",      "email": "user@example.com"    },    "quote": {      "strategy": "manual",      "quoteTimeApplies": true,      "quotedAt": "2019-08-24T14:15:22Z",      "scheduledFor": "2019-08-24T14:15:22Z",      "promisedFulfillmentAt": "2019-08-24T14:15:22Z",      "takeoutQuoteMinutes": 0,      "deliveryQuoteMinutes": 0,      "takeoutThrottlingMinutes": 0,      "deliveryThrottlingMinutes": 0,      "throttlingAppliedMinutes": 0,      "leadTimeHours": 0,      "minimumLeadTimeSatisfied": true,      "withinConfiguredOrderingHours": true,      "quoteExemptionReason": "third_party_channel"    },    "readyAt": "2019-08-24T14:15:22Z",    "staging": {      "state": "pending",      "batchId": "string",      "batchLabel": "string",      "stagingArea": "string",      "stagingSlot": "string",      "handoffZone": "string",      "batchReadyAt": "2019-08-24T14:15:22Z",      "stagedAt": "2019-08-24T14:15:22Z",      "readyBy": {        "staffUserId": "string",        "displayName": "string"      }    },    "guestMessaging": {      "enabled": true,      "preferredChannel": "sms",      "notifications": [        {          "event": "batch_ready",          "template": "order_ready",          "channel": "sms",          "status": "pending",          "recipient": "string",          "subject": "string",          "body": "string",          "updatedAt": "2019-08-24T14:15:22Z",          "sentAt": "2019-08-24T14:15:22Z",          "failureReason": "string"        }      ],      "lastUpdatedAt": "2019-08-24T14:15:22Z"    },    "pickup": {      "kind": "standard",      "state": "pending",      "stagedAt": "2019-08-24T14:15:22Z",      "arrivedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "curbside": {        "vehicleMakeModel": "string",        "vehicleColor": "string",        "instructions": "string",        "parkingSpot": "string",        "arrivalNote": "string"      }    },    "delivery": {      "addressId": "string",      "addressLabel": "string",      "state": "pending",      "instructions": "string",      "deliveryNotes": "string",      "stagedAt": "2019-08-24T14:15:22Z",      "dispatchedAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "dispatchNote": "string",      "dispatch": {        "assignmentMode": "unassigned",        "assignedDriver": {          "staffUserId": "string",          "displayName": "string"        },        "dispatchedBy": {          "staffUserId": "string",          "displayName": "string"        },        "courierName": "string",        "courierPhone": "string",        "vehicleLabel": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Void an order

Path Parameters

id*string

Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

`application/json`

curl -X POST "https://example.com/orders/string/void" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "customerName": "string",  "guestName": "string",  "locationId": "string",  "assignedStaffUserId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "fundraising": {    "campaignId": "string",    "campaignCode": "string",    "campaignName": "string",    "causeName": "string",    "contributionType": "round_up",    "contributionValue": 0,    "contributionAmountCents": 0  },  "lineItems": [    {      "id": "string",      "lineType": "catalog",      "sendStatus": "new",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "taxCode": "food",      "category": "string",      "salesCategory": "string",      "openItemScope": "food",      "pricingStrategyApplied": "base",      "menuId": "string",      "sizeName": "string",      "seatId": "string",      "seatNumber": 1,      "course": "string",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "prepTimeSeconds": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0,          "quantity": 1,          "groupId": "string",          "groupTitle": "string",          "portionId": "string",          "portionLabel": "string",          "portionPriceMultiplier": 0,          "pricingStrategy": "no_charge",          "openPriceAmount": 0,          "sizeName": "string",          "sequenceOrdinal": 1,          "preModifierOptionId": "string",          "preModifierLabel": "string",          "preModifierPosition": "prefix",          "displayLabel": "string",          "defaultApplied": true,          "modifiers": [            null          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          }        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "immediatePrepStationIds": [          "string"        ],        "modifierRouting": "with_parent",        "ticketDestination": "prep_only",        "appliedRuleIds": [          "string"        ]      },      "voidReasonId": "string",      "voidReasonName": "string",      "voidedAt": "string",      "voidedByStaffUserId": "string",      "voidedByStaffName": "string",      "giftCardSale": {        "cardType": "Physical",        "code": "string",        "recipientName": "string",        "recipientEmail": "string",        "recipientPhone": "string",        "fromName": "string",        "purchaserEmail": "string",        "purchaserPhone": "string",        "giftMessage": "string",        "notes": "string",        "deliveryChannel": "email",        "deliveryDestination": "string",        "deliveryScheduledAt": "2019-08-24T14:15:22Z",        "notifyPurchaserWhenOpened": true      }    }  ],  "appliedDiscounts": [    {      "id": "string",      "sourceType": "promotion",      "sourceId": "string",      "code": "string",      "title": "string",      "scope": "order",      "lineItemId": "string",      "actionMessage": "string",      "appliesTo": "Store",      "appliesToObjectIds": [        "string"      ],      "combinability": "combinable",      "stackingScope": "order",      "requiresManagerApproval": true,      "managerApprovedByStaffUserId": "string",      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "eligibilitySummary": "string",      "discountType": "amount",      "value": 0,      "amount": 0    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "offPremise": {    "channel": {      "kind": "first_party",      "provider": "string"    },    "customer": {      "customerId": "string",      "firstName": "string",      "lastName": "string",      "phone": "string",      "email": "user@example.com"    },    "quote": {      "strategy": "manual",      "quoteTimeApplies": true,      "quotedAt": "2019-08-24T14:15:22Z",      "scheduledFor": "2019-08-24T14:15:22Z",      "promisedFulfillmentAt": "2019-08-24T14:15:22Z",      "takeoutQuoteMinutes": 0,      "deliveryQuoteMinutes": 0,      "takeoutThrottlingMinutes": 0,      "deliveryThrottlingMinutes": 0,      "throttlingAppliedMinutes": 0,      "leadTimeHours": 0,      "minimumLeadTimeSatisfied": true,      "withinConfiguredOrderingHours": true,      "quoteExemptionReason": "third_party_channel"    },    "readyAt": "2019-08-24T14:15:22Z",    "staging": {      "state": "pending",      "batchId": "string",      "batchLabel": "string",      "stagingArea": "string",      "stagingSlot": "string",      "handoffZone": "string",      "batchReadyAt": "2019-08-24T14:15:22Z",      "stagedAt": "2019-08-24T14:15:22Z",      "readyBy": {        "staffUserId": "string",        "displayName": "string"      }    },    "guestMessaging": {      "enabled": true,      "preferredChannel": "sms",      "notifications": [        {          "event": "batch_ready",          "template": "order_ready",          "channel": "sms",          "status": "pending",          "recipient": "string",          "subject": "string",          "body": "string",          "updatedAt": "2019-08-24T14:15:22Z",          "sentAt": "2019-08-24T14:15:22Z",          "failureReason": "string"        }      ],      "lastUpdatedAt": "2019-08-24T14:15:22Z"    },    "pickup": {      "kind": "standard",      "state": "pending",      "stagedAt": "2019-08-24T14:15:22Z",      "arrivedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "curbside": {        "vehicleMakeModel": "string",        "vehicleColor": "string",        "instructions": "string",        "parkingSpot": "string",        "arrivalNote": "string"      }    },    "delivery": {      "addressId": "string",      "addressLabel": "string",      "state": "pending",      "instructions": "string",      "deliveryNotes": "string",      "stagedAt": "2019-08-24T14:15:22Z",      "dispatchedAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "dispatchNote": "string",      "dispatch": {        "assignmentMode": "unassigned",        "assignedDriver": {          "staffUserId": "string",          "displayName": "string"        },        "dispatchedBy": {          "staffUserId": "string",          "displayName": "string"        },        "courierName": "string",        "courierPhone": "string",        "vehicleLabel": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Create a secure public receipt link

Path Parameters

id*string

Length1 <= length <= 200

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

curl -X POST "https://example.com/orders/string/receipt-share" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

Empty

Email or text a secure public receipt link

Path Parameters

id*string

Length1 <= length <= 200

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

channel*|

recipient*string

Length3 <= length <= 320

Response Body

curl -X POST "https://example.com/orders/string/receipt-share/deliver" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "channel": "email",    "recipient": "string"  }'

Empty

Revoke a public receipt link

Path Parameters

id*string

Length1 <= length <= 200

publicId*string

Length8 <= length <= 80

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

curl -X DELETE "https://example.com/orders/string/receipt-shares/stringst" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

Empty

Read a secure public customer receipt

Path Parameters

publicId*string

Length8 <= length <= 80

secret*string

Length24 <= length <= 160

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

curl -X GET "https://example.com/public/receipts/stringst/stringstringstringstring" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"

Empty

Calculate Toast-compatible order prices without persisting an order

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[key: string]?unknown

Response Body

`application/json`

curl -X POST "https://example.com/orders/v2/prices" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string" \  -H "Content-Type: application/json" \  -d '{    "property1": null,    "property2": null  }'

null

Create an order using the Toast Orders API contract

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[key: string]?unknown

Response Body

`application/json`

curl -X POST "https://example.com/orders/v2/orders" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string" \  -H "Content-Type: application/json" \  -d '{    "property1": null,    "property2": null  }'

null

Get an order using the Toast Orders API contract

Path Parameters

guid*string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Response Body

`application/json`

curl -X GET "https://example.com/orders/v2/orders/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string"

null

Get multiple orders using Toast time-range and business-date filters

Query Parameters

startDate?string

endDate?string

businessDate?string

pageSize?integer

Range1 <= value <= 100

page?integer

Range1 <= value

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Response Body

`application/json`

curl -X GET "https://example.com/orders/v2/ordersBulk" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string"

[  null]

List canonical Toast-compatible payments by business date

Query Parameters

paidBusinessDate?string|number

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Response Body

`application/json`

curl -X GET "https://example.com/orders/v2/payments" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string"

[  null]

Get a canonical Toast-compatible payment

Path Parameters

paymentGuid*string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Response Body

`application/json`

curl -X GET "https://example.com/orders/v2/payments/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string"

null

Add item selections to a Toast-compatible order

Path Parameters

orderGuid*string

checkGuid*string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[index: integer]?

Response Body

`application/json`

curl -X POST "https://example.com/orders/v2/orders/string/checks/string/selections" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string" \  -H "Content-Type: application/json" \  -d '[    {      "property1": null,      "property2": null    }  ]'

null

Add externally processed payments to a Toast-compatible check

Path Parameters

orderGuid*string

checkGuid*string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[index: integer]?

Response Body

`application/json`

curl -X POST "https://example.com/orders/v2/orders/string/checks/string/payments" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string" \  -H "Content-Type: application/json" \  -d '[    {      "property1": null,      "property2": null    }  ]'

null

Update the tip on a Toast-compatible payment

Path Parameters

orderGuid*string

checkGuid*string

paymentGuid*string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tipAmount*number

Range0 <= value

Response Body

`application/json`

curl -X PATCH "https://example.com/orders/v2/orders/string/checks/string/payments/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string" \  -H "Content-Type: application/json" \  -d '{    "tipAmount": 0  }'

null

Return discounts applicable to a proposed Toast order

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[key: string]?unknown

Response Body

`application/json`

curl -X POST "https://example.com/orders/v2/applicableDiscounts" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string" \  -H "Content-Type: application/json" \  -d '{    "property1": null,    "property2": null  }'

[  null]

Apply discounts to a Toast-compatible check

Path Parameters

orderGuid*string

checkGuid*string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[index: integer]?

Response Body

`application/json`

curl -X POST "https://example.com/orders/v2/orders/string/checks/string/appliedDiscounts" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string" \  -H "Content-Type: application/json" \  -d '[    {      "property1": null,      "property2": null    }  ]'

null

Path Parameters

orderGuid*string

checkGuid*string

selectionGuid*string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[index: integer]?

Response Body

`application/json`

curl -X POST "https://example.com/orders/v2/orders/string/checks/string/selections/string/appliedDiscounts" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string" \  -H "Content-Type: application/json" \  -d '[    {      "property1": null,      "property2": null    }  ]'

null

Void a Toast-compatible order

Path Parameters

orderGuid*string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[key: string]?unknown

Response Body

`application/json`

curl -X POST "https://example.com/orders/v2/orders/string/void" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string" \  -H "Content-Type: application/json" \  -d '{    "property1": null,    "property2": null  }'

null

Get canonical online ordering hours using the Toast configuration contract

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

"hexclave"

x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

toast-restaurant-external-id*string

Response Body

`application/json`

curl -X GET "https://example.com/ordermgmt-config/v1/published/orderingSchedule" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "toast-restaurant-external-id: string"

null

200application/json

200application/json

204

200application/json

201application/json

200application/json

200application/json

200application/json

200application/json

201application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200

200

200

200

200application/json

200application/json

200application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`