> ## Documentation Index > Fetch the complete documentation index at: https://www.twicecommerce.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get all orders > Returns all orders for the tenant with a total count. Not paginated — large tenants should filter by service location or read individual orders via get. ## OpenAPI ````yaml https://server.twicecommerce.com/api/admin/openapi-mintlify.json get /v1/admin/orders openapi: 3.0.2 info: title: TWICE Admin API description: "The TWICE Admin API is the merchant-facing API of the Twice platform. It is currently in alpha: endpoints and schemas may change without notice.\n\n## Webhooks\n\nWebhooks notify your systems when resources change in Twice. A webhook subscription pairs one event type with one HTTPS endpoint of yours; whenever a matching event occurs, we POST the event to that endpoint. Subscriptions and their delivery logs are managed in the Twice admin under **Account → Integrations**.\n\n### Event types\n\n- `order.created`\n- `order.deleted`\n- `order.updated`\n\n### Payload\n\nEvery delivery is an HTTP POST with a JSON body sharing a common envelope. The typed payload of each event type is documented in the **Webhooks** section of the sidebar.\n\n```json\n{\n\t\"eventId\": \"5f2eb3a6-6cbd-4a2e-9350-6e0d1e2f9a11\",\n\t\"eventType\": \"order.created\",\n\t\"eventTime\": \"2026-08-06T12:34:56.789Z\",\n\t\"resource\": \"order\",\n\t\"resourceId\": \"0d9e0a7c-3fd1-4c8f-9c0d-2b7c6f7f2a55\",\n\t\"apiVersion\": \"2025-06\",\n\t\"data\": { \"…\": \"the API representation of the resource, or null for deletes\" }\n}\n```\n\n`data` carries the resource in the same shape the REST API returns it, as of the API version in `apiVersion`. Each subscription is pinned to the API version that was the latest when the subscription was created, so a new API version never changes the payload shape you receive — moving to a newer version is an explicit update of the subscription.\n\n### Acknowledging deliveries\n\nRespond with any **2xx** status to acknowledge a delivery. Any other status — or a timeout — counts as a failed attempt. Respond as quickly as possible and do heavy processing asynchronously after acknowledging.\n\n### Delivery semantics\n\nDeliveries are **at-least-once**: the same event can occasionally be delivered more than once, so deduplicate on the `X-Twice-Event-Id` header (or the equal `eventId` body field). Ordering is not guaranteed — when it matters, use `eventTime` or re-fetch the current state of the resource via the API.\n\n### Retries\n\nFailed deliveries are retried up to 3 times (4 attempts in total) with growing backoff — roughly 10 s, 20 s, 40 s after the preceding attempt — giving up 10 minutes after the first attempt. After 3 consecutive events fail all their attempts, the subscription is automatically disabled (`disabledReason: TOO_MANY_FAILED_DELIVERY_ATTEMPTS`) and must be re-enabled manually in the admin. Individual deliveries can also be redelivered manually from the delivery log.\n\n### Verifying signatures\n\nEach subscription has a signing secret (prefixed `whsec_`), available in the admin. Deliveries carry an HMAC-SHA256 signature of the exact raw request body in the `X-Twice-Signature` header, formatted `sha256=`. Verify it against the raw body bytes — parse the JSON only after the signature checks out:\n\n```js\nimport { createHmac, timingSafeEqual } from 'node:crypto';\n\nconst expected = 'sha256=' + createHmac('sha256', secret).update(rawBody, 'utf8').digest('hex');\nconst signature = req.headers['x-twice-signature'];\nconst isValid =\n\ttypeof signature === 'string' &&\n\tsignature.length === expected.length &&\n\ttimingSafeEqual(Buffer.from(signature), Buffer.from(expected));\n```" version: 2025-06 servers: - url: https://server.twicecommerce.com security: - ApiKeyAuth: [] paths: /v1/admin/orders: get: tags: - orders summary: Get all orders description: >- Returns all orders for the tenant with a total count. Not paginated — large tenants should filter by service location or read individual orders via get. operationId: admin.orders.list parameters: - name: serviceLocationIds in: query schema: type: array items: type: string responses: '200': description: '200' content: application/json: schema: type: object properties: data: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ number: type: number reference: type: string status: type: string enum: - draft - open - active - closed createdAt: type: string updatedAt: type: string archivedAt: nullable: true type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updatedBy: type: string channel: type: string enum: - admin - api - online assignedTo: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string avatarUrl: type: string email: type: string required: - id - name additionalProperties: false currentlyViewing: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string avatarUrl: type: string email: type: string required: - id - name additionalProperties: false tags: type: object properties: id: type: string value: type: string scope: type: string enum: - inventory - catalog - customers - orders createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updatedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - id - value - scope - createdAt - updatedAt additionalProperties: false pickupLocation: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string address: nullable: true type: object properties: address: type: string zipCode: type: string city: type: string country: type: string state: type: string details: type: string required: - address additionalProperties: false timezone: type: string enum: - Africa/Abidjan - Africa/Accra - Brazil/Acre - Australia/ACT - America/Adak - Africa/Addis_Ababa - Australia/Adelaide - Asia/Aden - US/Alaska - US/Aleutian - Africa/Algiers - Asia/Almaty - Asia/Amman - Europe/Amsterdam - Asia/Anadyr - America/Anchorage - Europe/Andorra - America/Anguilla - Indian/Antananarivo - America/Antigua - Pacific/Apia - Asia/Aqtau - Asia/Aqtobe - America/Araguaina - US/Arizona - America/Aruba - Asia/Ashgabat - Asia/Ashkhabad - Africa/Asmara - Africa/Asmera - Europe/Astrakhan - America/Asuncion - Europe/Athens - America/Atikokan - America/Atka - Canada/Atlantic - Asia/Atyrau - Pacific/Auckland - Atlantic/Azores - Asia/Baghdad - America/Bahia - America/Bahia_Banderas - Asia/Bahrain - Mexico/BajaNorte - Mexico/BajaSur - Asia/Baku - Africa/Bamako - Asia/Bangkok - Africa/Bangui - Africa/Banjul - America/Barbados - Asia/Barnaul - Asia/Beirut - America/Belem - Europe/Belfast - Europe/Belgrade - America/Belize - Europe/Berlin - Atlantic/Bermuda - America/North_Dakota/Beulah - Asia/Bishkek - Africa/Bissau - America/Blanc-Sablon - Africa/Blantyre - America/Boa_Vista - America/Bogota - America/Boise - Pacific/Bougainville - Europe/Bratislava - Africa/Brazzaville - Australia/Brisbane - Australia/Broken_Hill - Asia/Brunei - Europe/Brussels - Europe/Bucharest - Europe/Budapest - America/Buenos_Aires - America/Argentina/Buenos_Aires - Africa/Bujumbura - Europe/Busingen - Africa/Cairo - Asia/Calcutta - America/Cambridge_Bay - America/Campo_Grande - Atlantic/Canary - Australia/Canberra - America/Cancun - Atlantic/Cape_Verde - America/Caracas - Africa/Casablanca - Antarctica/Casey - America/Catamarca - America/Argentina/Catamarca - America/Cayenne - America/Cayman - America/North_Dakota/Center - US/Central - Canada/Central - CET - Africa/Ceuta - Indian/Chagos - Pacific/Chatham - America/Chicago - America/Chihuahua - Europe/Chisinau - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Indian/Christmas - Asia/Chungking - Pacific/Chuuk - Indian/Cocos - Asia/Colombo - America/Argentina/ComodRivadavia - Indian/Comoro - Africa/Conakry - Chile/Continental - Europe/Copenhagen - America/Coral_Harbour - America/Cordoba - America/Argentina/Cordoba - America/Costa_Rica - America/Creston - CST6CDT - Cuba - America/Cuiaba - America/Curacao - Australia/Currie - Asia/Dacca - Africa/Dakar - Asia/Damascus - America/Danmarkshavn - Africa/Dar_es_Salaam - Australia/Darwin - Antarctica/Davis - America/Dawson - America/Dawson_Creek - Brazil/DeNoronha - America/Denver - America/Detroit - Asia/Dhaka - Asia/Dili - Africa/Djibouti - America/Dominica - Africa/Douala - Asia/Dubai - Europe/Dublin - Antarctica/DumontDUrville - Asia/Dushanbe - Brazil/East - US/East-Indiana - Pacific/Easter - Chile/EasterIsland - US/Eastern - Canada/Eastern - America/Edmonton - EET - Pacific/Efate - Egypt - Eire - America/Eirunepe - Africa/El_Aaiun - America/El_Salvador - Pacific/Enderbury - America/Ensenada - EST - EST5EDT - Australia/Eucla - Atlantic/Faeroe - Pacific/Fakaofo - Asia/Famagusta - Atlantic/Faroe - Pacific/Fiji - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - Africa/Freetown - Pacific/Funafuti - Africa/Gaborone - Pacific/Galapagos - Pacific/Gambier - Asia/Gaza - GB - GB-Eire - Mexico/General - Europe/Gibraltar - America/Glace_Bay - Etc/GMT - GMT - GMT-0 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT+0 - GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT0 - GMT0 - America/Godthab - America/Goose_Bay - America/Grand_Turk - Etc/Greenwich - Greenwich - America/Grenada - Pacific/Guadalcanal - America/Guadeloupe - Pacific/Guam - America/Guatemala - America/Guayaquil - Europe/Guernsey - America/Guyana - America/Halifax - Africa/Harare - Asia/Harbin - America/Havana - US/Hawaii - Asia/Hebron - Europe/Helsinki - America/Hermosillo - Asia/Ho_Chi_Minh - Australia/Hobart - Asia/Hong_Kong - Hongkong - Pacific/Honolulu - Asia/Hovd - HST - Iceland - US/Indiana-Starke - America/Indiana/Indianapolis - America/Indianapolis - America/Inuvik - America/Iqaluit - Iran - Asia/Irkutsk - Europe/Isle_of_Man - Israel - Asia/Istanbul - Europe/Istanbul - Asia/Jakarta - Jamaica - America/Jamaica - Atlantic/Jan_Mayen - Japan - Asia/Jayapura - Europe/Jersey - Asia/Jerusalem - Africa/Johannesburg - Pacific/Johnston - Africa/Juba - America/Jujuy - America/Argentina/Jujuy - America/Juneau - Asia/Kabul - Europe/Kaliningrad - Asia/Kamchatka - Africa/Kampala - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Indian/Kerguelen - Asia/Khandyga - Africa/Khartoum - Europe/Kiev - Africa/Kigali - Africa/Kinshasa - Pacific/Kiritimati - Europe/Kirov - America/Indiana/Knox - America/Knox_IN - Asia/Kolkata - Pacific/Kosrae - America/Kralendijk - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Kwajalein - Pacific/Kwajalein - America/La_Paz - America/Argentina/La_Rioja - Africa/Lagos - Australia/LHI - Africa/Libreville - Libya - America/Lima - Australia/Lindeman - Europe/Lisbon - Europe/Ljubljana - Africa/Lome - Europe/London - Arctic/Longyearbyen - Australia/Lord_Howe - America/Los_Angeles - America/Louisville - America/Kentucky/Louisville - America/Lower_Princes - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Europe/Luxembourg - Asia/Macao - Asia/Macau - America/Maceio - Antarctica/Macquarie - Atlantic/Madeira - Europe/Madrid - Asia/Magadan - Indian/Mahe - Pacific/Majuro - Asia/Makassar - Africa/Malabo - Indian/Maldives - Europe/Malta - America/Managua - America/Manaus - Asia/Manila - Africa/Maputo - America/Indiana/Marengo - Europe/Mariehamn - America/Marigot - Pacific/Marquesas - America/Martinique - Africa/Maseru - America/Matamoros - Indian/Mauritius - Antarctica/Mawson - Indian/Mayotte - America/Mazatlan - Africa/Mbabane - Antarctica/McMurdo - Australia/Melbourne - America/Mendoza - America/Argentina/Mendoza - America/Menominee - America/Merida - MET - America/Metlakatla - America/Mexico_City - US/Michigan - Pacific/Midway - Europe/Minsk - America/Miquelon - Africa/Mogadishu - Europe/Monaco - America/Moncton - Africa/Monrovia - America/Monterrey - America/Montevideo - America/Kentucky/Monticello - America/Montreal - America/Montserrat - Europe/Moscow - US/Mountain - Canada/Mountain - MST - MST7MDT - Asia/Muscat - Africa/Nairobi - America/Nassau - Pacific/Nauru - Navajo - Africa/Ndjamena - America/North_Dakota/New_Salem - America/New_York - Canada/Newfoundland - Africa/Niamey - Europe/Nicosia - Asia/Nicosia - America/Nipigon - Pacific/Niue - America/Nome - Pacific/Norfolk - America/Noronha - Australia/North - Africa/Nouakchott - Pacific/Noumea - Asia/Novokuznetsk - Asia/Novosibirsk - Australia/NSW - America/Nuuk - NZ - NZ-CHAT - America/Ojinaga - Asia/Omsk - Asia/Oral - Europe/Oslo - Africa/Ouagadougou - US/Pacific - Canada/Pacific - Pacific/Pago_Pago - Pacific/Palau - Antarctica/Palmer - America/Panama - America/Pangnirtung - America/Paramaribo - Europe/Paris - Australia/Perth - America/Indiana/Petersburg - Asia/Phnom_Penh - America/Phoenix - Pacific/Pitcairn - Europe/Podgorica - Pacific/Pohnpei - Poland - Pacific/Ponape - Asia/Pontianak - Pacific/Port_Moresby - America/Port_of_Spain - America/Port-au-Prince - America/Porto_Acre - America/Porto_Velho - Africa/Porto-Novo - Portugal - Europe/Prague - PRC - PST8PDT - America/Puerto_Rico - America/Punta_Arenas - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Australia/Queensland - Asia/Qyzylorda - America/Rainy_River - Asia/Rangoon - America/Rankin_Inlet - Pacific/Rarotonga - America/Recife - America/Regina - America/Resolute - Indian/Reunion - Atlantic/Reykjavik - Europe/Riga - America/Rio_Branco - America/Argentina/Rio_Gallegos - Asia/Riyadh - ROC - ROK - Europe/Rome - America/Rosario - Antarctica/Rothera - Asia/Saigon - Pacific/Saipan - Asia/Sakhalin - America/Argentina/Salta - Europe/Samara - Asia/Samarkand - Pacific/Samoa - US/Samoa - America/Argentina/San_Juan - America/Argentina/San_Luis - Europe/San_Marino - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - Africa/Sao_Tome - Europe/Sarajevo - Europe/Saratov - Canada/Saskatchewan - America/Scoresbysund - Asia/Seoul - Asia/Shanghai - America/Shiprock - Europe/Simferopol - Asia/Singapore - Singapore - America/Sitka - Europe/Skopje - Europe/Sofia - Australia/South - Atlantic/South_Georgia - Antarctica/South_Pole - Asia/Srednekolymsk - America/St_Barthelemy - Atlantic/St_Helena - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - Atlantic/Stanley - Europe/Stockholm - America/Swift_Current - Australia/Sydney - Antarctica/Syowa - Pacific/Tahiti - Asia/Taipei - Europe/Tallinn - Pacific/Tarawa - Asia/Tashkent - Australia/Tasmania - Asia/Tbilisi - America/Tegucigalpa - Asia/Tehran - Asia/Tel_Aviv - America/Indiana/Tell_City - Asia/Thimbu - Asia/Thimphu - America/Thule - America/Thunder_Bay - America/Tijuana - Africa/Timbuktu - Europe/Tirane - Europe/Tiraspol - Asia/Tokyo - Asia/Tomsk - Pacific/Tongatapu - America/Toronto - America/Tortola - Africa/Tripoli - Antarctica/Troll - Pacific/Truk - America/Argentina/Tucuman - Africa/Tunis - Turkey - Etc/UCT - UCT - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Europe/Ulyanovsk - Etc/Universal - Universal - Asia/Urumqi - America/Argentina/Ushuaia - Asia/Ust-Nera - UTC - Etc/UTC - Europe/Uzhgorod - Europe/Vaduz - America/Vancouver - Europe/Vatican - America/Indiana/Vevay - Australia/Victoria - Europe/Vienna - Asia/Vientiane - Europe/Vilnius - America/Indiana/Vincennes - America/Virgin - Asia/Vladivostok - Europe/Volgograd - Antarctica/Vostok - W-SU - Pacific/Wake - Pacific/Wallis - Europe/Warsaw - Brazil/West - Australia/West - WET - America/Whitehorse - America/Indiana/Winamac - Africa/Windhoek - America/Winnipeg - America/Yakutat - Asia/Yakutsk - Australia/Yancowinna - Asia/Yangon - Pacific/Yap - Asia/Yekaterinburg - America/Yellowknife - Asia/Yerevan - Canada/Yukon - Europe/Zagreb - Europe/Zaporozhye - Etc/Zulu - Zulu - Europe/Zurich required: - id - name - address - timezone additionalProperties: false returnLocation: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string address: nullable: true type: object properties: address: type: string zipCode: type: string city: type: string country: type: string state: type: string details: type: string required: - address additionalProperties: false timezone: type: string enum: - Africa/Abidjan - Africa/Accra - Brazil/Acre - Australia/ACT - America/Adak - Africa/Addis_Ababa - Australia/Adelaide - Asia/Aden - US/Alaska - US/Aleutian - Africa/Algiers - Asia/Almaty - Asia/Amman - Europe/Amsterdam - Asia/Anadyr - America/Anchorage - Europe/Andorra - America/Anguilla - Indian/Antananarivo - America/Antigua - Pacific/Apia - Asia/Aqtau - Asia/Aqtobe - America/Araguaina - US/Arizona - America/Aruba - Asia/Ashgabat - Asia/Ashkhabad - Africa/Asmara - Africa/Asmera - Europe/Astrakhan - America/Asuncion - Europe/Athens - America/Atikokan - America/Atka - Canada/Atlantic - Asia/Atyrau - Pacific/Auckland - Atlantic/Azores - Asia/Baghdad - America/Bahia - America/Bahia_Banderas - Asia/Bahrain - Mexico/BajaNorte - Mexico/BajaSur - Asia/Baku - Africa/Bamako - Asia/Bangkok - Africa/Bangui - Africa/Banjul - America/Barbados - Asia/Barnaul - Asia/Beirut - America/Belem - Europe/Belfast - Europe/Belgrade - America/Belize - Europe/Berlin - Atlantic/Bermuda - America/North_Dakota/Beulah - Asia/Bishkek - Africa/Bissau - America/Blanc-Sablon - Africa/Blantyre - America/Boa_Vista - America/Bogota - America/Boise - Pacific/Bougainville - Europe/Bratislava - Africa/Brazzaville - Australia/Brisbane - Australia/Broken_Hill - Asia/Brunei - Europe/Brussels - Europe/Bucharest - Europe/Budapest - America/Buenos_Aires - America/Argentina/Buenos_Aires - Africa/Bujumbura - Europe/Busingen - Africa/Cairo - Asia/Calcutta - America/Cambridge_Bay - America/Campo_Grande - Atlantic/Canary - Australia/Canberra - America/Cancun - Atlantic/Cape_Verde - America/Caracas - Africa/Casablanca - Antarctica/Casey - America/Catamarca - America/Argentina/Catamarca - America/Cayenne - America/Cayman - America/North_Dakota/Center - US/Central - Canada/Central - CET - Africa/Ceuta - Indian/Chagos - Pacific/Chatham - America/Chicago - America/Chihuahua - Europe/Chisinau - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Indian/Christmas - Asia/Chungking - Pacific/Chuuk - Indian/Cocos - Asia/Colombo - America/Argentina/ComodRivadavia - Indian/Comoro - Africa/Conakry - Chile/Continental - Europe/Copenhagen - America/Coral_Harbour - America/Cordoba - America/Argentina/Cordoba - America/Costa_Rica - America/Creston - CST6CDT - Cuba - America/Cuiaba - America/Curacao - Australia/Currie - Asia/Dacca - Africa/Dakar - Asia/Damascus - America/Danmarkshavn - Africa/Dar_es_Salaam - Australia/Darwin - Antarctica/Davis - America/Dawson - America/Dawson_Creek - Brazil/DeNoronha - America/Denver - America/Detroit - Asia/Dhaka - Asia/Dili - Africa/Djibouti - America/Dominica - Africa/Douala - Asia/Dubai - Europe/Dublin - Antarctica/DumontDUrville - Asia/Dushanbe - Brazil/East - US/East-Indiana - Pacific/Easter - Chile/EasterIsland - US/Eastern - Canada/Eastern - America/Edmonton - EET - Pacific/Efate - Egypt - Eire - America/Eirunepe - Africa/El_Aaiun - America/El_Salvador - Pacific/Enderbury - America/Ensenada - EST - EST5EDT - Australia/Eucla - Atlantic/Faeroe - Pacific/Fakaofo - Asia/Famagusta - Atlantic/Faroe - Pacific/Fiji - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - Africa/Freetown - Pacific/Funafuti - Africa/Gaborone - Pacific/Galapagos - Pacific/Gambier - Asia/Gaza - GB - GB-Eire - Mexico/General - Europe/Gibraltar - America/Glace_Bay - Etc/GMT - GMT - GMT-0 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT+0 - GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT0 - GMT0 - America/Godthab - America/Goose_Bay - America/Grand_Turk - Etc/Greenwich - Greenwich - America/Grenada - Pacific/Guadalcanal - America/Guadeloupe - Pacific/Guam - America/Guatemala - America/Guayaquil - Europe/Guernsey - America/Guyana - America/Halifax - Africa/Harare - Asia/Harbin - America/Havana - US/Hawaii - Asia/Hebron - Europe/Helsinki - America/Hermosillo - Asia/Ho_Chi_Minh - Australia/Hobart - Asia/Hong_Kong - Hongkong - Pacific/Honolulu - Asia/Hovd - HST - Iceland - US/Indiana-Starke - America/Indiana/Indianapolis - America/Indianapolis - America/Inuvik - America/Iqaluit - Iran - Asia/Irkutsk - Europe/Isle_of_Man - Israel - Asia/Istanbul - Europe/Istanbul - Asia/Jakarta - Jamaica - America/Jamaica - Atlantic/Jan_Mayen - Japan - Asia/Jayapura - Europe/Jersey - Asia/Jerusalem - Africa/Johannesburg - Pacific/Johnston - Africa/Juba - America/Jujuy - America/Argentina/Jujuy - America/Juneau - Asia/Kabul - Europe/Kaliningrad - Asia/Kamchatka - Africa/Kampala - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Indian/Kerguelen - Asia/Khandyga - Africa/Khartoum - Europe/Kiev - Africa/Kigali - Africa/Kinshasa - Pacific/Kiritimati - Europe/Kirov - America/Indiana/Knox - America/Knox_IN - Asia/Kolkata - Pacific/Kosrae - America/Kralendijk - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Kwajalein - Pacific/Kwajalein - America/La_Paz - America/Argentina/La_Rioja - Africa/Lagos - Australia/LHI - Africa/Libreville - Libya - America/Lima - Australia/Lindeman - Europe/Lisbon - Europe/Ljubljana - Africa/Lome - Europe/London - Arctic/Longyearbyen - Australia/Lord_Howe - America/Los_Angeles - America/Louisville - America/Kentucky/Louisville - America/Lower_Princes - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Europe/Luxembourg - Asia/Macao - Asia/Macau - America/Maceio - Antarctica/Macquarie - Atlantic/Madeira - Europe/Madrid - Asia/Magadan - Indian/Mahe - Pacific/Majuro - Asia/Makassar - Africa/Malabo - Indian/Maldives - Europe/Malta - America/Managua - America/Manaus - Asia/Manila - Africa/Maputo - America/Indiana/Marengo - Europe/Mariehamn - America/Marigot - Pacific/Marquesas - America/Martinique - Africa/Maseru - America/Matamoros - Indian/Mauritius - Antarctica/Mawson - Indian/Mayotte - America/Mazatlan - Africa/Mbabane - Antarctica/McMurdo - Australia/Melbourne - America/Mendoza - America/Argentina/Mendoza - America/Menominee - America/Merida - MET - America/Metlakatla - America/Mexico_City - US/Michigan - Pacific/Midway - Europe/Minsk - America/Miquelon - Africa/Mogadishu - Europe/Monaco - America/Moncton - Africa/Monrovia - America/Monterrey - America/Montevideo - America/Kentucky/Monticello - America/Montreal - America/Montserrat - Europe/Moscow - US/Mountain - Canada/Mountain - MST - MST7MDT - Asia/Muscat - Africa/Nairobi - America/Nassau - Pacific/Nauru - Navajo - Africa/Ndjamena - America/North_Dakota/New_Salem - America/New_York - Canada/Newfoundland - Africa/Niamey - Europe/Nicosia - Asia/Nicosia - America/Nipigon - Pacific/Niue - America/Nome - Pacific/Norfolk - America/Noronha - Australia/North - Africa/Nouakchott - Pacific/Noumea - Asia/Novokuznetsk - Asia/Novosibirsk - Australia/NSW - America/Nuuk - NZ - NZ-CHAT - America/Ojinaga - Asia/Omsk - Asia/Oral - Europe/Oslo - Africa/Ouagadougou - US/Pacific - Canada/Pacific - Pacific/Pago_Pago - Pacific/Palau - Antarctica/Palmer - America/Panama - America/Pangnirtung - America/Paramaribo - Europe/Paris - Australia/Perth - America/Indiana/Petersburg - Asia/Phnom_Penh - America/Phoenix - Pacific/Pitcairn - Europe/Podgorica - Pacific/Pohnpei - Poland - Pacific/Ponape - Asia/Pontianak - Pacific/Port_Moresby - America/Port_of_Spain - America/Port-au-Prince - America/Porto_Acre - America/Porto_Velho - Africa/Porto-Novo - Portugal - Europe/Prague - PRC - PST8PDT - America/Puerto_Rico - America/Punta_Arenas - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Australia/Queensland - Asia/Qyzylorda - America/Rainy_River - Asia/Rangoon - America/Rankin_Inlet - Pacific/Rarotonga - America/Recife - America/Regina - America/Resolute - Indian/Reunion - Atlantic/Reykjavik - Europe/Riga - America/Rio_Branco - America/Argentina/Rio_Gallegos - Asia/Riyadh - ROC - ROK - Europe/Rome - America/Rosario - Antarctica/Rothera - Asia/Saigon - Pacific/Saipan - Asia/Sakhalin - America/Argentina/Salta - Europe/Samara - Asia/Samarkand - Pacific/Samoa - US/Samoa - America/Argentina/San_Juan - America/Argentina/San_Luis - Europe/San_Marino - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - Africa/Sao_Tome - Europe/Sarajevo - Europe/Saratov - Canada/Saskatchewan - America/Scoresbysund - Asia/Seoul - Asia/Shanghai - America/Shiprock - Europe/Simferopol - Asia/Singapore - Singapore - America/Sitka - Europe/Skopje - Europe/Sofia - Australia/South - Atlantic/South_Georgia - Antarctica/South_Pole - Asia/Srednekolymsk - America/St_Barthelemy - Atlantic/St_Helena - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - Atlantic/Stanley - Europe/Stockholm - America/Swift_Current - Australia/Sydney - Antarctica/Syowa - Pacific/Tahiti - Asia/Taipei - Europe/Tallinn - Pacific/Tarawa - Asia/Tashkent - Australia/Tasmania - Asia/Tbilisi - America/Tegucigalpa - Asia/Tehran - Asia/Tel_Aviv - America/Indiana/Tell_City - Asia/Thimbu - Asia/Thimphu - America/Thule - America/Thunder_Bay - America/Tijuana - Africa/Timbuktu - Europe/Tirane - Europe/Tiraspol - Asia/Tokyo - Asia/Tomsk - Pacific/Tongatapu - America/Toronto - America/Tortola - Africa/Tripoli - Antarctica/Troll - Pacific/Truk - America/Argentina/Tucuman - Africa/Tunis - Turkey - Etc/UCT - UCT - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Europe/Ulyanovsk - Etc/Universal - Universal - Asia/Urumqi - America/Argentina/Ushuaia - Asia/Ust-Nera - UTC - Etc/UTC - Europe/Uzhgorod - Europe/Vaduz - America/Vancouver - Europe/Vatican - America/Indiana/Vevay - Australia/Victoria - Europe/Vienna - Asia/Vientiane - Europe/Vilnius - America/Indiana/Vincennes - America/Virgin - Asia/Vladivostok - Europe/Volgograd - Antarctica/Vostok - W-SU - Pacific/Wake - Pacific/Wallis - Europe/Warsaw - Brazil/West - Australia/West - WET - America/Whitehorse - America/Indiana/Winamac - Africa/Windhoek - America/Winnipeg - America/Yakutat - Asia/Yakutsk - Australia/Yancowinna - Asia/Yangon - Pacific/Yap - Asia/Yekaterinburg - America/Yellowknife - Asia/Yerevan - Canada/Yukon - Europe/Zagreb - Europe/Zaporozhye - Etc/Zulu - Zulu - Europe/Zurich required: - id - name - address - timezone additionalProperties: false mainContact: type: object properties: firstName: type: string lastName: type: string fullName: type: string phone: type: string email: nullable: true type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ marketingConsent: type: boolean crmCustomerId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ dateOfBirth: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ billingAddress: type: object properties: address: type: string zipCode: type: string city: type: string country: type: string state: type: string details: type: string deliveryNotes: type: string additionalProperties: false shippingAddress: type: object properties: address: type: string zipCode: type: string city: type: string country: type: string state: type: string details: type: string deliveryNotes: type: string additionalProperties: false customerType: type: string enum: - individual - business companyName: type: string taxId: type: string language: type: string required: - firstName - fullName - email - crmCustomerId additionalProperties: false customers: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ createdAt: type: string updatedAt: type: string firstName: type: string lastName: type: string fullName: type: string phone: type: string email: type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ marketingConsent: type: boolean checkoutFields: type: object properties: name: type: string type: type: string enum: - text - select - number - checkbox - customer_attribute placeholder: type: string required: type: boolean internal: type: boolean attributeId: type: string attributeFormat: type: string enum: - text - number - boolean - date - datetime - formula - select - multiselect options: type: object properties: name: type: string required: - name additionalProperties: false value: anyOf: - type: string - type: number - type: boolean checkoutFieldId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ ids: type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ required: - name - type - ids additionalProperties: false crmCustomerId: type: string dateOfBirth: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ billingAddress: type: object properties: address: type: string zipCode: type: string city: type: string country: type: string state: type: string details: type: string deliveryNotes: type: string additionalProperties: false shippingAddress: type: object properties: address: type: string zipCode: type: string city: type: string country: type: string state: type: string details: type: string deliveryNotes: type: string additionalProperties: false customerType: type: string enum: - individual - business companyName: type: string taxId: type: string language: type: string required: - id - createdAt - updatedAt - firstName - fullName additionalProperties: false lineItems: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ createdAt: type: string updatedAt: type: string name: allOf: - type: object additionalProperties: type: string - type: object properties: def: type: string required: - def additionalProperties: false variants: type: object properties: variantId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ variantValueId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ variantLabel: type: string variantValueLabel: type: string required: - variantId - variantValueId - variantLabel - variantValueLabel additionalProperties: false orderCustomerId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ pricing: {} duration: type: string startDate: type: string endDate: type: string returnedDate: type: string purchaseType: type: string enum: - booking - sale - subscription - buyback catalogItemId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ imageUrl: type: string fulfillmentState: type: string enum: - pending - reserved - on-hold - ready - cancelled - fulfilled - returned checkoutFields: type: object properties: id: type: string name: type: string type: type: string enum: - text - select - number - checkbox - customer_attribute placeholder: type: string required: type: boolean internal: type: boolean attributeId: type: string attributeFormat: type: string enum: - text - number - boolean - date - datetime - formula - select - multiselect options: type: object properties: name: type: string required: - name additionalProperties: false value: anyOf: - type: string - type: number - type: boolean checkoutFieldId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ required: - id - name - type additionalProperties: false capturedTotal: type: number refundedTotal: type: number depositCapturedTotal: type: number depositRefundedTotal: type: number depositAuthorisedTotal: type: number depositCancelledTotal: type: number pricingRowId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ durationLabel: type: string note: type: string addonOfLineItemId: nullable: true type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ catalogAddonId: nullable: true type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ cartAddonId: nullable: true type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ isAddon: nullable: true type: string enum: - cart - catalog subscription: nullable: true type: object properties: label: type: string minLength: 1 price: type: integer exclusiveMinimum: true maximum: 9007199254740991 renewalPrice: nullable: true type: integer exclusiveMinimum: true maximum: 9007199254740991 commitmentCycles: type: integer exclusiveMinimum: true maximum: 9007199254740991 paymentCycleUnit: type: string enum: - seconds - minutes - hours - days - weeks - months - years paymentCycleAmount: type: integer exclusiveMinimum: true maximum: 9007199254740991 initialChargeType: type: string enum: - order_creation - subscription_start renewalType: type: string enum: - none - auto_renew collectionMethod: type: string enum: - charge_automatically - send_invoice cancellationLeadTimeUnit: type: string enum: - seconds - minutes - hours - days - weeks - months - years cancellationLeadTimeAmount: type: integer exclusiveMinimum: true maximum: 9007199254740991 id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ orderLineItemId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ commitmentPeriodUnit: type: string enum: - seconds - minutes - hours - days - weeks - months - years commitmentPeriodAmount: type: integer exclusiveMinimum: true maximum: 9007199254740991 status: type: string enum: - active - past_due - failed - completed - cancelled nextBillingAt: nullable: true type: string cancelAt: nullable: true type: string cancelledAt: nullable: true type: string required: - label - price - renewalPrice - commitmentCycles - paymentCycleUnit - paymentCycleAmount - initialChargeType - renewalType - collectionMethod - cancellationLeadTimeUnit - cancellationLeadTimeAmount - id - orderLineItemId - commitmentPeriodUnit - commitmentPeriodAmount - status - nextBillingAt - cancelAt - cancelledAt additionalProperties: false subscriptionDiscounts: type: object properties: code: type: string discountCodeId: nullable: true type: string valueType: type: string enum: - percentage - fixed_per_order - fixed_per_item value: type: number subscriptionDuration: nullable: true type: string enum: - once - repeating - forever subscriptionDurationCycles: nullable: true type: number firstDiscountedCycleIndex: type: number discountPeriodTo: nullable: true type: string required: - code - valueType - value - subscriptionDuration - subscriptionDurationCycles - firstDiscountedCycleIndex additionalProperties: false required: - id - createdAt - updatedAt - name - pricing additionalProperties: false stockItems: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ createdAt: type: string updatedAt: type: string name: type: string code: type: string codeType: type: string enum: - auto-assigned - manual expectsInventoryLink: type: boolean requirements: type: object properties: attributeId: type: string key: type: string enum: - attribute - item_code - sku_code - item_name - sku_name operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty values: type: array items: anyOf: - type: string - type: number - type: boolean required: - key - operator - values additionalProperties: false lineItemId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ inventoryArticleId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ pickupServiceLocation: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string required: - id - name additionalProperties: false pickupDate: type: string returnServiceLocation: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string required: - id - name additionalProperties: false returnDate: type: string fulfillmentState: type: string enum: - pending - reserved - on-hold - ready - cancelled - fulfilled - returned unavailabilityId: nullable: true type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ orderId: type: string purchaseType: type: string enum: - booking - sale - subscription - buyback inventoryArticle: type: object properties: name: type: string codes: type: array items: type: string binLocation: type: string skuName: type: string skuCode: type: string required: - name - codes additionalProperties: false note: type: string revenueSplitRate: nullable: true type: number hasConflicts: type: boolean required: - id - createdAt - updatedAt - name - lineItemId - fulfillmentState - orderId additionalProperties: false documents: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ type: type: string enum: - email - document name: type: string fileRef: type: string required: - id - type additionalProperties: false comments: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ createdAt: type: string updatedAt: type: string authorId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ authorType: type: string enum: - system - user content: type: string parentCommentId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ author: nullable: true type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string avatarUrl: type: string email: type: string required: - id - name additionalProperties: false required: - id - createdAt - updatedAt - authorType - content - author additionalProperties: false capturedTotal: type: number refundedTotal: type: number depositCapturedTotal: type: number depositRefundedTotal: type: number depositAuthorisedTotal: type: number depositCancelledTotal: type: number paymentMethodKey: type: string enum: - CARD_ONLINE_STRIPE - CARD_STRIPE - APPLE_PAY_STRIPE - GOOGLE_PAY_STRIPE - MOBILEPAY_STRIPE - PAY_BY_BANK_STRIPE - CARD_ADYEN - APPLE_PAY_ADYEN - GOOGLE_PAY_ADYEN - PAY_STORE - CUSTOM - CARD_SUMUP_SOLO customPaymentMethod: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ key: type: string label: type: string description: type: string required: - id - label additionalProperties: false hasSavedPaymentMethod: type: boolean savedCard: nullable: true type: object properties: brand: nullable: true type: string last4: nullable: true type: string required: - brand - last4 additionalProperties: false pricing: {} note: type: string fulfillmentState: type: string enum: - fulfilled - partially-fulfilled - ready - unfulfilled earliestStartDate: type: string latestEndDate: type: string consentAcceptances: type: object properties: consentConfigId: type: string label: type: string consentText: type: string required: type: boolean acceptedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ ipAddress: nullable: true type: string userAgent: nullable: true type: string locale: nullable: true type: string links: type: array items: anyOf: - type: object properties: kind: type: string enum: - policy policyDocumentId: nullable: true type: string name: type: string content: {} required: - kind - policyDocumentId - name - content additionalProperties: false - type: object properties: kind: type: string enum: - policy-external policyDocumentId: nullable: true type: string name: type: string externalUrl: type: string format: uri required: - kind - policyDocumentId - name - externalUrl additionalProperties: false - type: object properties: kind: type: string enum: - url label: type: string url: type: string format: uri required: - kind - label - url additionalProperties: false id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ orderId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ required: - consentConfigId - label - consentText - required - acceptedAt - ipAddress - userAgent - locale - links - id - orderId additionalProperties: false subscriptionData: type: object properties: hasSubscriptions: type: boolean currency: type: string items: type: object properties: productName: type: string planLabel: type: string listPrice: type: integer minimum: -9007199254740991 maximum: 9007199254740991 paymentCycleUnit: type: string enum: - seconds - minutes - hours - days - weeks - months - years paymentCycleAmount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 discounts: type: object properties: code: type: string valueType: type: string enum: - percentage - fixed_per_order - fixed_per_item value: type: number required: - code - valueType - value additionalProperties: false nextPayment: nullable: true type: object properties: amount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 date: type: string required: - amount - date additionalProperties: false minimumTerm: nullable: true type: object properties: periodAmount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 periodUnit: type: string enum: - seconds - minutes - hours - days - weeks - months - years endDate: type: string required: - periodAmount - periodUnit - endDate additionalProperties: false renewal: nullable: true type: object properties: price: type: integer minimum: -9007199254740991 maximum: 9007199254740991 fromDate: type: string required: - price - fromDate additionalProperties: false endsAt: nullable: true type: string cancellationNotice: nullable: true type: object properties: amount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 unit: type: string enum: - seconds - minutes - hours - days - weeks - months - years required: - amount - unit additionalProperties: false required: - productName - planLabel - listPrice - paymentCycleUnit - paymentCycleAmount - discounts - nextPayment - minimumTerm - renewal - endsAt - cancellationNotice additionalProperties: false required: - hasSubscriptions - currency - items additionalProperties: false required: - id - number - reference - status - createdAt - updatedAt - channel - currentlyViewing - pickupLocation - returnLocation - customers - lineItems - stockItems - documents - comments - hasSavedPaymentMethod - savedCard - pricing - fulfillmentState - subscriptionData additionalProperties: false totalCount: type: number required: - data - totalCount additionalProperties: false '400': description: '400' '401': description: '401' '403': description: '403' '404': description: '404' content: application/json: schema: type: object properties: message: type: string required: - message additionalProperties: false '429': description: '429' '500': description: '500' components: securitySchemes: ApiKeyAuth: type: apiKey name: X-API-KEY in: header description: API key for the Twice API ````