Query and update store and product availability, snooze products by PLU or tag, set busy mode, and configure opening and holiday hours across locations and channels. Authenticates with OAuth 2.0 machine-to-machine access tokens scoped via store or genericPOS.
openapi: 3.1.0
info:
title: Deliverect Store API
description: Query and update store and product availability, snooze products by PLU or tag, set busy mode, and configure opening and holiday hours across locations and channels. Authenticates with OAuth
2.0 machine-to-machine access tokens scoped via store or genericPOS.
version: '1.0'
x-generated-from: documentation
x-source-url: https://developers.deliverect.com/reference
x-last-validated: '2026-06-02'
contact:
name: Kin Lane
email: [email protected]
license:
name: All Rights Reserved
servers:
- url: https://api.deliverect.com
description: Production
- url: https://api.staging.deliverect.com
description: Staging
tags:
- name: Locations
description: Locations operations for the Deliverect Store API.
- name: Products
description: Products operations for the Deliverect Store API.
- name: Store Status
description: Store Status operations for the Deliverect Store API.
- name: Opening Hours
description: Opening Hours operations for the Deliverect Store API.
- name: Tables
description: Tables operations for the Deliverect Store API.
- name: Allergens
description: Allergens operations for the Deliverect Store API.
paths:
/locations:
get:
tags:
- Locations
summary: Deliverect Locations
description: Per physical restaurant location, there will be a *Location*. This endpoint can be used to query them. You can have to specify an account, otherwise the locations of your own account
will be returned
parameters:
- name: where
in: query
schema:
type: string
example:
account: '{{accountId}}'
description: The where value.
responses:
'200':
description: OK
headers:
Server:
schema:
type: string
examples:
- nginx/1.14.1
Date:
schema:
type: string
examples:
- Thu, 14 Feb 2019 16:24:59 GMT
Content-Type:
schema:
type: string
examples:
- application/json
Content-Length:
schema:
type: integer
examples:
- '1270'
Connection:
schema:
type: string
examples:
- keep-alive
X-Total-Count:
schema:
type: integer
examples:
- '1'
Cache-Control:
schema:
type: string
examples:
- max-age=20
Expires:
schema:
type: string
examples:
- Thu, 14 Feb 2019 16:25:19 GMT
Last-Modified:
schema:
type: string
examples:
- Thu, 14 Feb 2019 13:57:59 GMT
Access-Control-Allow-Origin:
schema:
type: string
examples:
- '*'
Access-Control-Allow-Headers:
schema:
type: string
examples:
- User-Agent,Keep-Alive,Content-Type,Authorization
Access-Control-Allow-Methods:
schema:
type: string
examples:
- GET, POST, OPTIONS, DELETE, PUT, PATCH
Access-Control-Allow-Credentials:
schema:
type: boolean
examples:
- 'true'
content:
application/json:
schema:
type: object
examples:
? ''
: summary: ''
value:
_items:
- _id: 61********************a4
posSettings:
generic:
locationId: 29**10
setDefaultPriceLevelOnSync: false
anonymizeCustomer: false
sendStreetNumber: false
hasDirectTableIntegration: false
sendDiscount: true
sendDeliveryFee: true
sendServiceCharge: true
sendDeliveryFeeCondition: 0
forcePayment: 0
sendTip: true
sendRebate: true
sortModifiers: 0
bufferOrders: false
deliveryByChannelIsPickup: false
ignoreUnknownOrderStatuses: false
recalcPriceOverrides: false
dontSendCancel: false
readonly: false
logOps: true
orderItemRemarks: intactItemRemarks
alwaysSendAllSnoozedProducts: true
ordersWebhookURL: https://{{YourSetwebhookUrl}}/orders
registerUrl: https://{{YourSetwebhookUrl}}/orders/register
operationsWebhookURL: https://{{YourSetwebhookUrl}}/orders/operations
storeStatusURL: https://{{YourSetwebhookUrl}}/orders/storeStatus
syncProductsURL: https://{{YourSetwebhookUrl}}/syncProducts
syncTablesURL: https://{{YourSetwebhookUrl}}/syncTables
syncFloorsURL: https://{{YourSetwebhookUrl}}/syncFloors
syncBillsURL: https://{{YourSetwebhookUrl}}/syncBills
billPaymentURL: https://{{YourSetwebhookUrl}}/billPayments
name: La Famiglia
status: SUBSCRIBED
posSystemId: 10000
subscriptions:
- brandId: 61********************9e
address:
phoneNumber: '+445556665555'
houseNumber: '78'
street: Main St
postalCode: FX19ST
city: Pleasantville
stateOrProvince: TX
restaurantName: La Famiglia Restaurant
coordinates:
type: Point
coordinates:
- -20.34974509999999
- 11.0110892
country: FR
contact:
phoneNumber: '+445556665555'
timezone: Asia/Dubai
taxExcl: false
enableOutOfStock: false
enablePickupScreenQR: false
ignorePOSOrderStatuses: false
enableWorkstations: false
splitOrderItems: false
account: 61********************8d
region: Latin America
_updated: '2022-12-28T08:38:13.710000Z'
_created: '2022-11-17T05:43:05.000000Z'
_deleted: false
_etag: fc9144bc1b9ef7e67378d3e0c77279691c1bc3a8
channelLinks:
- 63********************45
- 63********************22
- 63********************12
- 63********************1e
- 63********************90
deliverySystemSettings:
generic:
externalReference: '123'
validateUrl: https://mock-dsp.staging.deliverect.com/api/jobs/validate
createUrl: https://mock-dsp.staging.deliverect.com/api/jobs/create
cancelUrl: https://mock-dsp.staging.deliverect.com/api/jobs/cancel
registerUrl: https://mock-dsp.staging.deliverect.com/api/register
active: false
openingHours:
- dayOfWeek: 1
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 2
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 3
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 4
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 5
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 6
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 7
startTime: 00:00
endTime: '23:59'
lastProductSync: '2022-12-28T21:05:27.668000Z'
_links:
self:
title: Locations
href: locations/63********************e4
related:
account:
title: accounts
href: accounts/63********************8d
channelLinks:
- title: channelLink
href: channelLinks/63********************45
- title: channelLink
href: channelLinks/63********************22
- title: channelLink
href: channelLinks/63********************12
- title: channelLink
href: channelLinks/63********************1e
- title: channelLink
href: channelLinks/63********************90
channelLinksDetails:
63********************22:
channel: DoorDash
channelId: 12
name: DoorDash
63********************12:
channel: Generic Channel
channelId: 10057
name: Custom Channnel
63********************1e:
channel: Uber Eats
channelId: 7
name: Uber Eats
63********************90:
channel: Deliverect
channelId: 1
name: Test channel
- _id: 63********************67
posSettings: '................'
_links:
parent:
title: home
href: /
self:
title: locations
href: locations?where={"account":"63********************8d"}
next:
title: next page
href: locations?where={"account":"63********************8d"}&page=2
last:
title: last page
href: locations?where={"account":"63********************8d"}&page=26
_meta:
page: 1
max_results: 25
total: 501
' ':
summary: ' '
value:
_items:
- _id: 61********************a4
posSettings:
generic:
locationId: 29**10
setDefaultPriceLevelOnSync: false
anonymizeCustomer: false
sendStreetNumber: false
hasDirectTableIntegration: false
sendDiscount: true
sendDeliveryFee: true
sendServiceCharge: true
sendDeliveryFeeCondition: 0
forcePayment: 0
sendTip: true
sendRebate: true
sortModifiers: 0
bufferOrders: false
deliveryByChannelIsPickup: false
ignoreUnknownOrderStatuses: false
recalcPriceOverrides: false
dontSendCancel: false
readonly: false
logOps: true
orderItemRemarks: intactItemRemarks
alwaysSendAllSnoozedProducts: true
ordersWebhookURL: https://{{YourSetwebhookUrl}}/orders
registerUrl: https://{{YourSetwebhookUrl}}/orders/register
operationsWebhookURL: https://{{YourSetwebhookUrl}}/orders/operations
storeStatusURL: https://{{YourSetwebhookUrl}}/orders/storeStatus
syncProductsURL: https://{{YourSetwebhookUrl}}/syncProducts
syncTablesURL: https://{{YourSetwebhookUrl}}/syncTables
syncFloorsURL: https://{{YourSetwebhookUrl}}/syncFloors
syncBillsURL: https://{{YourSetwebhookUrl}}/syncBills
billPaymentURL: https://{{YourSetwebhookUrl}}/billPayments
name: La Famiglia
status: SUBSCRIBED
posSystemId: 10000
subscriptions:
- brandId: 61********************9e
address:
phoneNumber: '+445556665555'
houseNumber: '78'
street: Main St
postalCode: FX19ST
city: Pleasantville
stateOrProvince: TX
restaurantName: La Famiglia Restaurant
coordinates:
type: Point
coordinates:
- -20.34974509999999
- 11.0110892
country: FR
contact:
phoneNumber: '+445556665555'
timezone: Asia/Dubai
taxExcl: false
enableOutOfStock: false
enablePickupScreenQR: false
ignorePOSOrderStatuses: false
enableWorkstations: false
splitOrderItems: false
account: 61********************8d
region: Latin America
_updated: '2022-12-28T08:38:13.710000Z'
_created: '2022-11-17T05:43:05.000000Z'
_deleted: false
_etag: fc9144bc1b9ef7e67378d3e0c77279691c1bc3a8
channelLinks:
- 63********************45
- 63********************22
- 63********************12
- 63********************1e
- 63********************90
deliverySystemSettings:
generic:
externalReference: '123'
validateUrl: https://mock-dsp.staging.deliverect.com/api/jobs/validate
createUrl: https://mock-dsp.staging.deliverect.com/api/jobs/create
cancelUrl: https://mock-dsp.staging.deliverect.com/api/jobs/cancel
registerUrl: https://mock-dsp.staging.deliverect.com/api/register
active: false
openingHours:
- dayOfWeek: 1
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 2
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 3
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 4
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 5
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 6
startTime: 00:00
endTime: '23:59'
- dayOfWeek: 7
startTime: 00:00
endTime: '23:59'
lastProductSync: '2022-12-28T21:05:27.668000Z'
_links:
self:
title: Locations
href: locations/63********************e4
related:
account:
title: accounts
href: accounts/63********************8d
channelLinks:
- title: channelLink
href: channelLinks/63********************45
- title: channelLink
href: channelLinks/63********************22
- title: channelLink
href: channelLinks/63********************12
- title: channelLink
href: channelLinks/63********************1e
- title: channelLink
href: channelLinks/63********************90
channelLinksDetails:
63********************22:
channel: DoorDash
channelId: 12
name: DoorDash
63********************12:
channel: Generic Channel
channelId: 10057
name: Custom Channnel
63********************1e:
channel: Uber Eats
channelId: 7
name: Uber Eats
63********************90:
channel: Deliverect
channelId: 1
name: Test channel
- _id: 63********************67
posSettings: '................'
_links:
parent:
title: home
href: /
self:
title: locations
href: locations?where={"account":"63********************8d"}
next:
title: next page
href: locations?where={"account":"63********************8d"}&page=2
last:
title: last page
href: locations?where={"account":"63********************8d"}&page=26
_meta:
page: 1
max_results: 25
total: 501
operationId: get_get_locations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/products:
get:
tags:
- Products
summary: Deliverect Get Products for Account
parameters:
- name: where
in: query
schema:
type: string
example:
account: '{{accountId}}'
description: The where value.
responses:
'200':
content:
application/json:
schema:
type: object
properties:
_items:
type: array
items:
type: object
properties:
_id:
type: string
example: 622fd8b********eb7dc24d
name:
type: string
example: Add a side
description:
type: string
example: ''
nameTranslations:
type: object
properties:
en:
type: string
example: Choose a side
es:
type: string
example: Elige tu acompañamiento
fr:
type: string
example: Choisissez votre garniture
nl:
type: string
example: Kies je bijgerecht
descriptionTranslations:
type: object
properties: {}
_created:
type: string
example: '2022-03-15T00:07:16.422000Z'
_updated:
type: string
example: '2022-03-15T00:07:16.422000Z'
_etag:
type: string
example: 2715877681451ad6ddae50679c044bb56bef30ac
account:
type: string
example: 5ff6ee089328c8aefeeabe33
location:
type: string
example: 5ff6ee659328c8aefeeac2a7
productType:
type: integer
example: 3
default: 0
plu:
type: string
example: MOD-02
multiply:
type: integer
example: 1
default: 0
posProductId:
type: string
example: POS-ID-003
posProductCategoryId:
type: string
example: ''
subProducts:
type: array
items:
type: string
example: 622fd8b4ac990eb2eb7dc255
productTags:
type: array
items:
type: object
properties: {}
posCategoryIds:
type: array
items:
type: object
properties: {}
isInternal:
type: boolean
example: false
default: true
max:
type: integer
example: 0
default: 0
min:
type: integer
example: 1
default: 0
sortOrder:
type: integer
example: 0
default: 0
capacityUsages:
type: array
items:
type: object
properties: {}
priceLevels:
type: object
properties: {}
deliveryTax:
type: integer
example: 9000
default: 0
takeawayTax:
type: integer
example: 9000
default: 0
eatInTax:
type: integer
example: 9000
default: 0
_links:
type: object
properties:
self:
type: object
properties:
title:
type: string
example: products
href:
type: string
example: products/622fd8b4ac990eb2eb7dc24d
related:
type: object
properties:
subProducts:
type: array
items:
type: object
properties:
title:
type: string
example: products
href:
type: string
example: products/622fd8b4ac990eb2eb7dc255
_links:
type: object
properties:
parent:
type: object
properties:
title:
type: string
example: home
href:
type: string
example: /
self:
type: object
properties:
title:
type: string
example: products
href:
type: string
example: products?where={"account":"5ff6ee089328c8aefeeabe33"}
next:
type: object
properties:
title:
type: string
example: next page
href:
type: string
example: products?where={"account":"5ff6ee089328c8aefeeabe33"}&page=2
last:
type: object
properties:
title:
type: string
example: last page
href:
type: string
example: products?where={"account":"5ff6ee089328c8aefeeabe33"}&page=3
_meta:
type: object
properties:
page:
type: integer
example: 1
default: 0
max_results:
type: integer
example: 25
default: 0
total:
type: integer
example: 64
default: 0
examples:
OK:
summary: OK
value:
_items:
- _id: 622fd8b********eb7dc24d
name: Add a side
description: ''
nameTranslations:
en: Choose a side
es: Elige tu acompañamiento
fr: Choisissez votre garniture
nl: Kies je bijgerecht
descriptionTranslations: {}
_created: '2022-03-15T00:07:16.422000Z'
_updated: '2022-03-15T00:07:16.422000Z'
_etag: 2715877681451ad6ddae50679c044bb56bef30ac
account: 5ff6ee089328c8aefeeabe33
location: 5ff6ee659328c8aefeeac2a7
productType: 3
plu: MOD-02
multiply: 1
posProductId: POS-ID-003
posProductCategoryId: ''
subProducts:
- 622fd8b4ac990eb2eb7dc255
- 622fd8b4ac990eb2eb7dc257
- 622fd8b4ac990eb2eb7dc259
productTags: []
posCategoryIds: []
isInternal: false
max: 0
min: 1
sortOrder: 0
capacityUsages: []
priceLevels: {}
deliveryTax: 9000
takeawayTax: 9000
eatInTax: 9000
_links:
self:
title: products
href: products/622fd8b4ac990eb2eb7dc24d
related:
subProducts:
- title: products
href: products/622fd8b4ac990eb2eb7dc255
- title: products
href: products/622fd8b4ac990eb2eb7dc257
- title: products
href: products/622fd8b4ac990eb2eb7dc259
- _id: 622fd8b4ac990eb2eb7dc24f
name: Rare
description: ''
nameTranslations:
en: Rare
es: Poco hecho
fr: Saignant
nl: Rood
descriptionTranslations: {}
_created: '2022-03-15T00:07:16.422000Z'
_updated: '2022-03-15T00:07:16.422000Z'
_etag: be71204aaf77a4cf1676d698ec32a76a090f0e41
account: 5ff6ee089328c8aefeeabe33
location: 5ff6ee659328c8aefeeac2a7
productType: 2
plu: COOK-01
multiply: 1
posProductId: POS-ID-004
posProductCategoryId: ''
subProducts: []
productTags: []
posCategoryIds: []
isInternal: false
max: 0
min: 0
sortOrder: 0
capacityUsages: []
price: 0
priceLevels: {}
deliveryTax: 9000
takeawayTax: 9000
eatInTax: 9000
_links:
self:
title: products
href: products/622fd8b4ac990eb2eb7dc24f
- _id: 622fd8b4ac990eb2eb7dc251
name: Medium Rare
description: ''
nameTranslations:
en: Medium Rare
es: Al punto
fr: À point
nl: Half doorbakken
descriptionTranslations: {}
_created: '2022-03-15T00:07:16.422000Z'
_updated: '2022-03-15T00:07:16.422000Z'
_etag: 16bba91773586b8aac42ae02e16a9384073bf809
account: 5ff6ee089328c8aefeeabe33
location: 5ff6ee659328c8aefeeac2a7
productType: 2
plu: COOK-02
# --- truncated at 32 KB (141 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/deliverect/refs/heads/main/openapi/deliverect-store-api-openapi-original.yml