--- updatedAt: 2026-09-22T17:24:40.000Z agentTools: projectIndex: https://developers.deliverect.com/v3.0-ordering-experience/llms.txt --- # Get Basket ### Basket ID Upon successful basket validation, an `"id"` is returned that can be retrieved via this endpoint. {`

Basket Validity
Only baskets which haven't been completed via the checkout process can be retrieved via this endpoint

`} # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Commerce API", "description": " Our Commerce API powers digital ordering via endpoints that provide store details, menu data, basket calculation and validation and provides a checkout flow to handle POS order injection.", "version": "1.0.0" }, "servers": [ { "url": "https://api.staging.deliverect.com" } ], "security": [ { "oauth2ClientCredentials": [] } ], "components": { "securitySchemes": { "oauth2ClientCredentials": { "type": "oauth2", "description": "Obtain an access token using the partner client ID and client secret. Send the returned token with each API request in the Authorization header as a Bearer token.", "flows": { "clientCredentials": { "tokenUrl": "/oauth/token", "scopes": {} } } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true, "oauth-options": { "useInsecureClientAuthentication": true } }, "x-readme-fauxas": true, "paths": { "/commerce/{accountId}/baskets/{basketId}": { "get": { "tags": [ "Endpoints" ], "summary": "Get Basket", "operationId": "commerce-channel-api-baskets-get-basket", "parameters": [ { "name": "accountId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "basketId", "in": "path", "schema": { "type": "string" }, "required": true } ], "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" }, "channel": { "type": "integer", "description": "Global identifier of the ordering channel/platform.", "example": 19066 }, "category": { "type": "object", "description": "Business category of the store.", "properties": { "type": { "type": "string", "description": "Store category type.", "example": "restaurant" } } }, "currency": { "type": "string", "example": "EUR" }, "taxExclusive": { "type": "boolean", "example": false, "default": true }, "status": { "type": "string", "example": "open", "description": "Current status of the basket." }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the basket item, auto-generated when the item is added. Used to reference the item in subsequent requests (e.g. `itemIds` in discounts).", "example": "6ab29d75ab0f990dcc48585d" }, "menuId": { "type": "string", "example": "62d7f77f64c95193cc29aa91", "description": "Internal Deliverect menu id. You can retrieve the `menuId` via [GET Store Menu](https://developers.deliverect.com/v3.0-ordering-experience/reference/commerce-get-menus)." }, "plu": { "type": "string", "example": "STK-01", "description": "Unique identifier of the item, to be used when creating orders." }, "name": { "type": "string", "example": "Delicious Steak Frites", "description": "Display name of the item." }, "quantity": { "type": "integer", "example": 2, "default": 0, "description": "Number of units of the item added to the basket." }, "note": { "type": [ "string", "null" ], "example": "extra salt please", "description": "Special instructions for the item." }, "price": { "type": "integer", "example": 1500, "default": 0, "description": "Unit price of the item. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "gross": { "type": "integer", "example": 3800, "default": 0, "description": "Item total before tax, including modifiers and quantity. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "taxes": { "type": "array", "description": "Taxes applied to the item.", "items": { "type": "object", "properties": { "rate": { "type": "integer", "description": "Tax rate with 3 decimal digits, e.g. 10.5% = `10500`.", "example": 10500 }, "name": { "type": "string", "description": "Name of the tax.", "example": "GST" }, "amount": { "type": "integer", "description": "Tax amount applied. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 187 } } } }, "net": { "type": "integer", "example": 3800, "default": 0, "description": "Item total including tax. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "subItems": { "type": "array", "items": { "type": "object", "description": "A modifier selected for the parent item. Modifiers can be nested to any depth via `subItems`.", "properties": { "customizationPlu": { "type": "string", "example": "MOD-01", "description": "PLU of the modifier group that the `subItem` belongs to." }, "plu": { "type": "string", "example": "DRNK-01", "description": "Unique identifier of the item (modifier)." }, "name": { "type": "string", "example": "Coca Cola", "description": "Display name of the modifier." }, "quantity": { "type": "integer", "example": 1, "default": 0, "description": "Number of times this modifier is applied to the item." }, "price": { "type": "integer", "example": 400, "default": 0, "description": "Unit price of the modifier. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "subItems": { "type": "array", "description": "Nested modifiers applied to this modifier. Each entry follows the same structure as its parent `subItem`.", "items": { "type": "object", "description": "A modifier selected for the parent item. Modifiers can be nested to any depth via `subItems`.", "properties": { "customizationPlu": { "type": "string", "example": "MOD-01", "description": "PLU of the modifier group that the `subItem` belongs to." }, "plu": { "type": "string", "example": "DRNK-01", "description": "Unique identifier of the item (modifier)." }, "name": { "type": "string", "example": "Coca Cola", "description": "Display name of the modifier." }, "quantity": { "type": "integer", "example": 1, "default": 0, "description": "Number of times this modifier is applied to the item." }, "price": { "type": "integer", "example": 400, "default": 0, "description": "Unit price of the modifier. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "subItems": { "type": "array", "description": "Nested modifiers applied to this modifier. Each entry follows the same structure as its parent `subItem`.", "items": { "type": "object", "description": "A modifier selected for the parent item. Modifiers can be nested to any depth via `subItems`.", "properties": { "customizationPlu": { "type": "string", "example": "MOD-01", "description": "PLU of the modifier group that the `subItem` belongs to." }, "plu": { "type": "string", "example": "DRNK-01", "description": "Unique identifier of the item (modifier)." }, "name": { "type": "string", "example": "Coca Cola", "description": "Display name of the modifier." }, "quantity": { "type": "integer", "example": 1, "default": 0, "description": "Number of times this modifier is applied to the item." }, "price": { "type": "integer", "example": 400, "default": 0, "description": "Unit price of the modifier. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "subItems": { "type": "array", "description": "Nested modifiers applied to this modifier. Each entry follows the same structure as its parent `subItem`.", "items": { "type": "object", "description": "Further nested modifiers follow the same structure." } }, "note": { "type": [ "string", "null" ], "description": "Special instructions for the modifier." }, "upsellReference": { "type": [ "string", "null" ], "description": "Reference to the upsell recommendation this modifier was added from, if any." } } } }, "note": { "type": [ "string", "null" ], "description": "Special instructions for the modifier." }, "upsellReference": { "type": [ "string", "null" ], "description": "Reference to the upsell recommendation this modifier was added from, if any." } } } }, "note": { "type": [ "string", "null" ], "description": "Special instructions for the modifier." }, "upsellReference": { "type": [ "string", "null" ], "description": "Reference to the upsell recommendation this modifier was added from, if any." } } }, "description": "Modifiers applied to the parent item. Each `subItem` corresponds to a chosen modifier (where applicable)." }, "discounts": { "type": "array", "description": "Discounts applied to the item, referencing basket-level `discounts` by `referenceId`.", "items": { "type": "object", "properties": { "referenceId": { "type": "integer", "description": "Reference to the basket-level discount.", "example": 1 }, "amount": { "type": "integer", "description": "Discount amount applied to this item. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 50 } } } }, "discountTotal": { "type": "integer", "example": 0, "default": 0, "description": "Total discount applied to the item. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "preparationTime": { "type": [ "integer", "null" ], "description": "Item-specific preparation time in minutes, if configured." }, "customerId": { "type": [ "string", "null" ], "description": "ID of the group basket customer who added the item. `null` for non-group baskets." }, "upsellReference": { "type": [ "string", "null" ], "description": "Reference to the upsell recommendation this item was added from, if any." } } }, "description": "List of products the customer wants to order." }, "donations": { "type": "array", "description": "Donations added to the basket.", "items": { "type": "object", "properties": { "externalId": { "type": "string", "description": "External reference for the donation.", "example": "1234" }, "amount": { "type": "integer", "description": "Donation amount. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 200 } } } }, "payment": { "type": "object", "properties": { "tips": { "type": "array", "description": "Tips added to the basket.", "items": { "type": "object", "properties": { "amount": { "type": "integer", "description": "Tip amount. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 200 }, "type": { "type": "string", "enum": [ "restaurant", "driver" ], "description": "Recipient of the tip:\n\n- `restaurant` - Tip for the restaurant\n- `driver` - Tip for the delivery driver", "example": "restaurant" } } } }, "donationTotal": { "type": "integer", "description": "Total of all donations. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 0 }, "discountsTotal": { "type": "integer", "example": 0, "default": 0, "description": "Total of all discounts. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "chargesTotal": { "type": "integer", "example": 0, "default": 0, "description": "Total of all charges (service charge, bag fee, delivery fee). Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "taxTotal": { "type": "integer", "example": 0, "default": 0, "description": "Total tax. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "tipTotal": { "type": "integer", "example": 0, "default": 0, "description": "Total of all tips. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "subTotal": { "type": "integer", "description": "Sum of item totals before tax, discounts, charges and tips. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 3032 }, "total": { "type": "integer", "example": 5300, "default": 0, "description": "Final amount payable. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." } }, "description": "Calculated payment totals for the basket." }, "customer": { "type": [ "object", "null" ], "properties": { "name": { "type": "string", "example": "John Doe", "description": "Full name of the customer." }, "companyName": { "type": "string", "example": "ACME", "description": "Name of the company or organization associated with the order." }, "phoneNumber": { "type": "string", "example": "+3211223344", "description": "Customer's contact number for order confirmation or delivery communication.\n\nEg., \"+3211223344\"" }, "email": { "type": "string", "example": "john.doe@acme.com", "description": "Customer's email address.", "format": "email" }, "externalId": { "type": "string", "example": "crm-id-1234", "description": "External reference ID for the customer in a third-party system." }, "loyaltyProviderCustomerId": { "type": "string", "description": "Unique identifier for the customer in the loyalty provider system.", "example": "17dh89" }, "tin": { "type": "string", "description": "Tax identification or fiscal equivalent number for the customer.", "example": "123456789" }, "crmProfileId": { "type": "string", "description": "Unique identifier for the customer's profile in the Deliverect CRM system." }, "sendNotifications": { "type": "boolean", "description": "Flag to control whether order notifications should be sent to the customer.", "example": true }, "allowMarketing": { "type": [ "boolean", "null" ], "description": "Flag to indicate whether the customer has opted in to receive marketing communications." }, "sendReceiptSMS": { "type": [ "boolean", "null" ], "description": "Flag to control whether the order receipt should be sent via SMS." }, "sendReceiptEmail": { "type": [ "boolean", "null" ], "description": "Flag to control whether the order receipt should be sent via email." } }, "description": "Information about the customer placing the order." }, "group": { "type": [ "object", "null" ], "description": "Group order details. `null` for non-group baskets.", "properties": { "customers": { "type": "array", "description": "Customers participating in the group basket.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal customer ID, auto-generated when the customer is added to the basket.", "example": "691327c5d367f4588f948201" }, "role": { "type": "string", "enum": [ "host", "guest" ], "description": "Role in the group:\n\n- `host` - Customer who owns the group basket\n- `guest` - Customer who joined the group basket", "example": "host" }, "name": { "type": "string", "example": "John Doe" }, "companyName": { "type": "string", "example": "ACME" }, "phoneNumber": { "type": "string", "example": "+3211223344" }, "email": { "type": "string", "format": "email", "example": "john.doe@acme.com" }, "externalId": { "type": "string", "example": "crm-id-1234" }, "tin": { "type": "string", "example": "123456789" } } } }, "policies": { "type": "array", "description": "Deadlines applied to the group basket.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "newJoinersDeadline", "groupItemsModificationDeadline", "customerItemsModificationDeadline" ], "description": "Policy type:\n\n- `newJoinersDeadline` - Last time new customers can join\n- `groupItemsModificationDeadline` - Last time any items can be changed\n- `customerItemsModificationDeadline` - Last time a specific customer can change their items", "example": "newJoinersDeadline" }, "deadline": { "type": "string", "format": "date-time", "description": "Deadline timestamp in UTC.", "example": "2026-12-30T23:59:59.000000Z" }, "customerId": { "type": "string", "description": "Customer the policy applies to (only for `customerItemsModificationDeadline`).", "example": "691327c5d367f4588f948202" } } } } } }, "fulfillment": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "pickup", "delivery", "eatIn" ], "description": "Types of orders to be included inside the `fulfillment` object. These are the allowed values:\n\n- `pickup` - Takeaway orders\n- `delivery` - Delivery handled directly by the ordering platform\n- `eatIn` - Orders consumed on premises (dine-in)", "example": "pickup" }, "time": { "type": [ "string", "null" ], "format": "date-time", "description": "Timestamp in UTC, `yyyy-MM-ddTHH:mm:ssZ`. All time values in our API are in UTC time as per [ISO8601](https://en.wikipedia.org/wiki/ISO_8601).\n\n*(For delivery, pickup, and any non-ASAP order.)*" }, "address": { "type": "object", "description": "Delivery address information for the order. Required when `type` = \"delivery\".", "properties": { "line": { "type": "string", "description": "Full formatted delivery address line.\n\nExample: \"Foreestelaan 82, 9000 Gent, Belgium\"", "example": "Foreestelaan 82, 9000 Gent, Belgium" }, "subpremise": { "type": "string", "description": "Apartment, suite, unit or floor number.", "example": "Unit #1040" }, "street": { "type": "string", "description": "Street name.", "example": "Park Avenue South" }, "area": { "type": "string", "description": "Neighbourhood or district.", "example": "" }, "city": { "type": "string", "description": "City.", "example": "New York" }, "postalCode": { "type": "string", "description": "Postal / ZIP code.", "example": "10003" }, "stateOrProvince": { "type": "string", "description": "State or province.", "example": "NY" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2).", "example": "US" }, "coordinates": { "type": "array", "items": { "type": "number" }, "description": "Geographical coordinates of the delivery address in `[long, lat]` order, used for precise location mapping and routing.\n\nEg., `[51.03162341734958, 3.7337162550022622]`", "example": [ 51.03162341734958, 3.7337162550022622 ] }, "note": { "type": "string", "description": "Delivery instructions for the courier.", "example": "watch out for the yappy dog" } } }, "spot": { "type": "string", "description": "Identifier of the dining spot (such as a table number).\n\nRequired when `type` = \"eatIn\".", "example": "TABLE-1" }, "pickupNotes": { "type": [ "string", "null" ], "description": "Pickup instructions from the customer (e.g. car description for curbside).", "example": "Yellow Honda" } }, "description": "Defines how the order will be fulfilled.", "required": [ "type" ] }, "note": { "type": "string", "description": "Optional free-text field that contains special instructions or comments from the customer about the order (e.g., cooking preferences, dietary requests, packaging notes)." }, "taxes": { "type": "array", "description": "Basket-level tax summary, aggregated by tax name.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the tax.", "example": "GST" }, "amount": { "type": "integer", "description": "Total amount for this tax. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 318 } } } }, "discounts": { "type": "array", "description": "Discounts applied to the basket.", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "order_flat_off", "order_percent_off", "item_free", "item_bogof", "item_flat_off", "item_percent_off", "wallet_cash", "compensation_card" ], "description": "Type of discount.", "example": "order_flat_off" }, "referenceId": { "type": "integer", "description": "Basket-scoped reference used by item-level `discounts`.", "example": 1 }, "amount": { "type": "integer", "description": "Calculated discount amount. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 50 }, "value": { "type": "integer", "description": "Configured discount value (amount, or rate with 2 decimal digits for percentage discounts).", "example": 1000 }, "provider": { "type": "string", "enum": [ "restaurant", "coupon", "loyalty" ], "description": "Source of the discount:\n\n- `restaurant` - Restaurant-funded promotion\n- `coupon` - Coupon code\n- `loyalty` - Loyalty provider reward", "example": "restaurant" }, "externalId": { "type": [ "string", "null" ], "description": "External reference for the discount.", "example": "discount-123" }, "name": { "type": "string", "description": "Display name of the discount.", "example": "CONGRATS! HERE IS 1 EUR OFF" } } } }, "charges": { "type": "object", "properties": { "taxTotal": { "type": "integer", "example": 0, "default": 0, "description": "Total tax across all charges. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "netTotal": { "type": "integer", "example": 0, "default": 0, "description": "Total of all charges including tax. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "grossTotal": { "type": "integer", "example": 0, "default": 0, "description": "Total of all charges before tax. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00." }, "serviceCharge": { "type": "object", "properties": { "value": { "type": "integer", "description": "Configured fee value. For `fixed`, an amount expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00; for `percent`, a rate with 3 decimal digits.", "example": 0 }, "taxRate": { "type": "integer", "description": "Tax rate with 3 decimal digits, e.g. 10.5% = `10500`.", "example": 0 }, "gross": { "type": "integer", "description": "Fee amount before tax. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 0 }, "tax": { "type": "integer", "description": "Tax applied to the fee. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 0 }, "net": { "type": "integer", "description": "Fee amount including tax. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 0 }, "type": { "type": "string", "enum": [ "fixed", "percent" ], "description": "How the fee is calculated:\n\n- `fixed` - A fixed amount\n- `percent` - A percentage of the basket subtotal", "example": "fixed" } }, "description": "Service charge details." }, "bagFee": { "type": "object", "properties": { "value": { "type": "integer", "description": "Configured fee value. For `fixed`, an amount expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00; for `percent`, a rate with 3 decimal digits.", "example": 0 }, "taxRate": { "type": "integer", "description": "Tax rate with 3 decimal digits, e.g. 10.5% = `10500`.", "example": 0 }, "gross": { "type": "integer", "description": "Fee amount before tax. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 0 }, "tax": { "type": "integer", "description": "Tax applied to the fee. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 0 }, "net": { "type": "integer", "description": "Fee amount including tax. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 0 } }, "description": "Packaging/bag fee details." }, "deliveryFee": { "type": "object", "properties": { "value": { "type": "integer", "description": "Configured fee value. For `fixed`, an amount expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00; for `percent`, a rate with 3 decimal digits.", "example": 0 }, "taxRate": { "type": "integer", "description": "Tax rate with 3 decimal digits, e.g. 10.5% = `10500`.", "example": 0 }, "gross": { "type": "integer", "description": "Fee amount before tax. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 0 }, "tax": { "type": "integer", "description": "Tax applied to the fee. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 0 }, "net": { "type": "integer", "description": "Fee amount including tax. Expressed as an integer in the smallest currency unit, e.g. 1000 = 10.00.", "example": 0 } }, "description": "Delivery fee details." } }, "description": "Charges applied to the basket." }, "preparationTime": { "type": "integer", "description": "Estimated preparation time for the basket in minutes.", "example": 15 }, "preparationDelayTime": { "type": "integer", "description": "Additional delay in minutes added to the preparation time (e.g. when the store is busy).", "example": 0 }, "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", "description": "A `storeId` is the unique identifier for a store–channel (ordering platform) at a specific location, and may also be referenced as `channelLinkId`.\n\nTo retrieve the stores existing on a specific location, use [Get Stores](https://developers.deliverect.com/v3.0-ordering-experience/reference/commerce-get-stores)." }, "channelLinkId": { "type": "string", "description": "Alternative to `storeId`.", "example": "65eee6a9984a1bc1b9637c59" }, "channelOrderId": { "type": [ "string", "null" ], "description": "Order ID from the ordering channel. `null` until checkout completes." }, "channelOrderDisplayId": { "type": [ "string", "null" ], "description": "Human-readable order reference. `null` until checkout completes." } }, "required": [ "storeId" ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } } }, "examples": { "Insufficient permissions": { "summary": "Insufficient permissions", "value": { "code": "insufficient_permissions", "description": "" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "Basket not found": { "summary": "Basket not found", "value": { "error": "basket not found" } }, "Account not found": { "summary": "Account not found", "value": { "error": "account not found", "http_code": 404, "description": "account not found" } } } } } } }, "deprecated": false } } } } ```