Shipping

List shipping configurations

Commerce7-style shipping configurations with regions, services, rates, and top-rate rules.

Query Parameters

q?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/shipping" \  -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"

{  "shippings": [    {      "id": "string",      "title": "string",      "regions": [        {          "id": "string",          "countryCode": "st",          "stateCode": "string"        }      ],      "services": [        {          "id": "string",          "title": "string",          "code": "string",          "carrier": "string",          "isActive": true,          "isDefault": true,          "sortOrder": 0,          "rates": [            {              "id": "string",              "toWeight": 0,              "price": 0,              "weightUnits": "Lbs"            }          ],          "topRate": {            "id": "string",            "isWrapShipping": true,            "forEveryXWeight": 0,            "weightUnits": "Lbs",            "price": 0          }        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Create a shipping configuration

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.

title*string

Length1 <= length

regions*array<>

services*array<>

Response Body

`application/json`

curl -X POST "https://example.com/shipping" \  -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 '{    "title": "string",    "regions": [      {        "countryCode": "st"      }    ],    "services": [      {        "title": "string",        "code": "string",        "rates": [          {            "toWeight": 0,            "price": 0          }        ],        "topRate": {          "isWrapShipping": true        }      }    ]  }'

{  "id": "string",  "title": "string",  "regions": [    {      "id": "string",      "countryCode": "st",      "stateCode": "string"    }  ],  "services": [    {      "id": "string",      "title": "string",      "code": "string",      "carrier": "string",      "isActive": true,      "isDefault": true,      "sortOrder": 0,      "rates": [        {          "id": "string",          "toWeight": 0,          "price": 0,          "weightUnits": "Lbs"        }      ],      "topRate": {        "id": "string",        "isWrapShipping": true,        "forEveryXWeight": 0,        "weightUnits": "Lbs",        "price": 0      }    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve off-premise ordering settings for a location

Toast-inspired takeout, delivery, quote-time, online-ordering-hours, and third-party channel controls layered into the existing shipping namespace.

Query Parameters

locationId*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/shipping/off-premise/settings?locationId=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",  "locationId": "string",  "quoteTimeStrategy": "manual",  "takeoutQuoteMinutes": 0,  "deliveryQuoteMinutes": 0,  "takeoutThrottlingMinutes": 0,  "deliveryThrottlingMinutes": 0,  "firstPartyDeliveryEnabled": true,  "leadTimeHours": 0,  "allowScheduledOrders": true,  "batchReadyEnabled": true,  "guestMessagingEnabled": true,  "dispatchAssignmentMode": "manual",  "onlineOrderingHours": {    "takeoutThirdParty": [      {        "day": "mon",        "startTime": "string",        "endTime": "string"      }    ],    "firstPartyDelivery": [      {        "day": "mon",        "startTime": "string",        "endTime": "string"      }    ]  },  "thirdPartyChannels": [    {      "id": "string",      "title": "string",      "provider": "string",      "status": "ordering_on",      "snoozeUntil": "2019-08-24T14:15:22Z",      "enabledFulfillmentModes": [        "takeout"      ],      "acceptsScheduledOrders": true,      "autoAcceptOrders": true,      "throttlingMinutes": 0,      "fulfillmentControls": [        {          "fulfillmentMode": "takeout",          "status": "ordering_on",          "snoozeUntil": "2019-08-24T14:15:22Z"        }      ],      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update off-premise ordering settings for a location

Query Parameters

locationId*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.

quoteTimeStrategy?|||

takeoutQuoteMinutes?integer

Range0 <= value

deliveryQuoteMinutes?integer

Range0 <= value

takeoutThrottlingMinutes?integer

Range0 <= value

deliveryThrottlingMinutes?integer

Range0 <= value

firstPartyDeliveryEnabled?boolean

leadTimeHours?integer

Range0 <= value

allowScheduledOrders?boolean

batchReadyEnabled?boolean

guestMessagingEnabled?boolean

dispatchAssignmentMode?||

onlineOrderingHours?

thirdPartyChannels?array<>

Response Body

`application/json`

curl -X PUT "https://example.com/shipping/off-premise/settings?locationId=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",  "locationId": "string",  "quoteTimeStrategy": "manual",  "takeoutQuoteMinutes": 0,  "deliveryQuoteMinutes": 0,  "takeoutThrottlingMinutes": 0,  "deliveryThrottlingMinutes": 0,  "firstPartyDeliveryEnabled": true,  "leadTimeHours": 0,  "allowScheduledOrders": true,  "batchReadyEnabled": true,  "guestMessagingEnabled": true,  "dispatchAssignmentMode": "manual",  "onlineOrderingHours": {    "takeoutThirdParty": [      {        "day": "mon",        "startTime": "string",        "endTime": "string"      }    ],    "firstPartyDelivery": [      {        "day": "mon",        "startTime": "string",        "endTime": "string"      }    ]  },  "thirdPartyChannels": [    {      "id": "string",      "title": "string",      "provider": "string",      "status": "ordering_on",      "snoozeUntil": "2019-08-24T14:15:22Z",      "enabledFulfillmentModes": [        "takeout"      ],      "acceptsScheduledOrders": true,      "autoAcceptOrders": true,      "throttlingMinutes": 0,      "fulfillmentControls": [        {          "fulfillmentMode": "takeout",          "status": "ordering_on",          "snoozeUntil": "2019-08-24T14:15:22Z"        }      ],      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Turn on, turn off, or snooze a third-party ordering channel

Path Parameters

channelId*string

Length1 <= length

Query Parameters

locationId*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.

action*||||

fulfillmentMode?||

Response Body

`application/json`

curl -X POST "https://example.com/shipping/off-premise/channels/string/control?locationId=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 '{    "action": "ordering_on"  }'

{  "id": "string",  "locationId": "string",  "quoteTimeStrategy": "manual",  "takeoutQuoteMinutes": 0,  "deliveryQuoteMinutes": 0,  "takeoutThrottlingMinutes": 0,  "deliveryThrottlingMinutes": 0,  "firstPartyDeliveryEnabled": true,  "leadTimeHours": 0,  "allowScheduledOrders": true,  "batchReadyEnabled": true,  "guestMessagingEnabled": true,  "dispatchAssignmentMode": "manual",  "onlineOrderingHours": {    "takeoutThirdParty": [      {        "day": "mon",        "startTime": "string",        "endTime": "string"      }    ],    "firstPartyDelivery": [      {        "day": "mon",        "startTime": "string",        "endTime": "string"      }    ]  },  "thirdPartyChannels": [    {      "id": "string",      "title": "string",      "provider": "string",      "status": "ordering_on",      "snoozeUntil": "2019-08-24T14:15:22Z",      "enabledFulfillmentModes": [        "takeout"      ],      "acceptsScheduledOrders": true,      "autoAcceptOrders": true,      "throttlingMinutes": 0,      "fulfillmentControls": [        {          "fulfillmentMode": "takeout",          "status": "ordering_on",          "snoozeUntil": "2019-08-24T14:15:22Z"        }      ],      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve a shipping configuration

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/shipping/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",  "title": "string",  "regions": [    {      "id": "string",      "countryCode": "st",      "stateCode": "string"    }  ],  "services": [    {      "id": "string",      "title": "string",      "code": "string",      "carrier": "string",      "isActive": true,      "isDefault": true,      "sortOrder": 0,      "rates": [        {          "id": "string",          "toWeight": 0,          "price": 0,          "weightUnits": "Lbs"        }      ],      "topRate": {        "id": "string",        "isWrapShipping": true,        "forEveryXWeight": 0,        "weightUnits": "Lbs",        "price": 0      }    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a shipping configuration

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

curl -X DELETE "https://example.com/shipping/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"

Empty

Update a shipping configuration

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.

title?string

Length1 <= length

regions?array<>

services?array<>

Response Body

`application/json`

curl -X PUT "https://example.com/shipping/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",  "title": "string",  "regions": [    {      "id": "string",      "countryCode": "st",      "stateCode": "string"    }  ],  "services": [    {      "id": "string",      "title": "string",      "code": "string",      "carrier": "string",      "isActive": true,      "isDefault": true,      "sortOrder": 0,      "rates": [        {          "id": "string",          "toWeight": 0,          "price": 0,          "weightUnits": "Lbs"        }      ],      "topRate": {        "id": "string",        "isWrapShipping": true,        "forEveryXWeight": 0,        "weightUnits": "Lbs",        "price": 0      }    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get takeout packaging, order-ready, messaging, and price-rule configuration

Query Parameters

locationId*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/takeout-operations/config?locationId=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",  "locationId": "string",  "acceptOrdersUntil": "closing_time_minus_prep",  "packaging": {    "singleUseItems": "always",    "includeNapkins": true,    "includeCondiments": true,    "guestPrompt": "string",    "kitchenNote": "string"  },  "orderReadyBoard": {    "enabled": true,    "title": "string",    "subtitle": "string",    "guestIdentifier": "first_name",    "readyDurationMinutes": 1,    "theme": "light",    "pickupInstructions": "string"  },  "guestMessaging": {    "enabled": true,    "sendOnReady": true,    "sendOnCompleted": true,    "smsTemplate": "string",    "emailSubject": "string",    "emailTemplate": "string"  },  "orderPriceRules": [    {      "id": "string",      "minimumSubtotalCents": 0,      "additionalMinutes": 0,      "active": true    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update takeout packaging, order-ready, messaging, and price-rule configuration

Query Parameters

locationId*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.

acceptOrdersUntil?|

packaging?

orderReadyBoard?

guestMessaging?

orderPriceRules?array<>

Response Body

`application/json`

curl -X PUT "https://example.com/takeout-operations/config?locationId=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",  "locationId": "string",  "acceptOrdersUntil": "closing_time_minus_prep",  "packaging": {    "singleUseItems": "always",    "includeNapkins": true,    "includeCondiments": true,    "guestPrompt": "string",    "kitchenNote": "string"  },  "orderReadyBoard": {    "enabled": true,    "title": "string",    "subtitle": "string",    "guestIdentifier": "first_name",    "readyDurationMinutes": 1,    "theme": "light",    "pickupInstructions": "string"  },  "guestMessaging": {    "enabled": true,    "sendOnReady": true,    "sendOnCompleted": true,    "smsTemplate": "string",    "emailSubject": "string",    "emailTemplate": "string"  },  "orderPriceRules": [    {      "id": "string",      "minimumSubtotalCents": 0,      "additionalMinutes": 0,      "active": true    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List date-specific takeout and delivery overrides

Query Parameters

locationId*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/takeout-operations/overrides?locationId=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",    "locationId": "string",    "name": "string",    "date": "string",    "fulfillmentModes": [      "takeout"    ],    "closed": true,    "startTime": "string",    "endTime": "string",    "reason": "string",    "version": 1,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create a date-specific fulfillment override

Query Parameters

locationId*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.

name*string

Length1 <= length <= 100

date*string

Match^\d{4}-\d{2}-\d{2}$

fulfillmentModes*array<||>

Items1 <= items

closed*boolean

startTime?|

Match^([01]\d|2[0-3]):[0-5]\d$

endTime?|

Match^([01]\d|2[0-3]):[0-5]\d$

reason?string

Lengthlength <= 240

Response Body

`application/json`

curl -X POST "https://example.com/takeout-operations/overrides?locationId=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 '{    "name": "string",    "date": "string",    "fulfillmentModes": [      "takeout"    ],    "closed": true  }'

{  "id": "string",  "locationId": "string",  "name": "string",  "date": "string",  "fulfillmentModes": [    "takeout"  ],  "closed": true,  "startTime": "string",  "endTime": "string",  "reason": "string",  "version": 1,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a date-specific fulfillment override

Path Parameters

id*string

Length1 <= length

Query Parameters

locationId*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

curl -X DELETE "https://example.com/takeout-operations/overrides/string?locationId=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"

Empty

Update a date-specific fulfillment override

Path Parameters

id*string

Length1 <= length

Query Parameters

locationId*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.

name?string

Length1 <= length <= 100

date?string

Match^\d{4}-\d{2}-\d{2}$

fulfillmentModes?array<||>

Items1 <= items

closed?boolean

startTime?|

Match^([01]\d|2[0-3]):[0-5]\d$

endTime?|

Match^([01]\d|2[0-3]):[0-5]\d$

reason?string

Lengthlength <= 240

version*integer

Range1 <= value

Response Body

`application/json`

curl -X PUT "https://example.com/takeout-operations/overrides/string?locationId=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 '{    "version": 1  }'

{  "id": "string",  "locationId": "string",  "name": "string",  "date": "string",  "fulfillmentModes": [    "takeout"  ],  "closed": true,  "startTime": "string",  "endTime": "string",  "reason": "string",  "version": 1,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List online-order fundraising campaigns

Query Parameters

locationId*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/takeout-operations/fundraising?locationId=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",    "locationId": "string",    "code": "string",    "name": "string",    "causeName": "string",    "description": "string",    "goalCents": 0,    "contributionType": "round_up",    "contributionValue": 0,    "status": "draft",    "startAt": "2019-08-24T14:15:22Z",    "endAt": "2019-08-24T14:15:22Z",    "totalContributionsCents": 0,    "contributionCount": 0,    "contributionSource": "paid_orders",    "version": 1,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create an online-order fundraising campaign

Query Parameters

locationId*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.

code*string

Match^[A-Za-z0-9][A-Za-z0-9_-]+$

Length3 <= length <= 32

name*string

Length1 <= length <= 120

causeName*string

Length1 <= length <= 120

description?string

Lengthlength <= 1000

goalCents?integer

Range0 <= value

contributionType*||

contributionValue?integer

Range0 <= value

status?||||

startAt?|

Formatdate-time

endAt?|

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/takeout-operations/fundraising?locationId=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 '{    "code": "string",    "name": "string",    "causeName": "string",    "contributionType": "round_up"  }'

{  "id": "string",  "locationId": "string",  "code": "string",  "name": "string",  "causeName": "string",  "description": "string",  "goalCents": 0,  "contributionType": "round_up",  "contributionValue": 0,  "status": "draft",  "startAt": "2019-08-24T14:15:22Z",  "endAt": "2019-08-24T14:15:22Z",  "totalContributionsCents": 0,  "contributionCount": 0,  "contributionSource": "paid_orders",  "version": 1,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update an online-order fundraising campaign

Path Parameters

id*string

Length1 <= length

Query Parameters

locationId*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.

code?string

Match^[A-Za-z0-9][A-Za-z0-9_-]+$

Length3 <= length <= 32

name?string

Length1 <= length <= 120

causeName?string

Length1 <= length <= 120

description?string

Lengthlength <= 1000

goalCents?integer

Range0 <= value

contributionType?||

contributionValue?integer

Range0 <= value

status?||||

startAt?|

Formatdate-time

endAt?|

Formatdate-time

version*integer

Range1 <= value

Response Body

`application/json`

curl -X PUT "https://example.com/takeout-operations/fundraising/string?locationId=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 '{    "version": 1  }'

{  "id": "string",  "locationId": "string",  "code": "string",  "name": "string",  "causeName": "string",  "description": "string",  "goalCents": 0,  "contributionType": "round_up",  "contributionValue": 0,  "status": "draft",  "startAt": "2019-08-24T14:15:22Z",  "endAt": "2019-08-24T14:15:22Z",  "totalContributionsCents": 0,  "contributionCount": 0,  "contributionSource": "paid_orders",  "version": 1,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

200application/json

201application/json

200application/json

200application/json

200application/json

200application/json

204

200application/json

200application/json

200application/json

200application/json

201application/json

204

200application/json

200application/json

201application/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`