openapi: 3.1.0 info: title: Deliverect Commerce API description: Power digital ordering, click-and-collect, and kiosk experiences with store details, menu data, basket creation, validation, discounts, and a checkout flow that injects orders to the POS. Authenticates with OAuth 2.0 machine-to-machine access tokens scoped via genericCommerce. version: '1.0' x-generated-from: documentation x-source-url: https://developers.deliverect.com/reference x-last-validated: '2026-06-02' contact: name: Kin Lane email: kin@apievangelist.com license: name: All Rights Reserved servers: - url: https://api.deliverect.com description: Production - url: https://api.staging.deliverect.com description: Staging tags: - name: Baskets description: Baskets operations for the Deliverect Commerce API. - name: Stores description: Stores operations for the Deliverect Commerce API. - name: Menus description: Menus operations for the Deliverect Commerce API. - name: Checkout description: Checkout operations for the Deliverect Commerce API. - name: Coupons description: Coupons operations for the Deliverect Commerce API. - name: Upsell description: Upsell operations for the Deliverect Commerce API. paths: /commerce/{accountId}/baskets/recreate: post: description: Deliverect Recreate Basket responses: '200': description: '' content: application/json: examples: OK: summary: OK value: id: 65********************e2 channel: 20000 category: type: restaurant currency: USD taxExclusive: true status: open items: - id: 65********************27 menuId: 64********************7b plu: QS-01 name: Classic Quesadilla + Drink note: as much cheese as possible! quantity: 1 price: 529 gross: 698 taxes: - rate: 7000 name: GST amount: 49 net: 747 subItems: - customizationPlu: MOD-01 plu: DRNK-01 name: Coca Cola quantity: 1 price: 169 note: Extra cold please subItems: [] discounts: [] discountTotal: 0 - id: 691327c5d367f4588f9482fb menuId: 6902550da160cca419af2469 plu: '645611577' name: Chocolate Chip Cookie quantity: 2 price: 159 gross: 318 taxes: [] net: 318 subItems: [] discounts: [] discountTotal: 0 note: In seperate bag please payment: tips: [] discountsTotal: 0 chargesTotal: 0 taxTotal: 56 tipTotal: 0 subTotal: 1016 total: 1065 customer: name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' fulfillment: type: pickup time: null taxes: - name: SALES_TAX amount: 49 discounts: [] charges: serviceCharge: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 type: fixed bagFee: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 deliveryFee: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 taxTotal: 0 netTotal: 0 grossTotal: 0 created: YYYY-MM-DDTHH:mm:ss.SSSSSSZ updated: YYYY-MM-DDTHH:mm:ss.SSSSSSZ deleted: false etag: f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf accountId: 66********************d1 storeId: 67********************a8 channelLinkId: 67********************a8 channelOrderId: null channelOrderDisplayId: null schema: type: object properties: id: type: string example: 65********************e2 channel: type: integer example: 20000 default: 0 category: type: object properties: type: type: string example: restaurant currency: type: string example: USD taxExclusive: type: boolean example: true default: true status: type: string example: open items: type: array items: type: object properties: id: type: string example: 65********************27 menuId: type: string example: 64********************7b plu: type: string example: QS-01 name: type: string example: Classic Quesadilla + Drink note: type: string example: as much cheese as possible! quantity: type: integer example: 1 default: 0 price: type: integer example: 529 default: 0 gross: type: integer example: 698 default: 0 taxes: type: array items: type: object properties: rate: type: integer example: 7000 default: 0 name: type: string example: GST amount: type: integer example: 49 default: 0 net: type: integer example: 747 default: 0 subItems: type: array items: type: object properties: customizationPlu: type: string example: MOD-01 plu: type: string example: DRNK-01 name: type: string example: Coca Cola quantity: type: integer example: 1 default: 0 price: type: integer example: 169 default: 0 note: type: string example: Extra cold please subItems: type: array items: type: object properties: {} discounts: type: array items: type: object properties: {} discountTotal: type: integer example: 0 default: 0 payment: type: object properties: tips: type: array items: type: object properties: {} discountsTotal: type: integer example: 0 default: 0 chargesTotal: type: integer example: 0 default: 0 taxTotal: type: integer example: 56 default: 0 tipTotal: type: integer example: 0 default: 0 subTotal: type: integer example: 1016 default: 0 total: type: integer example: 1065 default: 0 customer: type: object properties: name: type: string example: John Doe companyName: type: string example: ACME phoneNumber: type: string example: '+3211223344' email: type: string example: john.doe@acme.com externalId: type: string example: crm-id-1234 tin: type: string example: '123456789' fulfillment: type: object properties: type: type: string example: pickup time: {} taxes: type: array items: type: object properties: name: type: string example: SALES_TAX amount: type: integer example: 49 default: 0 discounts: type: array items: type: object properties: {} charges: type: object properties: serviceCharge: type: object properties: value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 tax: type: integer example: 0 default: 0 net: type: integer example: 0 default: 0 type: type: string example: fixed bagFee: type: object properties: value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 tax: type: integer example: 0 default: 0 net: type: integer example: 0 default: 0 deliveryFee: type: object properties: value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 tax: type: integer example: 0 default: 0 net: type: integer example: 0 default: 0 taxTotal: type: integer example: 0 default: 0 netTotal: type: integer example: 0 default: 0 grossTotal: type: integer example: 0 default: 0 created: type: string example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ updated: type: string example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ deleted: type: boolean example: false default: true etag: type: string example: f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf accountId: type: string example: 66********************d1 storeId: type: string example: 67********************a8 channelLinkId: type: string example: 67********************a8 channelOrderId: {} channelOrderDisplayId: {} '422': content: application/json: schema: type: object properties: code: type: string example: product_snoozed message: type: string example: Product is currently snoozed context: type: object properties: menuId: type: string example: 63********************b5 plu: type: string example: '123' examples: Unprocessable Entity: summary: Unprocessable Entity value: code: product_snoozed message: Product is currently snoozed context: menuId: 63********************b5 plu: '123' description: Unprocessable Entity parameters: - in: path name: accountId schema: type: string required: true description: The accountId value. example: 5b71c6489f00290d4 operationId: post_commerce_accountid_baskets_recreate requestBody: content: application/json: schema: type: object properties: storeId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e orderId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e required: - storeId - orderId examples: post_commerce_accountid_baskets_recreateRequest: summary: Default post_commerce_accountid_baskets_recreate request x-microcks-default: true value: storeId: 609a1b2c3d4e5f6a7b8c9d0e orderId: 609a1b2c3d4e5f6a7b8c9d0e summary: Deliverect Recreate Basket tags: - Baskets x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/stores/{channelLinkId}: get: tags: - Stores summary: Deliverect Get Store description: A store represents a unique ordering experience from a specific location. operationId: commerce_channel_api_stores_get_store parameters: - name: accountId in: path schema: type: string default: 668e4aa170efd23c474b2ad1 required: true description: The accountId value. example: 668e4aa170efd23c474b2ad1 - in: path name: channelLinkId schema: type: string required: true description: The channelLinkId value. example: 5e8abc11dec0001a009b responses: '200': description: '200' content: application/json: examples: Result: value: id: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 name: Store Name currency: EUR address: source: 1 Main street D13 R2P6 Ghent VOV coordinates: - 3.73398891371018 - 51.0311233802278 country: BE city: Ghent stateOrProvince: VOV openingHours: timezone: Europe/Brussels dayTimeRanges: - dayOfWeek: 1 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 2 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 3 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 4 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 5 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 6 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 7 startTime: 00:00:00 endTime: '23:59:00' scheduling: acceptsAsapOrders: false acceptsPreOrders: false acceptsSameDayPreOrders: false minimumLeadTimeInMinutes: 30 maximumDaysInAdvance: 30 slotLengthInMinutes: 30 distance: 1235 taxExclusive: false contact: firstName: John lastName: Doe phoneNumber: '+32411111111' email: john.doe@acme.com fulfillmentTypes: - pickup - delivery - eatIn status: open schema: type: object properties: id: type: string example: 65eee6a9984a1bc1b9637c59 name: type: string example: Store Name currency: type: string example: EUR address: type: object properties: source: type: string example: 1 Main street D13 R2P6 Ghent VOV coordinates: type: array items: type: number example: 3.73398891371018 default: 0 country: type: string example: BE city: type: string example: Ghent stateOrProvince: type: string example: VOV openingHours: type: object properties: timezone: type: string example: Europe/Brussels dayTimeRanges: type: array items: type: object properties: dayOfWeek: type: integer example: 1 default: 0 startTime: type: string example: 00:00:00 endTime: type: string example: '23:59:00' distance: type: integer example: 1235 default: 0 taxExclusive: type: boolean example: false default: true contact: type: object properties: firstName: type: string example: John lastName: type: string example: Doe phoneNumber: type: string example: '+32411111111' email: type: string example: john.doe@acme.com fulfillmentTypes: type: array items: type: string example: pickup status: type: string example: open '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/menus: get: tags: - Menus summary: Deliverect Get Root Menu(s) description: This endpoint returns a list of menus associated with the account's master location. These menus are store agnostic and typically hold enough data to display as first entry experience. operationId: commerce_channel_api_menus_get_root_menus parameters: - name: accountId in: path schema: type: string required: true description: The accountId value. example: 5b71c6489f00290d4 responses: '200': description: '200' content: application/json: examples: Result: value: - menu: Burger Menu menuId: 64c27a89c6352cd55814580c menuType: 0 nestedModifiers: false description: Description menuImageUrl: null currency: 1 menuTranslations: en: '' productTags: - 116 - 16 - 6 - 115 - 1 - 35 - 101 - 104 descriptionTranslations: en: '' categories: - id: 64c27a9513128b833aaec96e name: Pizza description: '' imageUrl: null menu: 64c27a89c6352cd55814580c account: 64872839172e0e6d2cedaa48 nameTranslations: {} descriptionTranslations: {} subProducts: - 648acd52c5bf7503468da6c7 - 648acc5c2d5016b2ecce3188 - 649abe754ea4f0e242ddb755 - id: 65c130c6ec28c6821bcf80ab name: Drinks description: '' imageUrl: null menu: 64c27a89c6352cd55814580c account: 64872839172e0e6d2cedaa48 nameTranslations: {} descriptionTranslations: {} subProducts: - 64d4c407554b010187f74830 - id: 65c130daec28c6821bcf80e0 name: Burgers description: '' imageUrl: null menu: 64c27a89c6352cd55814580c account: 64872839172e0e6d2cedaa48 nameTranslations: {} descriptionTranslations: {} subProducts: - 65c1304eec28c6821bcf73e7 - id: 65c131b0dc12e93ea9081a9a name: Extra description: '' imageUrl: null menu: 64c27a89c6352cd55814580c account: 64872839172e0e6d2cedaa48 nameTranslations: {} descriptionTranslations: {} subProducts: - 65c1308edc12e93ea907f49a products: 648acd52c5bf7503468da6c7: id: 648acd52c5bf7503468da6c7 plu: P-MA-sViS-2 name: Margherita productType: 1 max: 0 min: 0 multiply: 1 description: Margherita Pizza defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: P-MA-sViS-2 calories: null caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: - 116 subProducts: - 648c251ebb2163a8cebc1137 beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] 648acc5c2d5016b2ecce3188: id: 648acc5c2d5016b2ecce3188 plu: P-PE-xmku-2 name: Pepperoni productType: 1 max: 0 min: 0 multiply: 1 description: Pepperoni Pizza defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: P-PE-xmku-2 calories: null caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: - 16 - 6 - 115 subProducts: [] beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] 649abe754ea4f0e242ddb755: id: 649abe754ea4f0e242ddb755 plu: P-ME-72C1-2 name: Pizza Meal Option 1 productType: 1 max: 0 min: 0 multiply: 1 description: '' defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: P-ME-72C1-2 calories: null caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: [] subProducts: - 649abede949cfa36470e3326 - 649abefeb99c55cfcbf181c6 beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] 64d4c407554b010187f74830: id: 64d4c407554b010187f74830 plu: VAR-3 name: Coke productType: 1 max: 0 min: 0 multiply: 1 description: '' defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: VAR-3 calories: 2 caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: [] subProducts: [] beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] 65c1304eec28c6821bcf73e7: id: 65c1304eec28c6821bcf73e7 plu: P-TA-FYlu-2 name: Burger productType: 1 max: 0 min: 0 multiply: 1 description: '' defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: P-TA-FYlu-2 calories: 500 caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: - 1 - 35 - 101 - 104 subProducts: [] beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] 65c1308edc12e93ea907f49a: id: 65c1308edc12e93ea907f49a plu: P-FR-WZDd-2 name: Fries productType: 1 max: 0 min: 0 multiply: 1 description: '' defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: P-FR-WZDd-2 calories: null caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: [] subProducts: [] beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] 663c976df7d1fb0d85dc96c5: id: 663c976df7d1fb0d85dc96c5 plu: P-MA-sViS-2### name: Margherita productType: 1 max: 0 min: 0 multiply: 1 description: Margherita Pizza defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: P-MA-sViS-2 calories: null caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: - 116 subProducts: - 648c251ebb2163a8cebc1137 beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] 663c976df7d1fb0d85dc96c6: id: 663c976df7d1fb0d85dc96c6 plu: P-PE-xmku-2### name: Pepperoni productType: 1 max: 0 min: 0 multiply: 1 description: Pepperoni Pizza defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: P-PE-xmku-2 calories: null caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: - 16 - 6 - 115 subProducts: [] beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] modifiers: 648c24f842c8fee99960fc05: id: 648c24f842c8fee99960fc05 plu: M-BA-nNU1-2 name: Bacon productType: 2 max: 0 min: 0 multiply: 1 description: '' defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: null calories: null caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: [] subProducts: [] beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] modifierGroups: 648c251ebb2163a8cebc1137: id: 648c251ebb2163a8cebc1137 plu: MG-TO-QeOs-2 name: Toppings productType: 3 max: 5 min: 0 multiply: 1 description: '' defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: null calories: null caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: [] subProducts: - 648c24f842c8fee99960fc05 beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] bundles: 649abede949cfa36470e3326: id: 649abede949cfa36470e3326 plu: P-meal-deal-1 name: Pizza 1 productType: 4 max: 1 min: 1 multiply: 1 description: '' defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: null calories: null caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: [] subProducts: - 663c976df7d1fb0d85dc96c5 beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] 649abefeb99c55cfcbf181c6: id: 649abefeb99c55cfcbf181c6 plu: B-PI-qEtO-2 name: Pizza 2 productType: 4 max: 1 min: 1 multiply: 1 description: '' defaultQuantity: null isVariant: null account: 64872839172e0e6d2cedaa48 referenceId: null calories: null caloriesRangeHigh: null nameTranslations: {} descriptionTranslations: {} productTags: [] subProducts: - 663c976df7d1fb0d85dc96c6 beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null subProductSortOrder: [] schema: type: array items: type: object properties: menu: type: string example: Burger Menu menuId: type: string example: 64c27a89c6352cd55814580c menuType: type: integer example: 0 default: 0 nestedModifiers: type: boolean example: false default: true description: type: string example: Description menuImageUrl: {} currency: type: integer example: 1 default: 0 menuTranslations: type: object properties: en: type: string example: '' productTags: type: array items: type: integer example: 116 default: 0 descriptionTranslations: type: object properties: en: type: string example: '' categories: type: array items: type: object properties: id: type: string example: 64c27a9513128b833aaec96e name: type: string example: Pizza description: type: string example: '' imageUrl: {} menu: type: string example: 64c27a89c6352cd55814580c account: type: string example: 64872839172e0e6d2cedaa48 nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} subProducts: type: array items: type: string example: 648acd52c5bf7503468da6c7 products: type: object properties: 648acd52c5bf7503468da6c7: type: object properties: id: type: string example: 648acd52c5bf7503468da6c7 plu: type: string example: P-MA-sViS-2 name: type: string example: Margherita productType: type: integer example: 1 default: 0 max: type: integer example: 0 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: Margherita Pizza defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: type: string example: P-MA-sViS-2 calories: {} caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array items: type: integer example: 116 default: 0 subProducts: type: array items: type: string example: 648c251ebb2163a8cebc1137 beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array 648acc5c2d5016b2ecce3188: type: object properties: id: type: string example: 648acc5c2d5016b2ecce3188 plu: type: string example: P-PE-xmku-2 name: type: string example: Pepperoni productType: type: integer example: 1 default: 0 max: type: integer example: 0 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: Pepperoni Pizza defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: type: string example: P-PE-xmku-2 calories: {} caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array items: type: integer example: 16 default: 0 subProducts: type: array beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array 649abe754ea4f0e242ddb755: type: object properties: id: type: string example: 649abe754ea4f0e242ddb755 plu: type: string example: P-ME-72C1-2 name: type: string example: Pizza Meal Option 1 productType: type: integer example: 1 default: 0 max: type: integer example: 0 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: '' defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: type: string example: P-ME-72C1-2 calories: {} caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array subProducts: type: array items: type: string example: 649abede949cfa36470e3326 beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array 64d4c407554b010187f74830: type: object properties: id: type: string example: 64d4c407554b010187f74830 plu: type: string example: VAR-3 name: type: string example: Coke productType: type: integer example: 1 default: 0 max: type: integer example: 0 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: '' defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: type: string example: VAR-3 calories: type: integer example: 2 default: 0 caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array subProducts: type: array beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array 65c1304eec28c6821bcf73e7: type: object properties: id: type: string example: 65c1304eec28c6821bcf73e7 plu: type: string example: P-TA-FYlu-2 name: type: string example: Burger productType: type: integer example: 1 default: 0 max: type: integer example: 0 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: '' defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: type: string example: P-TA-FYlu-2 calories: type: integer example: 500 default: 0 caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array items: type: integer example: 1 default: 0 subProducts: type: array beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array 65c1308edc12e93ea907f49a: type: object properties: id: type: string example: 65c1308edc12e93ea907f49a plu: type: string example: P-FR-WZDd-2 name: type: string example: Fries productType: type: integer example: 1 default: 0 max: type: integer example: 0 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: '' defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: type: string example: P-FR-WZDd-2 calories: {} caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array subProducts: type: array beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array 663c976df7d1fb0d85dc96c5: type: object properties: id: type: string example: 663c976df7d1fb0d85dc96c5 plu: type: string example: P-MA-sViS-2### name: type: string example: Margherita productType: type: integer example: 1 default: 0 max: type: integer example: 0 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: Margherita Pizza defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: type: string example: P-MA-sViS-2 calories: {} caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array items: type: integer example: 116 default: 0 subProducts: type: array items: type: string example: 648c251ebb2163a8cebc1137 beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array 663c976df7d1fb0d85dc96c6: type: object properties: id: type: string example: 663c976df7d1fb0d85dc96c6 plu: type: string example: P-PE-xmku-2### name: type: string example: Pepperoni productType: type: integer example: 1 default: 0 max: type: integer example: 0 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: Pepperoni Pizza defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: type: string example: P-PE-xmku-2 calories: {} caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array items: type: integer example: 16 default: 0 subProducts: type: array beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array modifiers: type: object properties: 648c24f842c8fee99960fc05: type: object properties: id: type: string example: 648c24f842c8fee99960fc05 plu: type: string example: M-BA-nNU1-2 name: type: string example: Bacon productType: type: integer example: 2 default: 0 max: type: integer example: 0 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: '' defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: {} calories: {} caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array subProducts: type: array beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array modifierGroups: type: object properties: 648c251ebb2163a8cebc1137: type: object properties: id: type: string example: 648c251ebb2163a8cebc1137 plu: type: string example: MG-TO-QeOs-2 name: type: string example: Toppings productType: type: integer example: 3 default: 0 max: type: integer example: 5 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: '' defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: {} calories: {} caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array subProducts: type: array items: type: string example: 648c24f842c8fee99960fc05 beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array bundles: type: object properties: 649abede949cfa36470e3326: type: object properties: id: type: string example: 649abede949cfa36470e3326 plu: type: string example: P-meal-deal-1 name: type: string example: Pizza 1 productType: type: integer example: 4 default: 0 max: type: integer example: 1 default: 0 min: type: integer example: 1 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: '' defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: {} calories: {} caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array subProducts: type: array items: type: string example: 663c976df7d1fb0d85dc96c5 beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array 649abefeb99c55cfcbf181c6: type: object properties: id: type: string example: 649abefeb99c55cfcbf181c6 plu: type: string example: B-PI-qEtO-2 name: type: string example: Pizza 2 productType: type: integer example: 4 default: 0 max: type: integer example: 1 default: 0 min: type: integer example: 1 default: 0 multiply: type: integer example: 1 default: 0 description: type: string example: '' defaultQuantity: {} isVariant: {} account: type: string example: 64872839172e0e6d2cedaa48 referenceId: {} calories: {} caloriesRangeHigh: {} nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array subProducts: type: array items: type: string example: 663c976df7d1fb0d85dc96c6 beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} subProductSortOrder: type: array '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/baskets: post: tags: - Baskets summary: Deliverect Create Basket description: This endpoint creates a Basket for the store. operationId: commerce_channel_api_baskets_create_basket parameters: - name: accountId in: path schema: type: string default: '' required: true description: The accountId value. example: 5b71c6489f00290d4 requestBody: content: application/json: schema: type: object required: - channelLinkId properties: channelLinkId: type: string description: ID of the store the basket is happening for. default: '' example: 5e8abc11dec0001a009b fulfillment: type: object required: - type properties: type: type: string default: pickup enum: - pickup - delivery - eatIn - dispatch example: pickup items: type: array items: properties: menuId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e plu: type: string default: 3F_COMBO example: 3F_COMBO quantity: type: integer default: 2 format: int32 example: 2 note: type: string example: No salad subItems: type: array items: properties: plu: type: string default: A_FRS example: A_FRS customizationPlu: type: string example: string quantity: type: integer default: 1 format: int32 example: 1 note: type: string example: No salad required: - plu - customizationPlu - quantity type: object required: - menuId - plu - quantity type: object customer: type: object properties: name: type: string example: Deliverect's Pizza Place companyName: type: string example: Deliverect's Pizza Place phoneNumber: type: string example: '+15555550123' email: type: string example: customer@example.com externalId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e tin: type: string example: string crmProfileId: type: string description: If the order is to be assigned to a CRM customer, this fields needs to have a valid crmProfileId. example: 609a1b2c3d4e5f6a7b8c9d0e examples: pickup: value: storeId: 67********************2c fulfillment: type: pickup time: YYYY-MM-DDTHH:mm:ss.SSSSSSZ items: - menuId: 62********************3w plu: PR1234 quantity: 2 note: extra salt please subItems: - plu: MOD123 customizationPlu: CATOPT3 quantity: 1 - menuId: 62********************3w plu: PR5678 quantity: 1 customer: name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' delivery: value: storeId: 67********************2c fulfillment: type: delivery address: line: 5030 W Lovers Ln, Dallas, TX 75209, US subpremise: Floor 1, Left Door street: 5030 W Lovers Ln area: Bluffview city: Dallas postalCode: '75209' stateOrProvince: TX country: US coordinates: - 32.850713 - -96.828014 note: first floor, left door, happy dog items: - menuId: 62********************3w plu: PR1234 quantity: 2 note: extra salt please subItems: - plu: MOD123 customizationPlu: CATOPT2 quantity: 1 - menuId: 62********************3w plu: PR5678 quantity: 1 customer: name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' eat-in: value: storeId: 67********************2c fulfillment: type: eatIn spot: table-5 items: - menuId: 62********************3w plu: PR1234 quantity: 2 note: extra salt please subItems: - plu: MOD123 customizationPlu: CATOPT2 quantity: 1 - menuId: 62********************3w plu: PR5678 quantity: 1 customer: name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' curbside: summary: curbside value: storeId: 67********************2c fulfillment: type: curbside time: YYYY-MM-DDTHH:mm:ss.SSSSSSZ pickupNotes: Yellow Honda items: - menuId: 62********************3w plu: PR1234 quantity: 2 note: extra salt please subItems: - plu: MOD123 customizationPlu: CATOPT3 quantity: 1 - menuId: 62********************3w plu: PR5678 quantity: 1 customer: name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' Group: summary: Group value: storeId: 67********************2c fulfillment: type: pickup time: YYYY-MM-DDTHH:mm:ss.SSSSSSZ items: [] group: customers: - role: host name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' - role: guest name: Patrick Doe companyName: ACME phoneNumber: '+3211223344' email: patrick.doe@acme.com externalId: crm-id-1235 tin: '123456790' customer: null responses: '200': description: '200' content: application/json: examples: OK: value: id: 65********************e2 channel: 10001 category: type: restaurant currency: USD taxExclusive: true status: open items: - id: 65********************27 menuId: 64********************7b plu: DRNK-01 name: Coca Cola quantity: 1 price: 219 gross: 219 taxes: - rate: 7000 name: GST amount: 15 net: 234 subItems: [] discounts: [] discountTotal: 0 - id: 65********************e2 menuId: 64********************7b plu: QS-01 name: Classic Quesadilla + Drink quantity: 1 price: 399 gross: 399 taxes: - rate: 7000 name: GST amount: 28 net: 427 subItems: - customizationPlu: MOD-01 plu: GR-CH name: Green Chillis quantity: 1 price: 0 subItems: [] - customizationPlu: INGR-1 plu: '645611577' name: No Onions quantity: 1 price: 0 subItems: - customizationPlu: SUB-01 plu: 654267959-655503030 name: Spring Onion quantity: 1 price: 0 subItems: [] discounts: [] discountTotal: 0 donations: [] payment: tips: [] donationTotal: 0 discountsTotal: 0 chargesTotal: 0 taxTotal: 43 tipTotal: 0 subTotal: 618 total: 661 customer: name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' crmProfileId: 67********************a8 fulfillment: type: delivery address: line: 8719 Avenue D, Brooklyn, NY, 11236, US street: 8719 Avenue D city: Brooklyn postalCode: '11236' stateOrProvince: NY country: US coordinates: - 40.6456946 - -73.9143276 note: first floor, left door, happy dog pickupNotes: Yellow Honda taxes: - name: GST amount: 43 discounts: [] charges: serviceCharge: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 type: fixed bagFee: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 deliveryFee: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 taxTotal: 0 netTotal: 0 grossTotal: 0 preparationTime: 0 preparationDelayTime: 0 created: YYYY-MM-DDTHH:mm:ss.SSSSSSZ updated: YYYY-MM-DDTHH:mm:ss.SSSSSSZ deleted: false etag: f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf accountId: 66********************d1 storeId: 67********************a8 channelLinkId: 67********************a8 summary: OK OK - Group: summary: OK - Group value: id: 65********************e2 channel: 20000 category: type: restaurant currency: USD taxExclusive: true status: open items: [] payment: tips: [] discountsTotal: 0 chargesTotal: 0 taxTotal: 56 tipTotal: 0 subTotal: 1016 total: 1065 group: customers: - id: 691327c5d367f4588f948201 role: host name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' - id: 691327c5d367f4588f948202 role: guest name: Patrick Doe companyName: ACME phoneNumber: '+3211223344' email: patrick.doe@acme.com externalId: crm-id-1235 tin: '123456790' customer: null fulfillment: type: pickup time: null pickupNotes: Yellow Honda taxes: - name: SALES_TAX amount: 49 discounts: [] charges: serviceCharge: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 type: fixed bagFee: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 deliveryFee: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 taxTotal: 0 netTotal: 0 grossTotal: 0 created: YYYY-MM-DDTHH:mm:ss.SSSSSSZ updated: YYYY-MM-DDTHH:mm:ss.SSSSSSZ deleted: false etag: f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf accountId: 66********************d1 storeId: 67********************a8 channelLinkId: 67********************a8 channelOrderId: null channelOrderDisplayId: null schema: type: object properties: id: type: string example: 65********************e2 channel: type: integer example: 20000 default: 0 category: type: object properties: type: type: string example: restaurant currency: type: string example: USD taxExclusive: type: boolean example: true default: true status: type: string example: open items: type: array items: type: object properties: {} payment: type: object properties: tips: type: array items: type: object properties: {} discountsTotal: type: integer example: 0 default: 0 chargesTotal: type: integer example: 0 default: 0 taxTotal: type: integer example: 56 default: 0 tipTotal: type: integer example: 0 default: 0 subTotal: type: integer example: 1016 default: 0 total: type: integer example: 1065 default: 0 group: type: object properties: customers: type: array items: type: object properties: id: type: string example: 691327c5d367f4588f948201 role: type: string example: host name: type: string example: John Doe companyName: type: string example: ACME phoneNumber: type: string example: '+3211223344' email: type: string example: john.doe@acme.com externalId: type: string example: crm-id-1234 tin: type: string example: '123456789' crmProfileId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e customer: type: object properties: name: type: string example: Deliverect's Pizza Place companyName: type: string example: Deliverect's Pizza Place phoneNumber: type: string example: '+15555550123' email: type: string example: customer@example.com externalId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e tin: type: string example: string crmProfileId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e fulfillment: type: object properties: type: type: string example: pickup time: {} pickupNotes: type: string example: Yellow Honda taxes: type: array items: type: object properties: name: type: string example: SALES_TAX amount: type: integer example: 49 default: 0 discounts: type: array items: type: object properties: {} charges: type: object properties: serviceCharge: type: object properties: value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 tax: type: integer example: 0 default: 0 net: type: integer example: 0 default: 0 type: type: string example: fixed bagFee: type: object properties: value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 tax: type: integer example: 0 default: 0 net: type: integer example: 0 default: 0 deliveryFee: type: object properties: value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 tax: type: integer example: 0 default: 0 net: type: integer example: 0 default: 0 taxTotal: type: integer example: 0 default: 0 netTotal: type: integer example: 0 default: 0 grossTotal: type: integer example: 0 default: 0 created: type: string example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ updated: type: string example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ deleted: type: boolean example: false default: true etag: type: string example: f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf accountId: type: string example: 66********************d1 storeId: type: string example: 67********************a8 channelLinkId: type: string example: 67********************a8 channelOrderId: {} channelOrderDisplayId: {} '422': content: application/json: schema: type: object properties: code: type: string example: string message: type: string example: string context: type: object properties: menuId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e plu: type: string example: PIE1 required: - plu - menuId required: - code - context - message examples: Unprocessable Entity (busy mode): summary: Unprocessable Entity (busy mode) value: code: store_paused message: Store is currently paused and cannot accept ASAP orders. context: {} traceId: 29441889ccd7213e Unprocessable Entity (product(s) snoozed): summary: Unprocessable Entity (product(s) snoozed) value: code: product_snoozed message: Product is currently snoozed context: menuId: 63********************b5 plu: '123' description: Unprocessable Entity deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/baskets/{basketId}: get: tags: - Baskets summary: Deliverect Get Basket description: Deliverect Get Basket operationId: commerce_channel_api_baskets_get_basket parameters: - name: accountId in: path schema: type: string required: true description: The accountId value. example: 5b71c6489f00290d4 - name: basketId in: path schema: type: string required: true description: The basketId value. example: 609a1b2c3d4e5f6a7b8c9d0e responses: '200': description: '200' content: application/json: examples: Result: value: id: 6643782d0c1914c93a846834 created: '2024-05-14T14:41:49.738000+00:00' updated: '2024-05-14T14:41:49.754000+00:00' deleted: false etag: f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf accountId: 65c35d109a19b819b7cf78d8 storeId: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 channelOrderId: null channelOrderDisplayId: null currency: EUR taxExclusive: false status: open items: - menuId: 62d7f77f64c95193cc29aa91 plu: STK-01 name: Delicious Steak Frites quantity: 2 note: extra salt please price: 1500 gross: 3800 taxes: [] net: 3800 subItems: - customizationPlu: MOD-01 plu: DRNK-01 name: Coca Cola quantity: 1 price: 400 subItems: [] discounts: [] discountTotal: 0 - menuId: 62d7f77f64c95193cc29aa91 plu: STK-01 name: Delicious Steak Frites quantity: 1 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 payment: tips: [] discountsTotal: 0 chargesTotal: 0 taxTotal: 0 tipTotal: 0 total: 5300 customer: name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 fulfillment: type: pickup charges: taxTotal: 0 netTotal: 0 grossTotal: 0 serviceCharge: type: fixed value: 0 taxRate: 0 gross: 0 bagFee: type: fixed value: 0 taxRate: 0 gross: 0 deliveryFee: type: fixed value: 0 taxRate: 0 gross: 0 taxes: [] discounts: [] schema: type: object properties: id: type: string example: 6643782d0c1914c93a846834 created: type: string example: '2024-05-14T14:41:49.738000+00:00' updated: type: string example: '2024-05-14T14:41:49.754000+00:00' deleted: type: boolean example: false default: true etag: type: string example: f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf accountId: type: string example: 65c35d109a19b819b7cf78d8 storeId: type: string example: 65eee6a9984a1bc1b9637c59 channelOrderId: {} channelOrderDisplayId: {} currency: type: string example: EUR taxExclusive: type: boolean example: false default: true status: type: string example: open items: type: array items: type: object properties: menuId: type: string example: 62d7f77f64c95193cc29aa91 plu: type: string example: STK-01 name: type: string example: Delicious Steak Frites quantity: type: integer example: 2 default: 0 note: type: string example: extra salt please price: type: integer example: 1500 default: 0 gross: type: integer example: 3800 default: 0 taxes: type: array net: type: integer example: 3800 default: 0 subItems: type: array items: type: object properties: customizationPlu: type: string example: MOD-01 plu: type: string example: DRNK-01 name: type: string example: Coca Cola quantity: type: integer example: 1 default: 0 price: type: integer example: 400 default: 0 subItems: type: array discounts: type: array discountTotal: type: integer example: 0 default: 0 payment: type: object properties: tips: type: array discountsTotal: type: integer example: 0 default: 0 chargesTotal: type: integer example: 0 default: 0 taxTotal: type: integer example: 0 default: 0 tipTotal: type: integer example: 0 default: 0 total: type: integer example: 5300 default: 0 customer: type: object properties: name: type: string example: John Doe companyName: type: string example: ACME phoneNumber: type: string example: '+3211223344' email: type: string example: john.doe@acme.com externalId: type: string example: crm-id-1234 fulfillment: type: object properties: type: type: string example: pickup charges: type: object properties: taxTotal: type: integer example: 0 default: 0 netTotal: type: integer example: 0 default: 0 grossTotal: type: integer example: 0 default: 0 serviceCharge: type: object properties: type: type: string example: fixed value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 bagFee: type: object properties: type: type: string example: fixed value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 deliveryFee: type: object properties: type: type: string example: fixed value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 taxes: type: array discounts: type: array '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/v2/checkouts: post: tags: - Checkout summary: Deliverect Checkout Basket description: Creates a checkout session from a basket, leading to a payment intent based on the provided gateway. operationId: post_commerce_accountId_checkouts_1 parameters: - name: accountId in: path schema: type: string default: 668e4aa170efd23c474b2ad1 required: true description: The accountId value. example: 668e4aa170efd23c474b2ad1 requestBody: content: application/json: schema: type: object required: - basket - payments properties: basket: type: object required: - id properties: id: type: string example: 609a1b2c3d4e5f6a7b8c9d0e note: type: string example: No salad payments: type: array items: properties: type: type: string default: dpay enum: - dpay - third_party - gift_card example: dpay externalId: type: string default: '' description: id of the payment provider example: 609a1b2c3d4e5f6a7b8c9d0e isPrepaid: type: boolean default: 'true' description: indicates whether the order has been paid. For Dpay it should be true. example: 'true' amount: type: integer default: '' description: total amount paid with 2 decimal digits. 800 would correspond to 8 in local currency example: 1250 metadata: type: object properties: {} type: object required: - type - externalId - isPrepaid - amount order: type: object properties: channelOrderId: type: string description: The full unique ID from the ordering channel, cannot be reused within 48hr after pickup (across all accounts) example: 609a1b2c3d4e5f6a7b8c9d0e channelOrderDisplayId: type: string description: A more human‑readable order reference to provide, usually shorter than the channelOrderId example: 609a1b2c3d4e5f6a7b8c9d0e validationId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e courier: type: string example: string examples: Deliverect Pay: summary: Deliverect Pay value: basket: id: '{{commerceBasketId}}' order: channelOrderId: '{{uuid}}' channelOrderDisplayId: DISPLAY-{{uuid}} note: ORDER LEVEL NOTE payments: - type: dpay externalId: 68a4*****0616cad5144 isPrepaid: true amount: 900 metadata: {} Gift Card: summary: Gift Card value: "{\n \"basket\": {\n \"id\": \"{{commerceBasketId}}\"\n },\n \"order\": {\n \"channelOrderId\": \"{{uuid}}\",\n \"channelOrderDisplayId\": \"DISPLAY-{{uuid}}\"\ \n },\n \"note\": \"ORDER LEVEL NOTE\",\n \"payments\": [\n {\n \"type\": \"gift_card\",\n \"externalId\": \"{{guid}}\",\n \"isPrepaid\": true,\n \ \ \"amount\": 900,\n \"metadata\": {\n \"giftCardProviderProfileLinkId\": \"68656743e24307aece89862e\",\n \"giftCardNumber\": \"6000101001050148\",\n \ \ \"giftCardVerificationCode\": \"528811\"\n }\n }\n ]\n }\n}" Third Party: summary: Third Party value: " {\n \"basket\": {\n \"id\": \"{{commerceBasketId}}\"\n },\n \"order\": {\n \"channelOrderId\": \"{{uuid}}\",\n \"channelOrderDisplayId\": \"DISPLAY-{{uuid}}\"\ \n },\n \"note\": \"ORDER LEVEL NOTE\",\n \"payments\": [\n {\n \"type\": \"third_party\",\n \"externalId\": \"{{$guid}}\",\n \"instrumentType\":\"card\"\ ,\n \"isPrepaid\": true,\n \"amount\": 900,\n \"metadata\": {}\n }\n ]\n }\n}" Multiple Payments: summary: Multiple Payments value: "{\n \"basket\": {\n \"id\": \"{{commerceBasketId}}\"\n },\n \"order\": {\n \"channelOrderId\": \"{{uuid}}\",\n \"channelOrderDisplayId\": \"{{uuid}}\"\n \ \ },\n \"note\": \"ORDER LEVEL NOTE\",\n \"payments\": [\n {\n \"type\": \"dpay\",\n \"externalId\": \"68a4505c7dded0616cad5144\",\n \"isPrepaid\": false,\n\ \ \"amount\": 300,\n \"metadata\": {}\n },\n {\n \"type\": \"gift_card\",\n \"externalId\": \"{{$guid}}\",\n \"isPrepaid\": true,\n \ \ \"amount\": 300,\n \"metadata\": {\n \"giftCardProviderProfileLinkId\": \"68656743e24307aece89862e\",\n \"giftCardNumber\": \"6000101001050148\",\n \ \ \"giftCardVerificationCode\": \"528811\"\n }\n },\n {\n \"type\": \"third_party\",\n \"externalId\": \"{{$guid}}\",\n \"isPrepaid\": true,\n \ \ \"instrumentType\":\"card\",\n \"amount\": 300,\n \"metadata\": {}\n }\n ]\n }\n}" responses: '200': description: '200' content: application/json: examples: offline: value: id: 694138133662b46bddf06e70 created: '2025-12-16T10:44:35.107000' updated: '2025-12-16T10:44:51.016000+00:00' deleted: false etag: 2e94b59d6155094830af3362502fddc0cd51ef2f accountId: 668cd58b6da5e4cec26f1f35 channelLinkId: 6911e9be1531637e9cf80a5f storeId: 6911e9be1531637e9cf80a5f status: open failureReason: null basket: id: 694138103662b46bddf06e6e channel: 10165 category: type: restaurant currency: AED taxExclusive: false status: open items: - id: 694138103662b46bddf06e6f menuId: 6882366cf04ece702e6661c8 plu: STK-01 name: Delicious Steak Frites quantity: 1 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: - customizationPlu: MOD-01 plu: COOK-01 name: Rare quantity: 1 price: 0 subItems: [] note: null - customizationPlu: MOD-02 plu: SI-01 name: Fries quantity: 1 price: 0 subItems: [] note: null discounts: [] discountTotal: 0 note: ITEM LEVEL NOTE payment: tips: [] discountsTotal: 0 chargesTotal: 0 taxTotal: 0 tipTotal: 0 subTotal: 1500 total: 1500 customer: name: John Doe companyName: ACME phoneNumber: '+32474081356' email: john.doe@acme.com externalId: custom_channel_id_12345 loyaltyProviderCustomerId: null tin: null fulfillment: type: eatIn spot: TABLE-1 taxes: [] discounts: [] charges: serviceCharge: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 type: fixed bagFee: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 deliveryFee: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 taxTotal: 0 netTotal: 0 grossTotal: 0 payment: id: 694138133662b46bddf06e71 gateway: 1 status: authorized action: type: offline paid: true metadata: {} order: channelOrderId: 5f6fb9fa-71ad-4758-8118-b9966d950105 channelOrderDisplayId: 5f6fb9fa status: null redirect: value: id: 6643861d0c1914c93a846b78 created: '2024-05-14T15:41:17.518000+00:00' updated: '2024-05-14T15:41:18.449000+00:00' deleted: false etag: f225b232489659ed4dc0f17580f4f0200f4ca3ba accountId: 65c35d109a19b819b7cf78d8 storeId: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 status: open basket: currency: EUR taxExclusive: false items: - menuId: 62d7f77f64c95193cc29aa91 plu: STK-01 name: Delicious Steak Frites quantity: 1 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 payment: tips: - amount: 100 type: restaurant discountsTotal: 0 taxTotal: 0 tipTotal: 100 total: 1600 customer: name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com tin: '123456789' fulfillment: type: pickup taxes: [] discounts: [] payment: id: 62d7f77f64c95193cc29aa91 status: pending action: type: redirect url: http://payment.acme.com/1234 order: null schema: type: object properties: id: type: string example: 6643861d0c1914c93a846b78 created: type: string example: '2024-05-14T15:41:17.518000+00:00' updated: type: string example: '2024-05-14T15:41:18.449000+00:00' deleted: type: boolean example: false default: true etag: type: string example: f225b232489659ed4dc0f17580f4f0200f4ca3ba accountId: type: string example: 65c35d109a19b819b7cf78d8 storeId: type: string example: 65eee6a9984a1bc1b9637c59 status: type: string example: open basket: type: object properties: currency: type: string example: EUR taxExclusive: type: boolean example: false default: true items: type: array items: type: object properties: menuId: type: string example: 62d7f77f64c95193cc29aa91 plu: type: string example: STK-01 name: type: string example: Delicious Steak Frites quantity: type: integer example: 1 default: 0 price: type: integer example: 1500 default: 0 gross: type: integer example: 1500 default: 0 taxes: type: array net: type: integer example: 1500 default: 0 subItems: type: array discounts: type: array discountTotal: type: integer example: 0 default: 0 payment: type: object properties: tips: type: array items: type: object properties: amount: type: integer example: 100 default: 0 type: type: string example: restaurant discountsTotal: type: integer example: 0 default: 0 taxTotal: type: integer example: 0 default: 0 tipTotal: type: integer example: 100 default: 0 total: type: integer example: 1600 default: 0 customer: type: object properties: name: type: string example: John Doe companyName: type: string example: ACME phoneNumber: type: string example: '+3211223344' email: type: string example: john.doe@acme.com tin: type: string example: string fulfillment: type: object properties: type: type: string example: pickup enum: - pickup - delivery - dispatch taxes: type: array discounts: type: array payments: type: array items: properties: id: type: string example: 609a1b2c3d4e5f6a7b8c9d0e type: type: string enum: - dpay - third_party - gift_card example: dpay isPrepaid: type: boolean enum: - true - false example: true amount: type: string example: string status: type: string example: confirmed type: object order: type: object properties: channelOrderId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e channelOrderDisplayId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e '422': description: '422' content: application/json: examples: payment_amount_mismatch: value: code: payment_amount_mismatch message: Total of payments does not match basket payment total context: paymentsTotal: 856 basketTotal: 854 summary: payment_amount_mismatch schema: type: object properties: code: type: string default: '' example: string message: type: string default: '' example: string context: type: object properties: paymentsTotal: type: integer default: '' example: 1250 basketTotal: type: integer default: '' example: 1250 required: - code x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/v2/checkouts/{checkoutId}: get: tags: - Checkout summary: Deliverect Get Checkout description: Returns a checkout session by ID. This can be used to poll the status of a checkout session providing order placement details. operationId: get_commerce_accountId_checkouts_checkoutId_1 parameters: - name: accountId in: path schema: type: string required: true description: The accountId value. example: 5b71c6489f00290d4 - name: checkoutId in: path schema: type: string required: true description: The checkoutId value. example: 609a1b2c3d4e5f6a7b8c9d0e responses: '200': description: '200' content: application/json: examples: completed: value: id: 6643861d0c1914c93a846b78 created: '2024-05-14T15:41:17.518000+00:00' updated: '2024-05-14T15:41:18.449000+00:00' deleted: false etag: f225b232489659ed4dc0f17580f4f0200f4ca3ba accountId: 65c35d109a19b819b7cf78d8 storeId: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 status: completed basket: currency: EUR taxExclusive: false items: - menuId: 62d7f77f64c95193cc29aa91 plu: STK-01 name: Delicious Steak Frites quantity: 1 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 payment: tips: - amount: 100 type: restaurant discountsTotal: 0 taxTotal: 0 tipTotal: 100 total: 1600 customer: name: Test companyName: Company LTDA phoneNumber: '12345' email: test@email.com tin: '123456789' fulfillment: type: pickup taxes: [] discounts: [] payment: id: 62d7f77f64c95193cc29aa91 status: authorized action: type: redirect url: http://payment.acme.com/1234 order: channelOrderId: 6643861d0c1914c93a846b79 channelOrderDisplayId: '01277571' pending payment: value: id: 6643861d0c1914c93a846b78 created: '2024-05-14T15:41:17.518000+00:00' updated: '2024-05-14T15:41:18.449000+00:00' deleted: false etag: f225b232489659ed4dc0f17580f4f0200f4ca3ba accountId: 65c35d109a19b819b7cf78d8 storeId: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 status: open basket: currency: EUR taxExclusive: false items: - menuId: 62d7f77f64c95193cc29aa91 plu: STK-01 name: Delicious Steak Frites quantity: 1 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 payment: tips: - amount: 100 type: restaurant discountsTotal: 0 taxTotal: 0 tipTotal: 100 total: 1600 customer: name: Test companyName: Company LTDA phoneNumber: '12345' email: test@email.com tin: '123456789' fulfillment: type: pickup taxes: [] discounts: [] payment: id: 62d7f77f64c95193cc29aa91 status: pending action: type: redirect url: http://payment.acme.com/1234 order: null refused payment: value: id: 6643861d0c1914c93a846b78 created: '2024-05-14T15:41:17.518000+00:00' updated: '2024-05-14T15:41:18.449000+00:00' deleted: false etag: f225b232489659ed4dc0f17580f4f0200f4ca3ba accountId: 65c35d109a19b819b7cf78d8 storeId: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 status: open basket: currency: EUR taxExclusive: false items: - menuId: 62d7f77f64c95193cc29aa91 plu: STK-01 name: Delicious Steak Frites quantity: 1 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 payment: tips: - amount: 100 type: restaurant discountsTotal: 0 taxTotal: 0 tipTotal: 100 total: 1600 customer: name: Test companyName: Company LTDA phoneNumber: '12345' email: test@email.com tin: '123456789' fulfillment: type: pickup taxes: [] discounts: [] payment: id: 62d7f77f64c95193cc29aa91 status: refused action: type: redirect url: http://payment.acme.com/1234 order: null failed payment: value: id: 6643861d0c1914c93a846b78 created: '2024-05-14T15:41:17.518000+00:00' updated: '2024-05-14T15:41:18.449000+00:00' deleted: false etag: f225b232489659ed4dc0f17580f4f0200f4ca3ba accountId: 65c35d109a19b819b7cf78d8 storeId: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 status: failed basket: currency: EUR taxExclusive: false items: - menuId: 62d7f77f64c95193cc29aa91 plu: STK-01 name: Delicious Steak Frites quantity: 1 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 payment: tips: - amount: 100 type: restaurant discountsTotal: 0 taxTotal: 0 tipTotal: 100 total: 1600 customer: name: Test companyName: Company LTDA phoneNumber: '12345' email: test@email.com tin: '123456789' fulfillment: type: pickup taxes: [] discounts: [] payment: id: 62d7f77f64c95193cc29aa91 status: failed action: null order: null schema: oneOf: - title: completed type: object properties: id: type: string example: 6643861d0c1914c93a846b78 created: type: string example: '2024-05-14T15:41:17.518000+00:00' updated: type: string example: '2024-05-14T15:41:18.449000+00:00' deleted: type: boolean example: false default: true etag: type: string example: f225b232489659ed4dc0f17580f4f0200f4ca3ba accountId: type: string example: 65c35d109a19b819b7cf78d8 storeId: type: string example: 65eee6a9984a1bc1b9637c59 status: type: string example: completed basket: type: object properties: currency: type: string example: EUR taxExclusive: type: boolean example: false default: true items: type: array items: type: object properties: menuId: type: string example: 62d7f77f64c95193cc29aa91 plu: type: string example: STK-01 name: type: string example: Delicious Steak Frites quantity: type: integer example: 1 default: 0 price: type: integer example: 1500 default: 0 gross: type: integer example: 1500 default: 0 taxes: type: array net: type: integer example: 1500 default: 0 subItems: type: array discounts: type: array discountTotal: type: integer example: 0 default: 0 payment: type: object properties: tips: type: array items: type: object properties: amount: type: integer example: 100 default: 0 type: type: string example: restaurant discountsTotal: type: integer example: 0 default: 0 taxTotal: type: integer example: 0 default: 0 tipTotal: type: integer example: 100 default: 0 total: type: integer example: 1600 default: 0 customer: type: object properties: name: type: string example: Test companyName: type: string example: Company LTDA phoneNumber: type: string example: '12345' email: type: string example: test@email.com tin: type: string fulfillment: type: object properties: type: type: string example: pickup taxes: type: array discounts: type: array payment: type: object properties: id: type: string example: 62d7f77f64c95193cc29aa91 status: type: string example: authorized action: type: object properties: type: type: string example: redirect url: type: string example: http://payment.acme.com/1234 order: type: object properties: channelOrderId: type: string example: 6643861d0c1914c93a846b79 channelOrderDisplayId: type: string example: '01277571' - title: pending payment type: object properties: id: type: string example: 6643861d0c1914c93a846b78 created: type: string example: '2024-05-14T15:41:17.518000+00:00' updated: type: string example: '2024-05-14T15:41:18.449000+00:00' deleted: type: boolean example: false default: true etag: type: string example: f225b232489659ed4dc0f17580f4f0200f4ca3ba accountId: type: string example: 65c35d109a19b819b7cf78d8 storeId: type: string example: 65eee6a9984a1bc1b9637c59 status: type: string example: open basket: type: object properties: currency: type: string example: EUR taxExclusive: type: boolean example: false default: true items: type: array items: type: object properties: menuId: type: string example: 62d7f77f64c95193cc29aa91 plu: type: string example: STK-01 name: type: string example: Delicious Steak Frites quantity: type: integer example: 1 default: 0 price: type: integer example: 1500 default: 0 gross: type: integer example: 1500 default: 0 taxes: type: array net: type: integer example: 1500 default: 0 subItems: type: array discounts: type: array discountTotal: type: integer example: 0 default: 0 payment: type: object properties: tips: type: array items: type: object properties: amount: type: integer example: 100 default: 0 type: type: string example: restaurant discountsTotal: type: integer example: 0 default: 0 taxTotal: type: integer example: 0 default: 0 tipTotal: type: integer example: 100 default: 0 total: type: integer example: 1600 default: 0 customer: type: object properties: name: type: string example: Test companyName: type: string example: Company LTDA phoneNumber: type: string example: '12345' email: type: string example: test@email.com tin: type: string fulfillment: type: object properties: type: type: string example: pickup taxes: type: array discounts: type: array payment: type: object properties: id: type: string example: 62d7f77f64c95193cc29aa91 status: type: string example: pending action: type: object properties: type: type: string example: redirect url: type: string example: http://payment.acme.com/1234 order: {} - title: failed payment type: object properties: id: type: string example: 6643861d0c1914c93a846b78 created: type: string example: '2024-05-14T15:41:17.518000+00:00' updated: type: string example: '2024-05-14T15:41:18.449000+00:00' deleted: type: boolean example: false default: true etag: type: string example: f225b232489659ed4dc0f17580f4f0200f4ca3ba accountId: type: string example: 65c35d109a19b819b7cf78d8 storeId: type: string example: 65eee6a9984a1bc1b9637c59 status: type: string example: failed basket: type: object properties: currency: type: string example: EUR taxExclusive: type: boolean example: false default: true items: type: array items: type: object properties: menuId: type: string example: 62d7f77f64c95193cc29aa91 plu: type: string example: STK-01 name: type: string example: Delicious Steak Frites quantity: type: integer example: 1 default: 0 price: type: integer example: 1500 default: 0 gross: type: integer example: 1500 default: 0 taxes: type: array net: type: integer example: 1500 default: 0 subItems: type: array discounts: type: array discountTotal: type: integer example: 0 default: 0 payment: type: object properties: tips: type: array items: type: object properties: amount: type: integer example: 100 default: 0 type: type: string example: restaurant discountsTotal: type: integer example: 0 default: 0 taxTotal: type: integer example: 0 default: 0 tipTotal: type: integer example: 100 default: 0 total: type: integer example: 1600 default: 0 customer: type: object properties: name: type: string example: Test companyName: type: string example: Company LTDA phoneNumber: type: string example: '12345' email: type: string example: test@email.com tin: type: string fulfillment: type: object properties: type: type: string example: pickup taxes: type: array discounts: type: array payment: type: object properties: id: type: string example: 62d7f77f64c95193cc29aa91 status: type: string example: failed action: {} order: {} '400': description: '400' content: application/json: examples: bad request: value: '' deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/baskets/{basketId}/validate: post: description: Deliverect Post_commerce_accountid_baskets_basketid_validate responses: '200': description: '' content: application/json: examples: OK: summary: OK value: id: 65********************e2 channel: 20000 category: type: restaurant currency: USD taxExclusive: true status: open items: - id: 65********************27 menuId: 64********************7b plu: QS-01 name: Classic Quesadilla + Drink note: as much cheese as possible! quantity: 1 price: 529 gross: 698 taxes: - rate: 7000 name: GST amount: 49 net: 747 subItems: - customizationPlu: MOD-01 plu: DRNK-01 name: Coca Cola quantity: 1 price: 169 note: Extra cold please subItems: [] discounts: [] discountTotal: 0 - id: 691327c5d367f4588f9482fb menuId: 6902550da160cca419af2469 plu: '645611577' name: Chocolate Chip Cookie quantity: 2 price: 159 gross: 318 taxes: [] net: 318 subItems: [] discounts: [] discountTotal: 0 note: In seperate bag please payment: tips: [] discountsTotal: 0 chargesTotal: 0 taxTotal: 56 tipTotal: 0 subTotal: 1016 total: 1065 customer: name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' fulfillment: type: pickup time: null taxes: - name: SALES_TAX amount: 49 discounts: [] charges: serviceCharge: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 type: fixed bagFee: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 deliveryFee: value: 0 taxRate: 0 gross: 0 tax: 0 net: 0 taxTotal: 0 netTotal: 0 grossTotal: 0 created: YYYY-MM-DDTHH:mm:ss.SSSSSSZ updated: YYYY-MM-DDTHH:mm:ss.SSSSSSZ deleted: false etag: f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf accountId: 66********************d1 storeId: 67********************a8 channelLinkId: 67********************a8 channelOrderId: null channelOrderDisplayId: null schema: type: object properties: id: type: string example: 65********************e2 channel: type: integer example: 20000 default: 0 category: type: object properties: type: type: string example: restaurant currency: type: string example: USD taxExclusive: type: boolean example: true default: true status: type: string example: open items: type: array items: type: object properties: id: type: string example: 65********************27 menuId: type: string example: 64********************7b plu: type: string example: QS-01 name: type: string example: Classic Quesadilla + Drink note: type: string example: as much cheese as possible! quantity: type: integer example: 1 default: 0 price: type: integer example: 529 default: 0 gross: type: integer example: 698 default: 0 taxes: type: array items: type: object properties: rate: type: integer example: 7000 default: 0 name: type: string example: GST amount: type: integer example: 49 default: 0 net: type: integer example: 747 default: 0 subItems: type: array items: type: object properties: customizationPlu: type: string example: MOD-01 plu: type: string example: DRNK-01 name: type: string example: Coca Cola quantity: type: integer example: 1 default: 0 price: type: integer example: 169 default: 0 note: type: string example: Extra cold please subItems: type: array items: type: object properties: {} discounts: type: array items: type: object properties: {} discountTotal: type: integer example: 0 default: 0 payment: type: object properties: tips: type: array items: type: object properties: {} discountsTotal: type: integer example: 0 default: 0 chargesTotal: type: integer example: 0 default: 0 taxTotal: type: integer example: 56 default: 0 tipTotal: type: integer example: 0 default: 0 subTotal: type: integer example: 1016 default: 0 total: type: integer example: 1065 default: 0 customer: type: object properties: name: type: string example: John Doe companyName: type: string example: ACME phoneNumber: type: string example: '+3211223344' email: type: string example: john.doe@acme.com externalId: type: string example: crm-id-1234 tin: type: string example: '123456789' fulfillment: type: object properties: type: type: string example: pickup time: {} taxes: type: array items: type: object properties: name: type: string example: SALES_TAX amount: type: integer example: 49 default: 0 discounts: type: array items: type: object properties: {} charges: type: object properties: serviceCharge: type: object properties: value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 tax: type: integer example: 0 default: 0 net: type: integer example: 0 default: 0 type: type: string example: fixed bagFee: type: object properties: value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 tax: type: integer example: 0 default: 0 net: type: integer example: 0 default: 0 deliveryFee: type: object properties: value: type: integer example: 0 default: 0 taxRate: type: integer example: 0 default: 0 gross: type: integer example: 0 default: 0 tax: type: integer example: 0 default: 0 net: type: integer example: 0 default: 0 taxTotal: type: integer example: 0 default: 0 netTotal: type: integer example: 0 default: 0 grossTotal: type: integer example: 0 default: 0 created: type: string example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ updated: type: string example: YYYY-MM-DDTHH:mm:ss.SSSSSSZ deleted: type: boolean example: false default: true etag: type: string example: f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf accountId: type: string example: 66********************d1 storeId: type: string example: 67********************a8 channelLinkId: type: string example: 67********************a8 channelOrderId: {} channelOrderDisplayId: {} '422': content: application/json: schema: type: object properties: {} examples: Unprocessable Entity: summary: Unprocessable Entity value: code: product_snoozed message: Product is currently snoozed context: menuId: 63********************b5 plu: '123' description: Unprocessable Entity parameters: - in: path name: accountId schema: type: string required: true description: The accountId value. example: 5b71c6489f00290d4 - in: path name: basketId schema: type: string required: true description: The basketId value. example: 609a1b2c3d4e5f6a7b8c9d0e operationId: post_commerce_accountid_baskets_basketid_validate summary: Deliverect Post_commerce_accountid_baskets_basketid_validate tags: - Baskets x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/baskets/{basketId}/items: patch: tags: - Baskets summary: Deliverect Update Basket - Item(s) description: Deliverect Update Basket - Item(s) operationId: commerce_channel_api_baskets_update_basket_items parameters: - name: accountId in: path schema: type: string default: 668e4aa170efd23c474b2ad1 required: true description: The accountId value. example: 668e4aa170efd23c474b2ad1 - name: basketId in: path schema: type: string required: true description: The basketId value. example: 609a1b2c3d4e5f6a7b8c9d0e requestBody: content: application/json: schema: type: object properties: {} examples: commerce_channel_api_baskets_update_basket_items_request: summary: Default commerce_channel_api_baskets_update_basket_items request x-microcks-default: true value: {} responses: '200': description: '200' content: application/json: examples: Result: value: id: 663dff85512e27ec790fe713 created: '2024-05-10T11:05:41.194000+00:00' updated: '2024-05-10T11:05:41.226000+00:00' deleted: false etag: 4f95244e98557fec08e449e767afb340842cf4f2 accountId: 65c35d109a19b819b7cf78d8 storeId: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 channelOrderId: null channelOrderDisplayId: null currency: EUR taxExclusive: false status: open items: - plu: PLU-1 quantity: 1 note: extra salt please menuId: 662fa50c9ddcfc5397580587 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 - plu: PLU-2 quantity: 1 menuId: 662fa50c9ddcfc5397580587 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 - plu: PLU-3 quantity: 1 menuId: 662fa50c9ddcfc5397580587 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 payment: tips: [] discountsTotal: 0 taxTotal: 0 tipTotal: 0 total: 4500 customer: null fulfillment: type: pickup taxes: [] discounts: [] Group Basket: summary: Group Basket value: id: 663dff85512e27ec790fe713 created: '2024-05-10T11:05:41.194000+00:00' updated: '2024-05-10T11:05:41.226000+00:00' deleted: false etag: 4f95244e98557fec08e449e767afb340842cf4f2 accountId: 65c35d109a19b819b7cf78d8 storeId: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 channelOrderId: null channelOrderDisplayId: null currency: EUR taxExclusive: false status: open items: - plu: PLU-1 quantity: 1 note: extra salt please menuId: 662fa50c9ddcfc5397580587 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 customerId: 691327c5d367f4588f948201 - plu: PLU-2 quantity: 1 menuId: 662fa50c9ddcfc5397580587 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 customerId: 691327c5d367f4588f948201 - plu: PLU-3 quantity: 1 menuId: 662fa50c9ddcfc5397580587 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 customerId: 691327c5d367f4588f948202 group: customers: - id: 691327c5d367f4588f948201 role: host name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' - id: 691327c5d367f4588f948202 role: guest name: Patrick Doe companyName: ACME phoneNumber: '+3211223344' email: patrick.doe@acme.com externalId: crm-id-1235 tin: '123456790' customer: null payment: tips: [] discountsTotal: 0 taxTotal: 0 tipTotal: 0 total: 4500 fulfillment: type: pickup taxes: [] discounts: [] schema: type: object properties: id: type: string example: 663dff85512e27ec790fe713 created: type: string example: '2024-05-10T11:05:41.194000+00:00' updated: type: string example: '2024-05-10T11:05:41.226000+00:00' deleted: type: boolean example: false default: true etag: type: string example: 4f95244e98557fec08e449e767afb340842cf4f2 accountId: type: string example: 65c35d109a19b819b7cf78d8 storeId: type: string example: 65eee6a9984a1bc1b9637c59 channelOrderId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e channelOrderDisplayId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e currency: type: string example: EUR taxExclusive: type: boolean example: false default: true status: type: string example: open items: type: array items: type: object properties: plu: type: string example: PLU-1 quantity: type: integer example: 1 default: 0 note: type: string example: extra salt please menuId: type: string example: 662fa50c9ddcfc5397580587 price: type: integer example: 1500 default: 0 gross: type: integer example: 1500 default: 0 taxes: type: array net: type: integer example: 1500 default: 0 subItems: type: array discounts: type: array discountTotal: type: integer example: 0 default: 0 payment: type: object properties: tips: type: array discountsTotal: type: integer example: 0 default: 0 taxTotal: type: integer example: 0 default: 0 tipTotal: type: integer example: 0 default: 0 total: type: integer example: 4500 default: 0 customer: {} fulfillment: type: object properties: type: type: string example: pickup taxes: type: array discounts: type: array '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/baskets/{basketId}/customer: patch: tags: - Baskets summary: Deliverect Update Basket - Customer description: Deliverect Update Basket - Customer operationId: commerce_channel_api_baskets_update_basket_customer parameters: - name: accountId in: path schema: type: string default: 668e4aa170efd23c474b2ad1 required: true description: The accountId value. example: 668e4aa170efd23c474b2ad1 - name: basketId in: path schema: type: string required: true description: The basketId value. example: 609a1b2c3d4e5f6a7b8c9d0e requestBody: content: application/json: schema: type: object properties: name: type: string example: Deliverect's Pizza Place companyName: type: string example: Deliverect's Pizza Place email: type: string example: customer@example.com phoneNumber: type: string example: '+15555550123' externalId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e tin: type: string example: string examples: Sample Customer: value: name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' loyaltyProviderCustomerId: 17dh89 responses: '200': description: '200' content: application/json: examples: Result: value: id: 6643782d0c1914c93a846834 created: '2024-05-14T14:41:49.738000+00:00' updated: '2024-05-14T14:41:49.754000+00:00' deleted: false etag: f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf accountId: 65c35d109a19b819b7cf78d8 storeId: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 channelOrderId: null channelOrderDisplayId: null currency: EUR taxExclusive: false status: open items: - menuId: 62d7f77f64c95193cc29aa91 plu: STK-01 name: Delicious Steak Frites quantity: 2 price: 1500 gross: 3800 taxes: [] net: 3800 subItems: - customizationPlu: MOD-01 plu: DRNK-01 name: Coca Cola quantity: 1 price: 400 subItems: [] discounts: [] discountTotal: 0 - menuId: 62d7f77f64c95193cc29aa91 plu: STK-01 name: Delicious Steak Frites quantity: 1 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 payment: tips: [] discountsTotal: 0 taxTotal: 0 tipTotal: 0 total: 5300 customer: name: John Doe companyName: ACME phoneNumber: '+3211223344' email: john.doe@acme.com externalId: crm-id-1234 tin: '123456789' loyaltyProviderCustomerId: 17dh89 fulfillment: type: pickup taxes: [] discounts: [] schema: type: object properties: id: type: string example: 6643782d0c1914c93a846834 created: type: string example: '2024-05-14T14:41:49.738000+00:00' updated: type: string example: '2024-05-14T14:41:49.754000+00:00' deleted: type: boolean example: false default: true etag: type: string example: f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf accountId: type: string example: 65c35d109a19b819b7cf78d8 storeId: type: string example: 65eee6a9984a1bc1b9637c59 channelOrderId: {} channelOrderDisplayId: {} currency: type: string example: EUR taxExclusive: type: boolean example: false default: true status: type: string example: open items: type: array items: type: object properties: menuId: type: string example: 62d7f77f64c95193cc29aa91 plu: type: string example: STK-01 name: type: string example: Delicious Steak Frites quantity: type: integer example: 2 default: 0 price: type: integer example: 1500 default: 0 gross: type: integer example: 3800 default: 0 taxes: type: array net: type: integer example: 3800 default: 0 subItems: type: array items: type: object properties: customizationPlu: type: string example: MOD-01 plu: type: string example: DRNK-01 name: type: string example: Coca Cola quantity: type: integer example: 1 default: 0 price: type: integer example: 400 default: 0 subItems: type: array discounts: type: array discountTotal: type: integer example: 0 default: 0 payment: type: object properties: tips: type: array discountsTotal: type: integer example: 0 default: 0 taxTotal: type: integer example: 0 default: 0 tipTotal: type: integer example: 0 default: 0 total: type: integer example: 5300 default: 0 customer: type: object properties: name: type: string example: John Doe companyName: type: string example: ACME phoneNumber: type: string example: '+3211223344' email: type: string example: john.doe@acme.com externalId: type: string example: crm-id-1234 tin: type: string example: string loyaltyProviderCustomerId: type: string description: '' example: 609a1b2c3d4e5f6a7b8c9d0e fulfillment: type: object properties: type: type: string example: pickup taxes: type: array discounts: type: array '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/baskets/{basketId}/discounts: patch: tags: - Baskets summary: Deliverect Update Basket - Discount(s) description: Deliverect Update Basket - Discount(s) operationId: commerce_channel_api_baskets_update_basket_discounts parameters: - name: accountId in: path schema: type: string required: true description: The accountId value. example: 5b71c6489f00290d4 - name: basketId in: path schema: type: string required: true description: The basketId value. example: 609a1b2c3d4e5f6a7b8c9d0e requestBody: content: application/json: schema: type: array description: discounts items: type: object properties: type: type: string example: order_flat_off provider: type: string enum: - restaurant - coupon - loyalty example: coupon amount: type: integer format: int32 example: 100 value: type: integer format: int32 example: 1000 name: type: string example: CONGRATS! HERE IS 1 EUR OFF plu: type: string example: DLX-3 menuId: type: string example: 668f7ff64dc853**c96**877 externalId: type: string nullable: true example: discount-123 itemIds: type: array items: type: string example: string example: - 6900f2f01306779be71e7b8e required: - type - provider examples: order_flat_off: value: - type: order_flat_off provider: coupon amount: 100 name: CONGRATS! HERE IS 1 EUR OFF order_percent_off: value: - type: order_percent_off provider: restaurant value: 1000 name: CONGRATS10% OFF item_free: value: - provider: restaurant name: Free coke type: item_free plu: DLX-3 menuId: 69d4c198e1c58591f461cb4a externalId: discount-123 item_bogof: value: - provider: restaurant name: '' type: item_bogof plu: DLX-3 menuId: 69d4c198e1c58591f461cb4a externalId: discount-bogo item_flat_off: summary: item_flat_off value: - type: item_flat_off provider: restaurant externalId: discount-item-flat-123 name: 'Item flat off: $5' menuId: 668f7ff64dc853**c96**877 value: 5000 itemIds: - 6900f2f01306779be71e7b8e item_percent_off: summary: item_percent_off value: - type: item_percent_off provider: restaurant externalId: discount-123 name: 'Item percent off: 25%' menuId: 69d4c198e1c58591f461cb4a value: 2500 itemIds: - 6900f2f01306779be71e7b8e wallet_cash: summary: wallet_cash value: - type: wallet_cash value: 1000 provider: loyalty externalId: null compensation_card: summary: compensation_card value: - type: compensation_card provider: restaurant externalId: cardnumber-123 value: 5000 name: Compensation card for $5 responses: '200': description: '200' content: application/json: examples: Result: value: id: 6643782d0c1914c93a846834 created: '2024-05-14T14:41:49.738000+00:00' updated: '2024-05-14T15:19:37.173000+00:00' deleted: false etag: c2046a6b9c21b9ebb38f8094c0a3ca02240742b3 accountId: 65c35d109a19b819b7cf78d8 storeId: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 channelOrderId: null channelOrderDisplayId: null currency: EUR taxExclusive: false status: open items: - menuId: 62d7f77f64c95193cc29aa91 plu: STK-01 name: Delicious Steak Frites quantity: 1 price: 1500 gross: 1500 taxes: [] net: 1450 subItems: [] discounts: - referenceId: 1 amount: 50 discountTotal: 50 payment: tips: [] discountsTotal: 50 taxTotal: 0 tipTotal: 0 total: 1450 customer: name: Test companyName: Company LTDA phoneNumber: '12345' email: test@email.com fulfillment: type: pickup taxes: [] discounts: - type: order_flat_off referenceId: 1 amount: 50 provider: restaurant name: CONGRATS! HERE'S 5 EUR OFF schema: type: object properties: id: type: string example: 6643782d0c1914c93a846834 created: type: string example: '2024-05-14T14:41:49.738000+00:00' updated: type: string example: '2024-05-14T15:19:37.173000+00:00' deleted: type: boolean example: false default: true etag: type: string example: c2046a6b9c21b9ebb38f8094c0a3ca02240742b3 accountId: type: string example: 65c35d109a19b819b7cf78d8 storeId: type: string example: 65eee6a9984a1bc1b9637c59 channelLinkId: type: string example: 65eee6a9984a1bc1b9637c59 channelOrderId: {} channelOrderDisplayId: {} currency: type: string example: EUR taxExclusive: type: boolean example: false default: true status: type: string example: open items: type: array items: type: object properties: menuId: type: string example: 62d7f77f64c95193cc29aa91 plu: type: string example: STK-01 name: type: string example: Delicious Steak Frites quantity: type: integer example: 1 default: 0 price: type: integer example: 1500 default: 0 gross: type: integer example: 1500 default: 0 taxes: type: array items: type: object properties: {} net: type: integer example: 1450 default: 0 subItems: type: array items: type: object properties: {} discounts: type: array items: type: object properties: referenceId: type: integer example: 1 default: 0 amount: type: integer example: 50 default: 0 discountTotal: type: integer example: 50 default: 0 payment: type: object properties: tips: type: array items: type: object properties: {} discountsTotal: type: integer example: 50 default: 0 taxTotal: type: integer example: 0 default: 0 tipTotal: type: integer example: 0 default: 0 total: type: integer example: 1450 default: 0 customer: type: object properties: name: type: string example: Test companyName: type: string example: Company LTDA phoneNumber: type: string example: '12345' email: type: string example: test@email.com fulfillment: type: object properties: type: type: string example: pickup taxes: type: array items: type: object properties: {} discounts: type: array items: type: object properties: type: type: string example: order_flat_off referenceId: type: integer example: 1 default: 0 amount: type: integer example: 50 default: 0 provider: type: string example: restaurant name: type: string example: CONGRATS! HERE'S 5 EUR OFF '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/baskets/{basketId}/payment: patch: description: Deliverect Patch_commerce_accountid_baskets_basketid_payment responses: '200': description: '' content: application/json: examples: OK: summary: OK value: id: 6643782d0c1914c93a846834 created: '2024-05-14T14:41:49.738000+00:00' updated: '2024-05-14T15:28:33.188000+00:00' deleted: false etag: d8ac2d392f6a89d80376174d19cbe84b8b65d637 accountId: 65c35d109a19b819b7cf78d8 storeId: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 channelOrderId: null channelOrderDisplayId: null currency: EUR taxExclusive: false status: open items: - menuId: 62d7f77f64c95193cc29aa91 plu: STK-01 name: Delicious Steak Frites quantity: 1 price: 1500 gross: 1500 taxes: [] net: 1500 subItems: [] discounts: [] discountTotal: 0 payment: tips: - amount: 100 type: restaurant discountsTotal: 0 taxTotal: 0 tipTotal: 100 total: 1600 customer: name: Test companyName: Company LTDA phoneNumber: '12345' email: test@email.com fulfillment: type: pickup taxes: [] discounts: [] schema: type: object properties: id: type: string example: 6643782d0c1914c93a846834 created: type: string example: '2024-05-14T14:41:49.738000+00:00' updated: type: string example: '2024-05-14T15:28:33.188000+00:00' deleted: type: boolean example: false default: true etag: type: string example: d8ac2d392f6a89d80376174d19cbe84b8b65d637 accountId: type: string example: 65c35d109a19b819b7cf78d8 storeId: type: string example: 65eee6a9984a1bc1b9637c59 channelLinkId: type: string example: 65eee6a9984a1bc1b9637c59 channelOrderId: {} channelOrderDisplayId: {} currency: type: string example: EUR taxExclusive: type: boolean example: false default: true status: type: string example: open items: type: array items: type: object properties: menuId: type: string example: 62d7f77f64c95193cc29aa91 plu: type: string example: STK-01 name: type: string example: Delicious Steak Frites quantity: type: integer example: 1 default: 0 price: type: integer example: 1500 default: 0 gross: type: integer example: 1500 default: 0 taxes: type: array items: type: object properties: {} net: type: integer example: 1500 default: 0 subItems: type: array items: type: object properties: {} discounts: type: array items: type: object properties: {} discountTotal: type: integer example: 0 default: 0 payment: type: object properties: tips: type: array items: type: object properties: amount: type: integer example: 100 default: 0 type: type: string example: restaurant discountsTotal: type: integer example: 0 default: 0 taxTotal: type: integer example: 0 default: 0 tipTotal: type: integer example: 100 default: 0 total: type: integer example: 1600 default: 0 customer: type: object properties: name: type: string example: Test companyName: type: string example: Company LTDA phoneNumber: type: string example: '12345' email: type: string example: test@email.com fulfillment: type: object properties: type: type: string example: pickup taxes: type: array items: type: object properties: {} discounts: type: array items: type: object properties: {} '400': content: application/json: schema: type: object properties: {} examples: Bad Request: summary: Bad Request value: '{}' description: Bad Request parameters: - in: path name: accountId schema: type: string default: '' required: true description: The accountId value. example: 5b71c6489f00290d4 - in: path name: basketId schema: type: string default: '' required: true description: The basketId value. example: 609a1b2c3d4e5f6a7b8c9d0e requestBody: content: application/json: schema: type: object properties: {} examples: Tips - Restaurant: summary: Tips - Restaurant value: tips: - amount: 100 type: restaurant Tips - Driver: summary: Tips - Driver value: tips: - amount: 100 type: driver operationId: patch_commerce_accountid_baskets_basketid_payment summary: Deliverect Patch_commerce_accountid_baskets_basketid_payment tags: - Baskets x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/baskets/{basketId}/store: patch: description: Deliverect Update Basket - Store responses: '200': description: '' content: application/json: examples: OK: summary: OK value: '{}' parameters: - in: path name: accountId schema: type: string required: true description: The accountId value. example: 5b71c6489f00290d4 - in: path name: basketId schema: type: string required: true description: The basketId value. example: 609a1b2c3d4e5f6a7b8c9d0e operationId: patch_commerce_accountid_baskets_basketid_store requestBody: content: application/json: schema: type: object properties: storeId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e required: - storeId examples: New Example: summary: New Example value: storeId: 67********************2c summary: Deliverect Update Basket - Store tags: - Baskets x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/stores: get: tags: - Stores summary: Deliverect Get Stores description: Returns the list of stores. A store represents a unique ordering experience from a specific location. operationId: commerce_channel_api_stores_get_stores parameters: - name: accountId in: path schema: type: string default: '' required: true description: The accountId value. example: 5b71c6489f00290d4 - name: page in: query description: Page to be returned schema: type: integer format: int32 default: 1 example: 1 - name: size in: query description: 'Number of stores to be returned per page - Max: 100' schema: type: integer format: int32 default: 50 example: 50 - name: latitude in: query description: Reference latitude coordinate to calculate store distance schema: type: number format: float default: 30.4515 example: 30.4515 - name: longitude in: query description: Reference longitude coordinate to calculate store distance schema: type: number format: float default: -91.1871 example: -91.1871 - name: sort in: query schema: type: string default: distance description: The sort value. example: distance - name: fulfillmentType in: query description: 'Fulfillment type(s) available on the channelLink. e.g: delivery,eatIn' schema: type: string example: string responses: '200': description: '200' content: application/json: examples: Result: value: total: 1 page: 1 size: 50 items: - id: 65eee6a9984a1bc1b9637c59 channelLinkId: 65eee6a9984a1bc1b9637c59 name: Store Name currency: EUR address: source: 1 Main street D13 R2P6 Ghent VOV coordinates: - 3.73398891371018 - 51.0311233802278 country: BE city: Ghent stateOrProvince: VOV openingHours: timezone: Europe/Brussels dayTimeRanges: - dayOfWeek: 1 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 2 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 3 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 4 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 5 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 6 startTime: 00:00:00 endTime: '23:59:00' - dayOfWeek: 7 startTime: 00:00:00 endTime: '23:59:00' distance: 1235 taxExclusive: false status: open channelLocationId: STORE0005 contact: firstName: John lastName: Doe phoneNumber: '+32411111111' email: john.doe@acme.com fulfillmentTypes: - pickup - delivery - eatIn schema: type: object properties: total: type: integer example: 1 default: 0 page: type: integer example: 1 default: 0 size: type: integer example: 50 default: 0 items: type: array items: type: object properties: id: type: string example: 65eee6a9984a1bc1b9637c59 channelLinkId: type: string example: 65eee6a9984a1bc1b9637c59 name: type: string example: Store Name currency: type: string example: EUR address: type: object properties: source: type: string example: 1 Main street D13 R2P6 Ghent VOV coordinates: type: array items: type: number example: 3.73398891371018 default: 0 country: type: string example: BE city: type: string example: Ghent stateOrProvince: type: string example: VOV openingHours: type: object properties: timezone: type: string example: Europe/Brussels dayTimeRanges: type: array items: type: object properties: dayOfWeek: type: integer example: 1 default: 0 startTime: type: string example: 00:00:00 endTime: type: string example: '23:59:00' distance: type: integer example: 1235 default: 0 taxExclusive: type: boolean example: false default: true status: type: string example: open channelLocationId: type: string example: STORE0005 contact: type: object properties: firstName: type: string example: John lastName: type: string example: Doe phoneNumber: type: string example: '+32411111111' email: type: string example: john.doe@acme.com fulfillmentTypes: type: array items: type: string example: pickup '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /commerce/{accountId}/stores/{channelLinkId}/menus: get: tags: - Menus summary: Deliverect Get Store Menu(s) description: Returns the menus available for a specific store. operationId: commerce_channel_api_stores_get_store_menus parameters: - name: accountId in: path schema: type: string default: 668e4aa170efd23c474b2ad1 required: true description: The accountId value. example: 668e4aa170efd23c474b2ad1 - in: query name: fulfillmentType schema: type: string default: pickup description: Possible values are; delivery | pickup | curbside | eatIn example: pickup - in: path name: channelLinkId schema: type: string required: true description: The channelLinkId value. example: 5e8abc11dec0001a009b responses: '200': description: '200' content: application/json: examples: Result: value: - menu: Spring menu menuId: 62d7f77f64c95193cc29aa91 menuType: 0 nestedModifiers: true channelLinkId: 65eee6a9984a1bc1b9637c59 description: 'Our menu of various product for a beautiful spring, enjoy! ' menuImageUrl: null currency: 1 menuTranslations: {} productTags: - 104 - 108 - 103 - 9 - 8 - 1101 - 1129 - 109 - 112 descriptionTranslations: {} availabilities: - dayOfWeek: 1 startTime: '13: 00' endTime: '22: 00' - dayOfWeek: 2 startTime: '06: 00' endTime: '22: 00' - dayOfWeek: 3 startTime: '06: 00' endTime: '22: 00' - dayOfWeek: 4 startTime: '06: 00' endTime: '22: 00' - dayOfWeek: 5 startTime: '15: 00' endTime: '18: 00' - dayOfWeek: 6 startTime: '06: 00' endTime: '22: 00' - dayOfWeek: 7 startTime: '06: 00' endTime: '22: 00' categories: - id: null name: Steak & Burgers description: Something from the Grill imageUrl: 'https: //resizer.staging.deliverect.com/uia9zWj73e5qP3yQGd4sQrYWcjmQyo-XRJMg3LaMobg/rt:fill/g:ce/el:0/aHR0cHM6Ly9zdG9yYWdlLmdvb2dsZWFwaXMuY29tL2lrb25hLWJ1Y2tldC1zdGFnaW5nL2ltYWdlcy81ZmY2ZWUwODkzMjhjOGFlZmVlYWJlMzMvZ3JpbGwtNjIyYTJjNDhjNzE1YjQwM2IwZWI3MmJlLmpwZWc=.jpg' menu: 62d7f77f64c95193cc29aa91 account: 62d7f53b2f46fac3eedc7dea nameTranslations: {} descriptionTranslations: {} availabilities: [] subProducts: - 62d7f77e64c95193cc29aa63 - 62d7f77e64c95193cc29aa4c - 62d7f77e64c95193cc29aa4f - 62d7f77e64c95193cc29aa4e - 62d7f77e64c95193cc29aa50 products: 62d7f77e64c95193cc29aa63: id: 62d7f77e64c95193cc29aa63 plu: STK-01 name: Delicious Steak Frites price: 1500 productType: 1 max: 0 min: 0 multiply: 1 snoozed: false deliveryTax: 10000 takeawayTax: 7300 eatInTax: 0 bottleDepositPrice: null description: Basic Example Product with - Modifier groups - min/max variables - default selection - translations multiMax: null defaultQuantity: null isVariant: null account: 62d7f53b2f46fac3eedc7dea referenceId: STK-01 location: 62d7f5ce2f46fac3eedca174 calories: null caloriesRangeHigh: null posProductCategoryId: '' posProductId: POS-ID-001 nameTranslations: en: Delicious Steak Frites es: Deliciosos Bistecs Fritos fr: Steak Frites Délicieux nl: Heerlijke Biefstuk Frites descriptionTranslations: {} productTags: [] subProducts: - 62d7f77e64c95193cc29aa64 beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null posCategoryIds: - STK subProductSortOrder: [] modifiers: 62d7f77e64c95193cc29aa53: id: 62d7f77e64c95193cc29aa53 plu: DRNK-01 name: Coca Cola price: 400 productType: 1 max: 0 min: 0 multiply: 1 snoozed: false deliveryTax: 9000 takeawayTax: 9000 eatInTax: 9000 bottleDepositPrice: null description: Cola flavoured sugar and caffeine multiMax: null defaultQuantity: null isVariant: null account: 62d7f53b2f46fac3eedc7dea referenceId: null location: 62d7f5ce2f46fac3eedca174 calories: null caloriesRangeHigh: null posProductCategoryId: '' posProductId: POS-ID-029 nameTranslations: {} descriptionTranslations: {} productTags: [] subProducts: [] beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null posCategoryIds: - DRK subProductSortOrder: [] modifierGroups: 62d7f77e64c95193cc29aa64: id: 62d7f77e64c95193cc29aa64 plu: MOD-01 name: Cooking instructions price: null productType: 3 max: 1 min: 1 multiply: 1 snoozed: false deliveryTax: 9000 takeawayTax: 9000 eatInTax: 9000 bottleDepositPrice: null description: '' multiMax: null defaultQuantity: null isVariant: null account: 62d7f53b2f46fac3eedc7dea referenceId: null location: 62d7f5ce2f46fac3eedca174 calories: null caloriesRangeHigh: null posProductCategoryId: '' posProductId: POS-ID-002 nameTranslations: en: Cooking Instructions es: Cocinado fr: Cuisson nl: Kook instructies descriptionTranslations: {} productTags: [] subProducts: - 62d7f77e64c95193cc29aa53 beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null posCategoryIds: [] subProductSortOrder: [] bundles: 62d7f77e64c95193cc29aa4d: id: 62d7f77e64c95193cc29aa4d plu: BNDL-BRG name: Burger Selection price: null productType: 4 max: 1 min: 1 multiply: 1 snoozed: false deliveryTax: 9000 takeawayTax: 9000 eatInTax: 9000 bottleDepositPrice: null description: '' multiMax: null defaultQuantity: null isVariant: null account: 62d7f53b2f46fac3eedc7dea referenceId: null location: 62d7f5ce2f46fac3eedca174 calories: null caloriesRangeHigh: null posProductCategoryId: '' posProductId: POS-ID-020 nameTranslations: {} descriptionTranslations: {} productTags: [] subProducts: - 65ef3584327cc41b45ebfae6 - 65ef3584327cc41b45ebfae7 - 65ef3584327cc41b45ebfae8 beverageInfo: null nutritionalInfo: null packaging: null supplementalInfo: null posCategoryIds: [] subProductSortOrder: [] snoozedProducts: {} schema: type: array items: type: object properties: menu: type: string example: Spring menu menuId: type: string example: 62d7f77f64c95193cc29aa91 menuType: type: integer example: 0 default: 0 nestedModifiers: type: boolean example: true default: true channelLinkId: type: string example: 65eee6a9984a1bc1b9637c59 description: type: string example: 'Our menu of various product for a beautiful spring, enjoy! ' menuImageUrl: {} currency: type: integer example: 1 default: 0 menuTranslations: type: object properties: {} productTags: type: array items: type: integer example: 104 default: 0 descriptionTranslations: type: object properties: {} availabilities: type: array items: type: object properties: dayOfWeek: type: integer example: 1 default: 0 startTime: type: string example: '13:00' endTime: type: string example: '22:00' categories: type: array items: type: object properties: id: {} name: type: string example: Steak & Burgers description: type: string example: Something from the Grill imageUrl: type: string example: https://resizer.staging.deliverect.com/uia9zWj73e5qP3yQGd4sQrYWcjmQyo-XRJMg3LaMobg/rt:fill/g:ce/el:0/aHR0cHM6Ly9zdG9yYWdlLmdvb2dsZWFwaXMuY29tL2lrb25hLWJ1Y2tldC1zdGFnaW5nL2ltYWdlcy81ZmY2ZWUwODkzMjhjOGFlZmVlYWJlMzMvZ3JpbGwtNjIyYTJjNDhjNzE1YjQwM2IwZWI3MmJlLmpwZWc=.jpg menu: type: string example: 62d7f77f64c95193cc29aa91 account: type: string example: 62d7f53b2f46fac3eedc7dea nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} availabilities: type: array subProducts: type: array items: type: string example: 62d7f77e64c95193cc29aa63 products: type: object properties: 62d7f77e64c95193cc29aa63: type: object properties: id: type: string example: 62d7f77e64c95193cc29aa63 plu: type: string example: STK-01 name: type: string example: Delicious Steak Frites price: type: integer example: 1500 default: 0 productType: type: integer example: 1 default: 0 max: type: integer example: 0 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 snoozed: type: boolean example: false default: true deliveryTax: type: integer example: 10000 default: 0 takeawayTax: type: integer example: 7300 default: 0 eatInTax: type: integer example: 0 default: 0 bottleDepositPrice: {} description: type: string example: Basic Example Product with - Modifier groups - min/max variables - default selection - translations multiMax: {} defaultQuantity: {} isVariant: {} account: type: string example: 62d7f53b2f46fac3eedc7dea referenceId: type: string example: STK-01 location: type: string example: 62d7f5ce2f46fac3eedca174 calories: {} caloriesRangeHigh: {} posProductCategoryId: type: string example: '' posProductId: type: string example: POS-ID-001 nameTranslations: type: object properties: en: type: string example: Delicious Steak Frites es: type: string example: Deliciosos Bistecs Fritos fr: type: string example: Steak Frites Délicieux nl: type: string example: Heerlijke Biefstuk Frites descriptionTranslations: type: object properties: {} productTags: type: array subProducts: type: array items: type: string example: 62d7f77e64c95193cc29aa64 beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} posCategoryIds: type: array items: type: string example: STK subProductSortOrder: type: array modifiers: type: object properties: 62d7f77e64c95193cc29aa53: type: object properties: id: type: string example: 62d7f77e64c95193cc29aa53 plu: type: string example: DRNK-01 name: type: string example: Coca Cola price: type: integer example: 400 default: 0 productType: type: integer example: 1 default: 0 max: type: integer example: 0 default: 0 min: type: integer example: 0 default: 0 multiply: type: integer example: 1 default: 0 snoozed: type: boolean example: false default: true deliveryTax: type: integer example: 9000 default: 0 takeawayTax: type: integer example: 9000 default: 0 eatInTax: type: integer example: 9000 default: 0 bottleDepositPrice: {} description: type: string example: Cola flavoured sugar and caffeine multiMax: {} defaultQuantity: {} isVariant: {} account: type: string example: 62d7f53b2f46fac3eedc7dea referenceId: {} location: type: string example: 62d7f5ce2f46fac3eedca174 calories: {} caloriesRangeHigh: {} posProductCategoryId: type: string example: '' posProductId: type: string example: POS-ID-029 nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array subProducts: type: array beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} posCategoryIds: type: array items: type: string example: DRK subProductSortOrder: type: array modifierGroups: type: object properties: 62d7f77e64c95193cc29aa64: type: object properties: id: type: string example: 62d7f77e64c95193cc29aa64 plu: type: string example: MOD-01 name: type: string example: Cooking instructions price: {} productType: type: integer example: 3 default: 0 max: type: integer example: 1 default: 0 min: type: integer example: 1 default: 0 multiply: type: integer example: 1 default: 0 snoozed: type: boolean example: false default: true deliveryTax: type: integer example: 9000 default: 0 takeawayTax: type: integer example: 9000 default: 0 eatInTax: type: integer example: 9000 default: 0 bottleDepositPrice: {} description: type: string example: '' multiMax: {} defaultQuantity: {} isVariant: {} account: type: string example: 62d7f53b2f46fac3eedc7dea referenceId: {} location: type: string example: 62d7f5ce2f46fac3eedca174 calories: {} caloriesRangeHigh: {} posProductCategoryId: type: string example: '' posProductId: type: string example: POS-ID-002 nameTranslations: type: object properties: en: type: string example: Cooking Instructions es: type: string example: Cocinado fr: type: string example: Cuisson nl: type: string example: Kook instructies descriptionTranslations: type: object properties: {} productTags: type: array subProducts: type: array items: type: string example: 62d7f77e64c95193cc29aa53 beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} posCategoryIds: type: array subProductSortOrder: type: array bundles: type: object properties: 62d7f77e64c95193cc29aa4d: type: object properties: id: type: string example: 62d7f77e64c95193cc29aa4d plu: type: string example: BNDL-BRG name: type: string example: Burger Selection price: {} productType: type: integer example: 4 default: 0 max: type: integer example: 1 default: 0 min: type: integer example: 1 default: 0 multiply: type: integer example: 1 default: 0 snoozed: type: boolean example: false default: true deliveryTax: type: integer example: 9000 default: 0 takeawayTax: type: integer example: 9000 default: 0 eatInTax: type: integer example: 9000 default: 0 bottleDepositPrice: {} description: type: string example: '' multiMax: {} defaultQuantity: {} isVariant: {} account: type: string example: 62d7f53b2f46fac3eedc7dea referenceId: {} location: type: string example: 62d7f5ce2f46fac3eedca174 calories: {} caloriesRangeHigh: {} posProductCategoryId: type: string example: '' posProductId: type: string example: POS-ID-020 nameTranslations: type: object properties: {} descriptionTranslations: type: object properties: {} productTags: type: array subProducts: type: array items: type: string example: 65ef3584327cc41b45ebfae6 beverageInfo: {} nutritionalInfo: {} packaging: {} supplementalInfo: {} posCategoryIds: type: array subProductSortOrder: type: array snoozedProducts: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '500': content: application/json: schema: type: object properties: {} examples: error: summary: error value: '{}' description: Internal Server Error deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /coupons/channel/{channelLinkId}/coupons: get: description: Deliverect Copy of operationId: get_couponsadmin_accountId_coupons_couponId_1 responses: '200': content: application/json: schema: type: object properties: total: type: integer example: 1 default: 0 page: type: integer example: 1 default: 0 size: type: integer example: 50 default: 0 items: type: array items: type: object properties: code: type: string example: D23 isEnabled: type: boolean example: true default: true type: type: string example: item isHidden: type: boolean example: false default: true discounts: type: array items: type: object properties: type: type: string example: flat_off value: type: integer example: 1234 default: 0 currency: type: string example: EUR plus: type: array items: type: string example: ABC-123 display: type: string example: '12.34' conditions: type: array items: type: object properties: type: type: string example: max_uses_per_coupon maxUsesPerCoupon: type: integer example: 3 default: 0 description: type: string example: my coupon id: type: string example: 690e1ef7a856cfe57553a9e1 accountId: type: string example: 681cbecf4ae843d500e25e47 timesUsed: type: integer example: 0 default: 0 created: type: string example: '2025-11-07T16:31:51.508000Z' updated: type: string example: '2025-11-07T16:31:51.509000Z' examples: OK: summary: OK value: total: 1 page: 1 size: 50 items: - code: D23 isEnabled: true type: item isHidden: false discounts: - type: flat_off value: 1234 currency: EUR plus: - ABC-123 - DEF-456 display: '12.34' conditions: - type: max_uses_per_coupon maxUsesPerCoupon: 3 - type: locations locationIds: - 68434f75202fe35540a31c23 description: my coupon id: 690e1ef7a856cfe57553a9e1 accountId: 681cbecf4ae843d500e25e47 timesUsed: 0 created: '2025-11-07T16:31:51.508000Z' updated: '2025-11-07T16:31:51.509000Z' description: OK '404': content: application/json: schema: type: object properties: code: type: string example: string message: type: string example: string context: type: object properties: {} required: - code - message examples: Not Found: summary: Not Found value: code: coupon_not_found message: coupon not found context: {} description: Not Found parameters: - in: query name: size schema: type: integer default: '25' description: The size value. example: '25' - in: query name: page schema: type: integer default: '1' description: The page value. example: '1' - in: path name: channelLinkId schema: type: string required: true description: The channelLinkId value. example: 5e8abc11dec0001a009b summary: Deliverect Copy of tags: - Coupons x-microcks-operation: delay: 0 dispatcher: FALLBACK /upsell/channel/{channelLinkId}: post: tags: - Upsell summary: Deliverect Get Upsell Items operationId: getUpsellItems parameters: - name: channelLinkId in: path required: true schema: type: string description: The unique identifier of a channel link for a store location example: 5e8abc11dec0001a009b requestBody: required: true content: application/json: schema: type: object required: - account - channelLink - location - items properties: account: type: string description: The unique identifier of a customer account example: string channelLink: type: string description: The unique identifier of a channel link within a store location example: string location: type: string description: The unique identifier of a location within a customer account example: string items: type: array items: type: object required: - plu - quantity properties: plu: type: string description: Unique identifier for a product example: PIE1 quantity: type: integer default: 1 description: Amount of items ordered example: 1 description: Items in the order which upsell recommendations will be based on example: account: 67f93fc709a75f7e9e36da7f location: 67f9413754e4db73b3ed1e9f channelLink: 67f94128c490d2ed895a34e7 items: - plu: PLU1 quantity: 1 - plu: PLU2 quantity: 2 - plu: PLU3 quantity: 1 examples: Example: summary: Example value: "{\n \"account\": \"{accountId}\",\n \"location\": \"{locationId},\n \"channelLink\": \"{channelLinkId}\",\n \"items\": [\n {\n \"plu\": \"PLU-1\",\n \"quantity\"\ : 1\n },\n {\n \"plu\": \"PLU-2\",\n \"quantity\": 2\n },\n {\n \"plu\": \"PLU-3\",\n \"quantity\": 1\n }\n ]\n}" responses: '200': description: Success content: application/json: schema: type: object properties: items: type: array items: type: object properties: plu: type: string example: PIE1 quantity: type: integer example: 1 description: 'Items which have a high likelihood of being ordered together with the items included in the provided order. ' upsellMetricId: type: string example: 609a1b2c3d4e5f6a7b8c9d0e examples: OK: value: items: - plu: PLU-4 quantity: 1 - plu: PLU-5 quantity: 1 - plu: PLU-6 quantity: 1 upsellMetricId: '{upsellMetricId}' summary: OK '403': description: Forbidden content: application/json: examples: ? '' : value: code: insufficient_permissions description: Not allowed to access this location. summary: '' Forbidden: summary: Forbidden value: code: insufficient_permissions description: Not allowed to access this location. '422': description: Validation Error content: application/json: examples: ? '' : value: - type: missing loc: - location msg: Field required summary: '' Unprocessable Entity: summary: Unprocessable Entity value: - type: missing loc: - location msg: Field required input: account: 67f93fc709a75f7e9e36da7f channelLink: 67f94128c490d2ed895a34e7 items: - - - url: https://errors.pydantic.dev/2.10/v/missing description: Deliverect Get Upsell Items x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: oauth2: type: oauth2 description: OAuth 2.0 machine-to-machine client-credentials. Exchange client_id/client_secret at POST /oauth/token for a Bearer access_token. flows: clientCredentials: tokenUrl: https://api.deliverect.com/oauth/token scopes: {} security: - oauth2: []