StoreAPI.json
To start testing please follow the instructions in Github Swagger UI Editor
{
"openapi": "3.1.0",
"info": {
"title": "Deliverect Store API",
"description": " Deliverect allows restaurants to directly connect channels like UberEats, Takeaway.com, Glovo and others with their POS system. More info on features and platforms supported on [https://deliverect.com/](https://deliverect.com/) This API can be used to integrate additional channels or POS systems, but also by bigger restaurants",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.staging.deliverect.com"
}
],
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer"
}
}
},
"security": [
{
"bearerAuth": []
}
],
"tags": [
{
"name": "Authentication",
"description": " "
},
{
"name": "Store API",
"description": "Deliverect Endpoint"
}
],
"paths": {
"/oauth/token": {
"post": {
"tags": [
"Authentication"
],
"summary": "Machine 2 Machine Access Token",
"requestBody": {
"content": {
"*/*": {
"schema": {
"type": "string",
"examples": [
{
"client_id": "{{clientId}}",
"client_secret": "{{clientSecret}}",
"audience": "https://api.deliverect.com",
"grant_type": "token"
}
]
}
}
}
},
"parameters": [
{
"name": "content-type",
"in": "header",
"schema": {
"type": "string"
},
"example": "application/json"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"schema": {
"type": "string",
"examples": [
"Wed, 20 Feb 2019 13:18:00 GMT"
]
}
},
"Content-Type": {
"schema": {
"type": "string",
"examples": [
"application/json"
]
}
},
"Content-Length": {
"schema": {
"type": "integer",
"examples": [
"828"
]
}
},
"Connection": {
"schema": {
"type": "string",
"examples": [
"keep-alive"
]
}
},
"X-Auth0-RequestId": {
"schema": {
"type": "string",
"examples": [
"521b1266bf81fec2fb6b"
]
}
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer",
"examples": [
"30"
]
}
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer",
"examples": [
"29"
]
}
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer",
"examples": [
"1550668681"
]
}
},
"Cache-Control": {
"schema": {
"type": "string",
"examples": [
"private, no-store, no-cache, must-revalidate, post-check=0, pre-check=0"
]
}
},
"Pragma": {
"schema": {
"type": "string",
"examples": [
"no-cache"
]
}
},
"Strict-Transport-Security": {
"schema": {
"type": "string",
"examples": [
"max-age=15724800"
]
}
},
"X-Robots-Tag": {
"schema": {
"type": "string",
"examples": [
"noindex, nofollow, nosnippet, noarchive"
]
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"access_token": "ey**-**-Q",
"expires_at": 1620899002,
"token_type": "Bearer",
"scope": "genericPOS provisioning"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"Date": {
"schema": {
"type": "string",
"examples": [
"Wed, 20 Feb 2019 13:11:39 GMT"
]
}
},
"Content-Type": {
"schema": {
"type": "string",
"examples": [
"application/json"
]
}
},
"Content-Length": {
"schema": {
"type": "integer",
"examples": [
"60"
]
}
},
"Connection": {
"schema": {
"type": "string",
"examples": [
"keep-alive"
]
}
},
"X-Auth0-RequestId": {
"schema": {
"type": "string",
"examples": [
"1bb8a6bbea0c249b00dd"
]
}
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer",
"examples": [
"30"
]
}
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer",
"examples": [
"29"
]
}
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer",
"examples": [
"1550668300"
]
}
},
"WWW-Authenticate": {
"schema": {
"type": "string",
"examples": [
"Basic realm={{Users}}"
]
}
},
"Cache-Control": {
"schema": {
"type": "string",
"examples": [
"private, no-store, no-cache, must-revalidate, post-check=0, pre-check=0"
]
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"error": "access_denied",
"error_description": "Unauthorized"
}
}
}
}
}
}
},
"/locations": {
"get": {
"tags": [
"Store API"
],
"summary": "Get 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}}"
}
}
],
"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": {
"example-0": {
"summary": "Account and location result",
"value": {
"_items": [
{
"_id": "5c1a40f6c6489f00bac4c252",
"name": "Partner Jelte",
"accountType": 1,
"_updated": "2019-02-14T13:57:59.000000Z",
"_created": "2018-12-19T13:00:38.000000Z",
"_etag": "ad515c7db898b7004253d8ea46d07a3b7e0cbd99",
"locations": [
"5c1a4117c6489f00bac4c253",
"5c20ea48c6489f0016a132f7",
"5c20f1cec6489f0035972273",
"5c6573e7c6489f00014c507c"
],
"accounts": [
{
"_id": "5c3f8a90c6489f002c85dd3d",
"name": "Gastrofixies",
"accountType": 2,
"_updated": "2019-01-16T19:49:37.000000Z",
"_created": "2019-01-16T19:48:32.000000Z",
"_deleted": false,
"_etag": "56f924441a4de194e96f3d9f6ebc962b7a8d524c",
"locations": [
{
"_id": "5c3f8ad1c6489f002c85dd3e",
"name": "Gastro gefixed (10905)",
"account": "5c3f8a90c6489f002c85dd3d",
"_updated": "2019-01-28T12:19:19.000000Z",
"_created": "2019-01-16T19:49:37.000000Z",
"_deleted": false,
"_etag": "11b454d7423e292c4455c5c142ebc12d2563f8ea",
"channelLinks": [
"5c3f8aeac6489f002c85dd41",
"5c4ef347c6489f0001594856"
]
}
]
}
],
"users": [
"5c2496cbc6489f00169462a3"
],
"_deleted": false,
"_links": {
"self": {
"title": "accounts",
"href": "accounts/5c1a40f6c6489f00bac4c252"
}
}
}
],
"_links": {
"parent": {
"title": "home",
"href": "/"
},
"self": {
"title": "accounts",
"href": "accounts"
}
},
"_meta": {
"page": 1,
"max_results": 25,
"total": 1
}
}
},
"example-1": {
"summary": "locations by account",
"value": {
"_items": [
{
"_id": "5bf02f38c6489f002c******",
"_created": "2018-11-17T15:09:44.000000Z",
"_updated": "2019-02-14T11:16:20.000000Z",
"_etag": "ef043a0519e16ba48d7b4b2f5af928c9324760e0",
"name": "Test location 1",
"status": "INTEGRATOR",
"channelLinks": [
"5bf02f38c6489f002******1",
"5bf02f38c6489f002******2"
],
"account": "5be9c971c6489f0029******",
"_deleted": false,
"_links": {
"self": {
"title": "Locations",
"href": "locations/5bf02f38c6489f002c******"
}
}
},
{
"_id": "5bf02f38c6489f002c******",
"_created": "2018-11-17T15:09:44.000000Z",
"_updated": "2019-01-16T17:30:40.000000Z",
"_etag": "c9a39040acd03086bcd9abfd00af7acb5c5e748f",
"name": "Test Location 2",
"status": "INTEGRATOR",
"channelLinks": [
"5bf02f38c6489f002******1"
],
"account": "5be9c971c6489f0029******",
"_deleted": false,
"_links": {
"self": {
"title": "Locations",
"href": "locations/5bf02f38c6489f002c******"
}
}
}
],
"_links": {
"parent": {
"title": "home",
"href": "/"
},
"self": {
"title": "locations",
"href": "locations?where={account: {{accountId}}}"
}
},
"_meta": {
"page": 1,
"max_results": 25,
"total": 4
}
}
}
}
}
}
}
}
}
},
"/products/": {
"get": {
"tags": [
"Store API"
],
"summary": "Get Products for Account",
"parameters": [
{
"name": "where",
"in": "query",
"schema": {
"type": "string"
},
"example": {
"account": "{{accountId}}"
}
}
],
"responses": {
"default": {
"description": "default",
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"examples": [
"application/json"
]
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"_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",
"multiply": 1,
"posProductId": "POS-ID-005",
"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/622fd8b4ac990eb2eb7dc251"
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc255",
"name": "Fries",
"description": "",
"nameTranslations": {
"en": "Fries",
"es": "Patatas fritas",
"fr": "Frites",
"nl": "Frietjes"
},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.422000Z",
"_updated": "2022-03-15T00:07:16.422000Z",
"_etag": "2f6c78768a648d49a91723e365b38db4b0fcb94c",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 2,
"plu": "SI-01",
"multiply": 1,
"posProductId": "POS-ID-006",
"posProductCategoryId": "",
"subProducts": [],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 0,
"min": 0,
"defaultQuantity": 1,
"sortOrder": 0,
"capacityUsages": [],
"price": 0,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc255"
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc257",
"name": "Salad",
"description": "",
"nameTranslations": {
"en": "Salad",
"es": "Ensalada",
"fr": "Salade",
"nl": "Salade"
},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.422000Z",
"_updated": "2022-03-15T00:07:16.422000Z",
"_etag": "fbd9ebc70111fea3ce22cfcfdf8938f5490974ae",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 2,
"plu": "SI-02",
"multiply": 1,
"posProductId": "POS-ID-007",
"posProductCategoryId": "",
"subProducts": [],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 200,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc257"
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc259",
"name": "Mashed Potato",
"description": "",
"nameTranslations": {
"en": "Mashed Potato",
"es": "Puré de patata",
"fr": "Purée de pommes de terre",
"nl": "Aardappelpuree"
},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.422000Z",
"_updated": "2022-03-15T00:07:16.422000Z",
"_etag": "05d48dd6689a7885f01971197480b9ce8fb24151",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 2,
"plu": "SI-03",
"multiply": 1,
"posProductId": "POS-ID-008",
"posProductCategoryId": "",
"subProducts": [],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 100,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc259"
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc25b",
"name": "Chicken Sate",
"description": "Product with Nested Modifiers - Multimax variables - Allergens (tags)",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.422000Z",
"_updated": "2022-03-15T00:07:16.422000Z",
"_etag": "f9d4e488bc46c73379bc7f44ec26402c7167878f",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "P-SATE",
"multiply": 1,
"posProductId": "POS-ID-009",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc25d",
"622fd8b4ac990eb2eb7dc25f"
],
"productTags": [
104,
108
],
"posCategoryIds": [
"SATE"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/satay-62284e3c8c506f015be60184.jpeg",
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 450,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc25b"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc25d"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc25f"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc261",
"name": "White Rice",
"description": "White coloured rice",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.423000Z",
"_updated": "2022-03-15T00:07:16.423000Z",
"_etag": "93d3797000158ddbfba6e555975812b00fd440f9",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "RICE-01",
"multiply": 1,
"posProductId": "POS-ID-012",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc269"
],
"productTags": [],
"posCategoryIds": [
"SD"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/nasiputi-1610290140494.jpg",
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 450,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc261"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc269"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc265",
"name": "Egg Noodles",
"description": "Egg noodles and veggies fried and tossed with a delicious sauce",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.423000Z",
"_updated": "2022-03-15T00:07:16.423000Z",
"_etag": "82fe6073cf8ad734790611a88c994b878700eb98",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "NOOD-01",
"multiply": 1,
"posProductId": "POS-ID-014",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc269"
],
"productTags": [],
"posCategoryIds": [
"SD"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/bamigoreng-1610289922969.jpg",
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 450,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc265"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc269"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc267",
"name": "Ramen Noodles",
"description": "Chinese-style wheat noodles",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.423000Z",
"_updated": "2022-03-15T00:07:16.423000Z",
"_etag": "31517b482377d626dba89d13fd72bda726ed4b3e",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "NOOD-02",
"multiply": 1,
"posProductId": "POS-ID-015",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc269"
],
"productTags": [],
"posCategoryIds": [
"SD"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/Mihoen-2-1-1610289870157.jpg",
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 450,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc267"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc269"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc26b",
"name": "Sate Sauce",
"description": "",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.423000Z",
"_updated": "2022-03-15T00:07:16.423000Z",
"_etag": "424be2d9e4483177d78aef72749492572f977997",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 2,
"plu": "SAUCE-01",
"multiply": 1,
"posProductId": "POS-ID-017",
"posProductCategoryId": "",
"subProducts": [],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 50,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc26b"
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc26d",
"name": "Hot Sauce",
"description": "",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.423000Z",
"_updated": "2022-03-15T00:07:16.423000Z",
"_etag": "e9d50ad67406d4c6b833df8763b3a0a2a9cded5f",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 2,
"plu": "SAUCE-02",
"multiply": 1,
"posProductId": "POS-ID-018",
"posProductCategoryId": "",
"subProducts": [],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 50,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc26d"
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc26f",
"name": "Burger Combo (Drink not Included)",
"description": "Combo with Bundles - Modifier Groups as Upsell",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.423000Z",
"_updated": "2022-03-15T00:07:16.423000Z",
"_etag": "f7e7f78062028d530e3bbf7ab82c95457aa23924",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "P-BRGR",
"multiply": 1,
"posProductId": "POS-ID-019",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc271",
"622fd8b4ac990eb2eb7dc273",
"622fd8b4ac990eb2eb7dc275"
],
"productTags": [],
"posCategoryIds": [
"BURG"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/burger-62286be78c506f015be60190.jpeg",
"isInternal": false,
"isCombo": true,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 950,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc26f"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc271"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc273"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc275"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc273",
"name": "Fries Selection",
"description": "",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.423000Z",
"_updated": "2022-03-15T00:07:16.423000Z",
"_etag": "a91312a5e9fae3539769038c06b8f246744a40f2",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 3,
"plu": "MG-FRS",
"multiply": 1,
"posProductId": "POS-ID-021",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc277",
"622fd8b4ac990eb2eb7dc279",
"622fd8b4ac990eb2eb7dc27b"
],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 1,
"min": 1,
"sortOrder": 0,
"capacityUsages": [],
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc273"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc277"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc279"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc27b"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc275",
"name": "Add a Drink? (not included)",
"description": "",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.423000Z",
"_updated": "2022-07-06T08:03:11.000000Z",
"_etag": "def3a76097f22874ed0ec2e5481b74865c113467",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 3,
"plu": "UPSLL-01",
"multiply": 1,
"posProductId": "POS-ID-022",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc283",
"622fd8b4ac990eb2eb7dc285",
"622fd8b4ac990eb2eb7dc287"
],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 0,
"min": 0,
"multiMax": 0,
"sortOrder": 0,
"capacityUsages": [],
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc275"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc283"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc285"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc287"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc277",
"name": "French Fries",
"description": "Plain fries from France",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.423000Z",
"_updated": "2022-03-15T00:07:16.423000Z",
"_etag": "77b6eef509fed9c3787dc17aa8cfe6bfe6915f9d",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "P-FRS-S",
"multiply": 1,
"posProductId": "POS-ID-023",
"posProductCategoryId": "",
"subProducts": [],
"productTags": [],
"posCategoryIds": [
"FRS"
],
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 200,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc277"
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc27d",
"name": "Chicken Burger",
"description": "Crispy coated chicken thigh, iceberg lettuce, pickles, slice of cheese & mayo, all in a toasted brioche bun.",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.424000Z",
"_updated": "2022-03-15T00:07:16.424000Z",
"_etag": "f123a4c0c5a34ac30e132d965f25345779f12024",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "P-BURG-CHK",
"multiply": 1,
"posProductId": "POS-ID-026",
"posProductCategoryId": "",
"subProducts": [],
"productTags": [],
"posCategoryIds": [
"BURG"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/chkburger-6228c1dcdb5986001ebf58df.jpeg",
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 800,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc27d"
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc287",
"name": "Ginger Beer",
"description": "Australia's favourite ginger beer!",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.424000Z",
"_updated": "2022-03-15T00:07:16.424000Z",
"_etag": "62bb35e3c3f2a5e6f7459d8a5d3ee756b29b6d7c",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "DRNK-03",
"multiply": 1,
"posProductId": "POS-ID-031",
"posProductCategoryId": "",
"subProducts": [],
"productTags": [],
"posCategoryIds": [
"DRK"
],
"imageUrl": "https://storage.googleapis.com/ikona-bucket-staging/images/5ff6ee089328c8aefeeabe33/gingerbeer-62285548db5986001ebf58d1.jpg",
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 400,
"bottleDepositPrice": 100,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc287"
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc28d",
"name": "Mini Poke Bowl",
"description": "A little bowl of Poke",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.424000Z",
"_updated": "2022-03-15T00:07:16.424000Z",
"_etag": "f4c1a3f3fb705345ef489c904c93cd158ec06a49",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "SZ-01",
"multiply": 1,
"posProductId": "POS-ID-034",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc293"
],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 800,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc28d"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc293"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc28f",
"name": "Large Poke Bowl",
"description": "A big bowl of Poke",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.424000Z",
"_updated": "2022-03-15T00:07:16.424000Z",
"_etag": "542f83a681b422a0ff3f345a387280fd0a0d5c45",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "SZ-02",
"multiply": 1,
"posProductId": "POS-ID-035",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc295"
],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 0,
"min": 0,
"sortOrder": 0,
"capacityUsages": [],
"price": 1200,
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc28f"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc295"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc291",
"name": "Choose Your Base",
"description": "",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.424000Z",
"_updated": "2022-03-15T00:07:16.424000Z",
"_etag": "8cd586d4610a753e9d2748467d6f911d39b73740",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 4,
"plu": "BNDL-01",
"multiply": 1,
"posProductId": "POS-ID-036",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc299",
"622fd8b4ac990eb2eb7dc29b"
],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 1,
"min": 1,
"sortOrder": 0,
"capacityUsages": [],
"priceLevels": {},
"deliveryTax": 6000,
"takeawayTax": 6000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc291"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc299"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc29b"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc293",
"name": "Choose Your Protein",
"description": "",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.424000Z",
"_updated": "2022-03-15T00:07:16.424000Z",
"_etag": "fb449d2323d61657c1ba8bc94db1132d56eda269",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 4,
"plu": "BNDL-01-SML",
"multiply": 1,
"posProductId": "POS-ID-037",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc29d",
"622fd8b4ac990eb2eb7dc29f",
"622fd8b4ac990eb2eb7dc2a1"
],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 1,
"min": 1,
"sortOrder": 0,
"capacityUsages": [],
"priceLevels": {},
"deliveryTax": 6000,
"takeawayTax": 6000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc293"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc29d"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc29f"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc2a1"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc295",
"name": "Choose Your Protein",
"description": "",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.424000Z",
"_updated": "2022-03-15T00:07:16.424000Z",
"_etag": "9bb1989fc9d54146b320cc693f87ef5d42a1cd1b",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 4,
"plu": "BNDL-LG",
"multiply": 1,
"posProductId": "POS-ID-038",
"posProductCategoryId": "",
"subProducts": [
"622fd8b4ac990eb2eb7dc29d",
"622fd8b4ac990eb2eb7dc29f",
"622fd8b4ac990eb2eb7dc2a1"
],
"productTags": [],
"posCategoryIds": [],
"isInternal": false,
"max": 1,
"min": 1,
"sortOrder": 0,
"capacityUsages": [],
"priceLevels": {},
"deliveryTax": 9000,
"takeawayTax": 9000,
"eatInTax": 9000,
"_links": {
"self": {
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc295"
},
"related": {
"subProducts": [
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc29d"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc29f"
},
{
"title": "products",
"href": "products/622fd8b4ac990eb2eb7dc2a1"
}
]
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc29f",
"name": "Spicy Tuna",
"description": "",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.425000Z",
"_updated": "2022-03-15T00:07:16.425000Z",
"_etag": "68ed7cc40d43e2236ea9e75da897653a3f3c77d4",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "PRT-02",
"multiply": 1,
"posProductId": "POS-ID-043",
"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/622fd8b4ac990eb2eb7dc29f"
}
}
},
{
"_id": "622fd8b4ac990eb2eb7dc2a1",
"name": "Teriyaki Chicken",
"description": "",
"nameTranslations": {},
"descriptionTranslations": {},
"_created": "2022-03-15T00:07:16.429000Z",
"_updated": "2022-03-15T00:07:16.429000Z",
"_etag": "584dacd4970848bffb6513e1826f2ae26fb23f83",
"account": "5ff6ee089328c8aefeeabe33",
"location": "5ff6ee659328c8aefeeac2a7",
"productType": 1,
"plu": "PRT-03",
"multiply": 1,
"posProductId": "POS-ID-044",
"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/622fd8b4ac990eb2eb7dc2a1"
}
}
}
],
"_links": {
"parent": {
"title": "home",
"href": "/"
},
"self": {
"title": "products",
"href": "products?where={account:5ff6ee089328c8aefeeabe33"
}
},
"next": {
"title": "next page",
"href": "products?where={account:5ff6ee089328c8aefeeabe33}&page=2"
},
"last": {
"title": "last page",
"href": "products?where={account:5ff6ee089328c8aefeeabe33}&page=3"
}
},
"_meta": {
"page": 1,
"max_results": 25,
"total": 64
}
}
}
}
}
}
},
"/channelDisabledProducts": {
"get": {
"tags": [
"Store API"
],
"summary": "Get products marked out of stock",
"description": "Get products marked out of stock.",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
},
"example": "application/json"
},
{
"name": "where",
"in": "query",
"schema": {
"type": "string"
},
"example": {
"account": "account_id",
"location": "location_id"
}
}
],
"responses": {
"default": {
"description": "default",
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"examples": [
"application/json"
]
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"_items": [
{
"_id": "612***2cf",
"_created": "2021-08-30T11:41:09.077000Z",
"_updated": "2021-08-30T11:53:09.000000Z",
"_etag": "19358d3fb0b1cdb2cf96fa71f7c21abda863b00f",
"account": "60e***945",
"channel": -1,
"location": "60e***96a",
"plu": "VAR-PROD-1",
"name": "Pinapple pizza",
"deliverectProductId": "610***b73",
"snoozeStart": "2021-08-30T11:41:09Z",
"snoozeEnd": "2021-08-30T11:53:09Z",
"isBogof": false,
"isInBundle": false,
"channelLinks": [
"60e***a37"
],
"_links": {
"self": {
"title": "channelDisabledProducts",
"href": "channelDisabledProducts/612***2cf"
}
}
},
{
"_id": "612***298",
"_created": "2021-08-30T14:31:19Z",
"_updated": "2021-08-30T14:31:19Z",
"_etag": "f839b4936adbaa034358bc669abe75cfdbb80964",
"account": "60e***945",
"channel": -1,
"location": "60e***96a",
"plu": "MOD555",
"name": "Ice",
"deliverectProductId": "612***e8d",
"snoozeStart": "2021-08-30T14:31:19Z",
"snoozeEnd": "2021-08-30T15:31:19Z",
"isBogof": false,
"isInBundle": false,
"channelLinks": [
"60e***a37",
"612***204"
],
"_links": {
"self": {
"title": "channelDisabledProducts",
"href": "channelDisabledProducts/612***298"
}
}
},
{
"_id": "613***6a3",
"_created": "2021-09-03T13:09:48Z",
"_updated": "2021-09-03T13:09:48Z",
"_etag": "6f5e942de36140f6825c7f69695f94a464bcab4e",
"account": "60e***945",
"channel": -1,
"location": "60e***96a",
"plu": "PR2",
"name": "Cola",
"deliverectProductId": "60e4***f62",
"snoozeStart": "2021-08-18T11:13:00Z",
"snoozeEnd": "2021-09-03T13:17:48Z",
"isBogof": false,
"isInBundle": false,
"channelLinks": [
"60e***a37",
"612***204",
"613***31c"
],
"_links": {
"self": {
"title": "channelDisabledProducts",
"href": "channelDisabledProducts/613***6a3"
}
}
}
],
"_links": {
"parent": {
"title": "home",
"href": "/"
},
"self": {
"title": "channelDisabledProducts",
"href": "channelDisabledProducts?where={ account: {{account_id}}, location: {{location_id}}"
}
},
"_meta": {
"page": 1,
"max_results": 25,
"total": 9
}
}
}
}
}
}
}
},
"/products/snoozeByTags": {
"post": {
"tags": [
"Store API"
],
"summary": "Mark products out of stock by tag",
"description": "Mark products out of stock for a certain amount of time based on their tag and location. You can use the same call to unsnooze product passing `snoozeEnd` time in the past. ##### NOTE Please note, that here and later all dates and times, coming from/to Deliverect are UTC.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
"account": "{{account_id}}",
"location": "{{location_id}}",
"tags": [
1
],
"snoozeStart": "2019-03-06T15:45:00.000Z",
"snoozeEnd": "2019-03-07T15:45:00.000Z"
}
]
}
}
}
},
"responses": {
"default": {
"description": "default",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"examples": {
"example-0": {
"summary": "Single tag for all locations",
"value": null
},
"example-1": {
"summary": "Single tag for one location",
"value": null
},
"example-2": {
"summary": "Multiple tags for all locations",
"value": null
},
"example-3": {
"summary": "Multiple tag for one location",
"value": null
}
}
}
}
}
}
}
},
"/products/snoozeByPlus": {
"post": {
"tags": [
"Store API"
],
"summary": "Mark products out of stock by PLU",
"description": "Mark products out of stock for a certain amount of time based on their PLU and location. You can use the same call to unsnooze product passing `snoozeEnd` time in the past.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
"account": "{{account_id}}",
"location": "{{location_id}}",
"plus": [
"PLU1"
],
"snoozeStart": "2019-03-06T15:45:00.000Z",
"snoozeEnd": "2019-03-07T15:45:00.000Z"
}
]
}
}
}
},
"responses": {
"default": {
"description": "default",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"examples": {
"example-0": {
"summary": "Multiple PLUs across all locations",
"value": null
},
"example-1": {
"summary": "Multiple PLUs for one location",
"value": null
},
"example-2": {
"summary": "Single PLU for one location",
"value": null
},
"example-3": {
"summary": "Single PLU across all locations",
"value": null
}
}
}
}
}
}
}
},
"/updateStoreStatus/{locationId}": {
"post": {
"tags": [
"Store API"
],
"summary": "Update Store Status",
"description": "This endpoint allows a POS to update store status. One, several or all channel links can be put in busy/online mode(should be supported by channels as well) by calling this endpoint. When sending a call to the endpoint make sure it includes `isActive` flag which indicates if store busy/online. Optional parameter `channelLinks` allwos you to specify a list of channel links to be put in busy/online mode. Otherwise all location channel links will be put in busy/online mode. As a payload we always expect a JSON that contains: * Flag that indicates if store is busy/online (`isActive`) * [Optional] Array of channel link ids to be put in busy/online more (`channelLink`)",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
"isActive": true,
"channelLinks": [
"606d8489f****ddf13b****6"
]
}
]
}
}
}
},
"parameters": [
{
"name": "locationId",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": null
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"errors": [
"Channel Link 606d8489f****ddf13b****6 failed to update status"
]
}
}
}
}
}
}
},
"/location/{locationId}/openingHours": {
"get": {
"tags": [
"Store API"
],
"summary": "Get Store Opening Hours",
"parameters": [
{
"name": "locationId",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
}
}
}
},
"/account/{accountId}/openingHours": {
"get": {
"tags": [
"Store API"
],
"summary": "Get Account Opening Hours",
"parameters": [
{
"name": "accountId",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
}
}
}
},
"/locations/openingHours": {
"post": {
"tags": [
"Store API"
],
"summary": "Create/Update Opening Hours",
"requestBody": {
"content": {}
},
"responses": {
"default": {
"description": "default",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"examples": {
"example-0": {
"summary": "Channel Specific Hours",
"value": null
},
"example-1": {
"summary": "Location Specific Hours",
"value": null
},
"example-2": {
"summary": "Location and Channel Hours",
"value": null
}
}
}
}
}
}
}
},
"/locations/holidays": {
"post": {
"tags": [
"Store API"
],
"summary": "Holiday Hours for Locations",
"requestBody": {
"content": {}
},
"responses": {
"default": {
"description": "default",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": null
}
}
}
}
}
},
"/location/{locationId}/holidays": {
"get": {
"tags": [
"Store API"
],
"summary": "Holiday Hours for Locations",
"parameters": [
{
"name": "locationId",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
}
}
}
},
"/locations/channels/{locationId}/holidays": {
"get": {
"tags": [
"Store API"
],
"summary": "Holiday Hours for Locations & ChannelLinks",
"parameters": [
{
"name": "locationId",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
}
}
}
},
"/locations/channels/holidays": {
"post": {
"tags": [
"Store API"
],
"summary": "Holiday Hours for Locations and ChannelLinks",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
"locations": [
{
"id": "someLocationId",
"channels": [
{
"id": "someChannelLinkId",
"holidays": [
{
"startTime": "2021-12-19T15:53:00Z",
"endTime": "2021-12-19T16:10:00Z"
},
{
"startTime": "2022-05-18T04:00:00Z",
"endTime": "2022-05-18T05:00:00Z"
},
{
"startTime": "2022-05-17T17:37:00Z",
"endTime": "2022-05-17T17:39:00Z"
},
{
"startTime": "2023-08-04T09:00:00Z",
"endTime": "2023-08-04T19:00:00Z"
}
]
}
]
}
]
}
]
}
}
}
},
"responses": {
"default": {
"description": "default",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": null
}
}
}
}
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}