Download OpenAPI specification:Download
The POS Vendor API is intended for RBI partners implementing a point-of-sale (POS) system in a restaurant. The partner updates and queries for Store, Menu, and Order status information via the following POS Vendor API endpoints :
The partner subscribes to the following POS Vendor API webhooks :
fireOrderInSeconds
, update the order so that the restaurant starts preparation immediatelyThe ordering flow proceeds with the following logical steps :
sequenceDiagram
actor app as RBI App
participant api as RBI Partners API
participant partner as POS Partner Middleware
app->>api: Visit checkout page
api->>+partner: Webhook: ORDER_PRICE
partner-->>-api: 201 / 202
Notes
sequenceDiagram
actor app as RBI App
participant api as RBI Partners API
participant partner as POS Partner Middleware
app->>api: Complete checkout
api->>+partner: Webhook: ORDER_COMMIT
partner-->>-api: 201 / 202
Notes
fireOrderInSeconds
field in the payload.sequenceDiagram
participant api as RBI Partners API
participant partner as POS Partner Middleware
api->>api: Change in order ready time
api->>+partner: Webhook: ORDER_FIRE
partner-->>-api: 201 / 202
sequenceDiagram
participant api as RBI Partners API
participant partner as POS Partner Middleware
partner->>api: Order Event
api-->>partner: 201
sequenceDiagram
participant api as RBI Partners API
participant partner as POS Partner Middleware
api->>api: Order changed
api->>partner: Webhook: ORDER_EVENT
partner-->>api: 201
Notes
stateDiagram-v2
[*] --> CREATED
CREATED --> PRICED
CREATED --> ERROR
PRICED --> COMMITTED
PRICED --> CANCELED
PRICED --> ERROR
COMMITTED --> PREPARING
COMMITTED --> ERROR
COMMITTED --> CANCELED
PREPARING --> PREPARED
PREPARING --> DONE
PREPARING --> ERROR
PREPARING --> CANCELED
PREPARED --> DONE
PREPARED --> ERROR
DONE --> [*]
ERROR --> [*]
CANCELED --> [*]
The Delivery Vendor API is intended for RBI partners providing delivery fulfillment services for an RBI restaurant or group of restaurants.
The partner subscribes to the following Delivery Vendor API webhooks :
The partner updates delivery status information via a single Delivery Vendor API endpoint :
The delivery fulfillment flow proceeds with the following logical steps :
sequenceDiagram
actor app as RBI App
participant api as RBI Partner Service
participant partner as Partners Integration
app->>api: Click "Deliver Here"
api->>+partner: Webhook: Quote
partner-->>-api: 200
sequenceDiagram
actor app as RBI App
participant api as RBI Partner Service
participant partner as Partners Integration
app->>api: Go to checkout page
api->>+partner: Webhook: Quote
partner-->>-api: 200
Notes
sequenceDiagram
actor app as RBI App
participant api as RBI Partner Service
participant partner as Partners Integration
app->>api: Complete checkout
api->>+partner: Webhook: Create Delivery
partner-->>-api: 201
sequenceDiagram
participant api as RBI Partners API
participant partner as Partners Integration
partner->>api: Delivery Event
api-->>partner: 204
Notes
stateDiagram-v2
[*] --> DELIVERY_CREATED
DELIVERY_CREATED --> DRIVER_ASSIGNED
DELIVERY_CREATED --> ORDER_CANCELLED
DRIVER_ASSIGNED --> DRIVER_UNASSIGNED
DRIVER_ASSIGNED --> DRIVER_STARTING
DRIVER_ASSIGNED --> DRIVER_AT_STORE
DRIVER_ASSIGNED --> ORDER_PICKED_UP
DRIVER_ASSIGNED --> DRIVER_AT_CUSTOMER
DRIVER_ASSIGNED --> ORDER_DROPPED_OFF
DRIVER_ASSIGNED --> ORDER_CANCELLED
DRIVER_UNASSIGNED --> DRIVER_ASSIGNED
DRIVER_UNASSIGNED --> ORDER_CANCELLED
DRIVER_STARTING --> DRIVER_AT_STORE
DRIVER_STARTING --> ORDER_PICKED_UP
DRIVER_STARTING --> DRIVER_AT_CUSTOMER
DRIVER_STARTING --> ORDER_DROPPED_OFF
DRIVER_STARTING --> ORDER_CANCELLED
DRIVER_AT_STORE --> ORDER_PICKED_UP
DRIVER_AT_STORE --> DRIVER_AT_CUSTOMER
DRIVER_AT_STORE --> ORDER_DROPPED_OFF
DRIVER_AT_STORE --> ORDER_CANCELLED
ORDER_PICKED_UP --> DRIVER_AT_CUSTOMER
ORDER_PICKED_UP --> ORDER_DROPPED_OFF
ORDER_PICKED_UP --> ORDER_CANCELLED
DRIVER_AT_CUSTOMER --> ORDER_DROPPED_OFF
DRIVER_AT_CUSTOMER --> ORDER_CANCELLED
ORDER_DROPPED_OFF --> [*]
ORDER_CANCELLED --> [*]
The Developer API is provided for Partners to manage their integrations with RBI.
Documentation can be found under:
https://euc1-staging-{brand}-partners-admin.rbictg.com/docs
Every Integration created through the Developer API is saved to DB with a UUID value called secret
. This
value can be also passed as a parameter or even updated later on. To learn more refer to the
Developer API documentation.
sequenceDiagram
actor partner as Partner
participant api as RBI Developer API
participant db as RBI DB
partner->>+api: Create integration
api->>+db: Save integration
Note over api,db: secret: uuid()
When dispatching webhooks, RBI will create an HMAC signature using the shared secret
value and the payload
.
This signature is conveyed by the x-signature
header. Partners can validate authenticity of the request and
integrity of data by using the same hashing mechanism and comparing signatures. Only RBI and Partner have
access to the shared secret
value, so if the contents of the payload or header were altered, the signatures will not match.
sequenceDiagram
participant service as RBI Partner Service
participant partner as Partner API
service->>+partner: Webhook callback
Note over service,partner: x-signature: xyz
Example of request validation:
import { createHmac, timingSafeEqual } from 'crypto';
const validateRequestExample = async (request) => {
const signature = request.headers['x-signature'];
const secret = await getSecret();
const digest = createHmac('sha256', secret).update(JSON.stringify(request.body)).digest('hex');
const digestBuffer = Buffer.from(digest, 'utf8');
const checksumBuffer = Buffer.from(signature, 'utf8');
return checksumBuffer.length === digest.length && timingSafeEqual(digestBuffer, checksumBuffer);
};
To learn more about HMAC signatures go to https://www.okta.com/identity-101/hmac/
Use this endpoint to create an offer for a Loyalty Id
baseConfigId required | string (BaseConfigId) Example: "3bd7ce07-509b-40ed-9f3b-cd1bd3f7ad17" Base Config Id Id of the base offer configuration. This can be grabbed from a Sanity offer. |
userId required | string (UserId) Example: "4d01a317-f902-4388-8143-d8d4b7812b6a" Target user for the offer. |
loyaltyId | string (LoyaltyId) Example: "b51d12ca-f92d-4955-bcc0-c5c533526f51" Target loyalty user for the offer. Note that most users are identified using User Id instead of Loyalty Id. |
partnerPlatform | string (PartnerPlatform) Example: "Homeria" Name of the platform the partner is using to perform the request. This is used to track the offer within Snowflake. |
offerName | string (OfferName) Example: "3% Off" This is an optional name to assign to the offer. |
rank | number (Rank) Example: "1677779551233" Rank of priority for the offer Optional value to set in what order this offer works when other offers are present |
startDate | string (StartDate) Example: "2023-03-02T17:58:33.077Z" Starting date for the offer Set this value if you need the offer to be valid from a certain date. This will default to the date of creation. |
endDate | string (EndDate) Example: "2024-03-02T17:58:33.077Z" Finish date for the offer Set this value to add an expiration date for the offer |
{- "baseConfigId": "3bd7ce07-509b-40ed-9f3b-cd1bd3f7ad17",
- "userId": "4d01a317-f902-4388-8143-d8d4b7812b6a",
- "loyaltyId": "b51d12ca-f92d-4955-bcc0-c5c533526f51",
- "partnerPlatform": "Homeria",
- "offerName": "3% Off",
- "rank": 1677779551233,
- "startDate": "2023-03-02T17:58:33.077Z",
- "endDate": "2024-03-02T17:58:33.077Z"
}
{ }
Use this endpoint to respond asynchronously to a price order webhook request from Partner API.
orderId required | string Unique Order ID |
required | object (OrderPriceWebhookCallback) |
{- "data": {
- "referenceId": "string",
- "charges": {
- "tax": {
- "currency": "USD",
- "amount": 100
}, - "subTotal": {
- "currency": "USD",
- "amount": 100
}, - "total": {
- "currency": "USD",
- "amount": 100
}, - "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "feedback": [
- {
- "entryId": "entry-id",
- "isAvailable": true,
- "price": {
- "currency": "USD",
- "amount": 100
}
}
], - "discounts": [
- {
- "type": "DISCOUNT",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
], - "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
]
}
}
{- "status": 400,
- "code": "ValidationError",
- "message": "isAvailable must be a boolean value",
- "errors": [
- {
- "code": "ValidationError",
- "message": "string",
- "details": { },
- "domain": "string",
- "location": "isAvailable",
- "locationType": "requestBody",
- "sendReport": "string",
- "extendedHelp": "string"
}
]
}
Use this endpoint to respond asynchronously to a commit order webhook request from Partner API.
orderId required | string Unique Order ID |
required | object (OrderEvent) |
{- "data": {
- "externalReferenceId": "string",
- "status": "CREATED",
- "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
]
}
}
{- "status": 400,
- "code": "ValidationError",
- "message": "isAvailable must be a boolean value",
- "errors": [
- {
- "code": "ValidationError",
- "message": "string",
- "details": { },
- "domain": "string",
- "location": "isAvailable",
- "locationType": "requestBody",
- "sendReport": "string",
- "extendedHelp": "string"
}
]
}
Use this endpoint to respond asynchronously to a fire order webhook request from Partner API.
orderId required | string Unique Order ID |
required | object (OrderEvent) |
{- "data": {
- "externalReferenceId": "string",
- "status": "CREATED",
- "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
]
}
}
{- "status": 400,
- "code": "ValidationError",
- "message": "isAvailable must be a boolean value",
- "errors": [
- {
- "code": "ValidationError",
- "message": "string",
- "details": { },
- "domain": "string",
- "location": "isAvailable",
- "locationType": "requestBody",
- "sendReport": "string",
- "extendedHelp": "string"
}
]
}
Get Orders by Phone Number.
Use this endpoint to get all orders ids related to a phone number.
deliveryPhoneNumber required | string Delivery Phone Number |
startingDate | string Filter lookups based on the creation date. |
{- "data": [
- {
- "orderId": "string",
- "createdAt": "string"
}
]
}
Get order.
Use this endpoint to get the most up to date information about the order.
orderId required | string Unique Order ID |
{- "data": {
- "cart": {
- "menuSelections": [
- {
- "id": "item_42",
- "name": "Whooper",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "type": "Item",
- "menuSelections": [
- { }
]
}
]
}, - "charges": {
- "tax": {
- "currency": "USD",
- "amount": 100
}, - "mpfTax": {
- "taxRemittedByMpf": {
- "currency": "USD",
- "amount": 100
}, - "isTaxRemittedByMpf": true
}, - "subTotal": {
- "currency": "USD",
- "amount": 100
}, - "total": {
- "currency": "USD",
- "amount": 100
}, - "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "deliveryMode": "MANAGED_BY_STORE",
- "createdAt": "1991-02-11T20:30:19Z",
- "customer": {
- "id": "string",
- "externalReferenceId": "string",
- "name": "string",
- "username": "string",
- "phone": "+12223334444",
- "email": "user@example.com"
}, - "delivery": {
- "instructions": "Instrucciones de entrega",
- "courier": {
- "name": "string",
- "profileImage": {
- "url": "string",
- "altText": "string"
}, - "phone": "string"
}, - "dropoff": {
- "addressLine1": "33 Avinguda Diagonal",
- "addressLine2": "Unidad",
- "city": "Barcelona",
- "country": "ESP",
- "latitude": 41.409757,
- "longitude": 2.2135087,
- "phoneNumber": "0034919919919",
- "phoneNumberCode": "9919",
- "route": "33 Avinguda Diagonal",
- "state": "CT",
- "streetNumber": "33",
- "zip": "08019"
}, - "dropoffWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "pickupWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "status": "DELIVERY_CREATED"
}, - "additionalDetails": [
- {
- "key": "notes",
- "value": "Any notes"
}
], - "externalReferenceId": "string",
- "fireOrderInSeconds": 600,
- "id": "00000000-0000-0000-0000-000000000000",
- "instructions": [
- "TABLE-1"
], - "loyaltyTransaction": {
- "pointsEarned": 300,
- "bonusPointsEarned": 0,
- "id": "dcb1f1a7-d045-45ed-a1a7-cbe2de1b7b5d",
- "rewardsUsed": 0,
- "pointsUsed": 0,
- "pointsBalance": 0
}, - "number": "1234",
- "orderDiscounts": [
- {
- "type": "percentage",
- "value": 0,
- "plu": "string"
}
], - "referralPlatform": "ubereats",
- "serviceMode": "TAKEOUT",
- "status": "CREATED",
- "store": {
- "id": "42"
}, - "updatedAt": "1991-02-11T20:30:19Z",
- "payment": {
- "paymentMethod": "CREDIT_CARD",
- "paymentMethodBrand": "SODEXO",
- "total": {
- "currency": "USD",
- "amount": 100
}, - "amountLeftToBePaid": {
- "currency": "USD",
- "amount": 100
}, - "tip": {
- "currency": "USD",
- "amount": 100
}
}
}
}
Use this endpoint to provide updated status of an order that has been previously priced or committed via webhook.
Status updates that do not move the order status forward will be disregarded.
orderId required | string Unique Order ID |
externalReferenceId | string (ExternalReferenceId) External reference ID. An example might be the external menu selection ID, customer ID or order ID. | ||||||||||||||||||
status required | string (OrderStatus) Enum: "CREATED" "PRICED" "COMMITTED" "PREPARING" "PREPARED" "DONE" "CANCELED" "ERROR" Order status, representing current state of order in its lifecycle. When transitioning the order status, the status must always advance further in the lifecycle. All other transitions are invalid.
| ||||||||||||||||||
Array of objects (Order Error) Deprecated Any errors which occurred during order processing. Deprecated - Use partnerErrors instead. | |||||||||||||||||||
Array of ItemNotAvailable (object) or ItemPriceMismatch (object) or ItemNotFound (object) or StoreNotFound (object) or StoreClosed (object) or StoreNotOperating (object) or OrderNotFound (object) or OrderCancelled (object) (Partner Error) Any errors which occurred during order processing, which includes errors related to items, stores, or orders. |
{- "externalReferenceId": "string",
- "status": "CREATED",
- "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
]
}
{- "data": {
- "externalReferenceId": "string",
- "status": "CREATED",
- "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
]
}
}
Attempt to issue an order refund.
This request doesn't execute a refund it only asynchronously sends a request to issue an order refund.
Limited access - only for allowed partners
orderId required | string Unique Order ID |
issueId | string (IssueId) Enum: "7247" "6685" "7305" "7253" "7255" "7417" "7417" "6686" "7313" "7313" "6316" "7331" "6319" "6315" "6315" "6320" "7454" "6865" "6849" "6867" "6850" "6850" "6859" "6905" "6905" "6865" "6848" "6906" "6889" "6889" "6862" "6893" "6905" "6542" "7454" "7454" "7454" "7454" "7454" "6735" "6864" "6865" "6863" "6846" "6865" "6865" "6864" "7502" "7502" "7502" "7504" "7500" "7501" Example: "6320" IssueId of Sanity Support Subcategories Popeyes
BurgerKing
Tim Hortons
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
primaryReason required | string (PrimaryReason) Enum: "CATERING_ORDER_DECLINED" "CATERING_ORDER_ERROR" "CATERING_ORDER_TIME_OUT" "CUSTOMER_OVERCHARGED" "CUSTOMER_REQUESTED_CANCEL_ORDER" "FOOD_QUALITY_ISSUE" "INCORRECT_CUSTOMIZATION" "ITEMS_OUT_OF_STOCK" "MISSING_OR_INCORRECT_ITEM" "MOBILE_ORDERING_TECHNICAL_ISSUE" "ORDER_ARRIVED_LATE" "ORDER_CANCELLED" "ORDER_COMMIT_ERROR" "ORDER_NEVER_ARRIVED" "ORDER_WAS_DAMAGED" "OTHER_ADD_COMMENT" "RECEIVED_INCORRECT_ORDER" "RESTAURANT_CLOSED" "RESTAURANT_COULDNT_FIND_ORDER" Reason of the attempt to an order refund | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
refundMethod required | string (RefundMethod) Enum: "CUSTOMER" "SUPPORT" "AUTO" Choose which workflow of the refund is run CUSTOMER: It's run when a customer requested a refund. This flow will leave a slug about the refund in the Support Ticket based on chosen issueId. This flow sends an email to customer about money refund. SUPPORT: This flow should be executed when Support Team executes the refund. It sends an email to customer about money refund. AUTO: This flow sends an email to customer about order cancellation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requestedAmountCents required | number <integer> (Amount) Example: "100" Attempt for the amount of cents to refund |
{- "issueId": "6320",
- "primaryReason": "CATERING_ORDER_DECLINED",
- "refundMethod": "CUSTOMER",
- "requestedAmountCents": 100
}
{- "status": 400,
- "code": "ValidationError",
- "message": "isAvailable must be a boolean value",
- "errors": [
- {
- "code": "ValidationError",
- "message": "string",
- "details": { },
- "domain": "string",
- "location": "isAvailable",
- "locationType": "requestBody",
- "sendReport": "string",
- "extendedHelp": "string"
}
]
}
Notify RBI about the lead time to when the order is scheduled to fire.
orderId required | string Unique Order ID |
type required | string Enum: "EMAIL" "PUSH" |
required | object |
{- "type": "EMAIL",
- "params": {
- "eventName": "order_awaiting_firing",
- "minutesToFire": 45
}
}
{- "status": 400,
- "code": "ValidationError",
- "message": "isAvailable must be a boolean value",
- "errors": [
- {
- "code": "ValidationError",
- "message": "string",
- "details": { },
- "domain": "string",
- "location": "isAvailable",
- "locationType": "requestBody",
- "sendReport": "string",
- "extendedHelp": "string"
}
]
}
Utilize this endpoint to capture the pre-authorized amount, which will be triggered before the order is ready for processing.
This allows customers some time to cancel their orders, thereby preventing unnecessary refund API calls for each canceled order
orderId required | string Unique Order ID |
{- "status": 400,
- "code": "ValidationError",
- "message": "isAvailable must be a boolean value",
- "errors": [
- {
- "code": "ValidationError",
- "message": "string",
- "details": { },
- "domain": "string",
- "location": "isAvailable",
- "locationType": "requestBody",
- "sendReport": "string",
- "extendedHelp": "string"
}
]
}
Creates a delivery for a single order
orderId required | string Example: dd0c7c09-4769-40d8-9d05 Unique ID representing an order |
x-ui-region required | string Example: US Country or region of the order restaurant. Format is in the Unicode Common Locale Data Repository (CLDR).
For example, the code for the United States is |
{- "data": {
- "orderId": "624f2770-8ad2-11ee-b9d1",
- "status": "CREATED"
}
}
Update delivery details for a single order
orderId required | string Unique ID representing an order |
status required | string (DeliveryStatus) Enum: "DELIVERY_CREATED" "DRIVER_ASSIGNED" "DRIVER_STARTING" "DRIVER_AT_STORE" "ORDER_PICKED_UP" "DRIVER_AT_CUSTOMER" "ORDER_DROPPED_OFF" "DRIVER_UNASSIGNED" "ORDER_CANCELLED" "ERROR" Delivery status, representing current state of delivery order in its lifecycle.
| ||||||||||||||||||||||
object (TimeInterval) The time window during which the pickup is expected. | |||||||||||||||||||||||
object (TimeInterval) The time window during which the delivery is expected. | |||||||||||||||||||||||
dropoffEta | string <ISO 8601 Date Time> (DateTime) Example: "1991-02-11T20:30:19Z" Extimated dropoff time (ETA) | ||||||||||||||||||||||
object Optionally provided cancellation details if the fulfillment provider has cancelled for any reason | |||||||||||||||||||||||
object (Courier) Courier information | |||||||||||||||||||||||
pincode | string Example: "1234" In cases of suspected fraud, the last-mile provider can generate a PIN code to confirm the delivery |
{- "status": "DELIVERY_CREATED",
- "pickupWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "dropoffWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "dropoffEta": "1991-02-11T20:30:19Z",
- "cancellation": {
- "comments": "string",
- "reason": "WRONG_ADDRESS"
}, - "courier": {
- "transportType": "CAR",
- "location": {
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "profileImage": {
- "url": "string",
- "altText": "string"
}, - "phone": "string"
}, - "pincode": 1234
}
{- "status": 400,
- "code": "ValidationError",
- "message": "isAvailable must be a boolean value",
- "errors": [
- {
- "code": "ValidationError",
- "message": "string",
- "details": { },
- "domain": "string",
- "location": "isAvailable",
- "locationType": "requestBody",
- "sendReport": "string",
- "extendedHelp": "string"
}
]
}
Store List.
Use this endpoint get a list of stores and their info.
Pagination
Pagination is provided in a cursor-basis. For each set of results, a cursor
will be returned as part of the
response's meta
. Providing this cursor
to the next call will fetch the next page of the result set.
The max amount of restaurants to be returned is controlled by limit
limit | integer (Limit) [ 1 .. 100 ] Default: 20 Example: limit=10 Number of results to fetch |
cursor | string (Cursor) Example: cursor=cursor-id Pagination cursor |
x-ui-region | string Example: US The Unicode Common Locale Data Repository (CLDR) region code of the country or region of the address. For the full list of country codes, refer to the CLDR Chart. |
{- "meta": {
- "cursor": "cursor-id"
}, - "data": [
- {
- "availability": {
- "isOpen": true
}, - "franchiseGroupName": "Acme Group",
- "location": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5701 BLUE LAGOON DR, MIAMI, FL 33126",
- "locality": "MIAMI",
- "phoneNumber": "555-555-5555",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "5701 BLUE LAGOON DR"
}, - "name": "Example test lab",
- "posVendor": "CARROLS",
- "serviceHour": [
- {
- "serviceMode": "TAKEOUT",
- "timeSlots": [
- {
- "closes": "1991-02-11 23:59:00",
- "date": "1991-02-11",
- "isClosed": true,
- "opens": "1991-02-11 00:00:00"
}
], - "weekdayHours": [
- {
- "text": "Sunday: 12:00 AM - 11:59 PM"
}
]
}
], - "storeId": "42",
- "timezone": "America/New_York"
}
]
}
Store (restaurant) details.
Use this endpoint get the full details of a specific store.
storeId required | string Unique ID representing a store |
x-ui-region | string Example: US The Unicode Common Locale Data Repository (CLDR) region code of the country or region of the address. For the full list of country codes, refer to the CLDR Chart. |
{- "data": {
- "availability": {
- "isOpen": true
}, - "franchiseGroupName": "Acme Group",
- "location": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5701 BLUE LAGOON DR, MIAMI, FL 33126",
- "locality": "MIAMI",
- "phoneNumber": "555-555-5555",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "5701 BLUE LAGOON DR"
}, - "name": "Example test lab",
- "posVendor": "CARROLS",
- "serviceHour": [
- {
- "serviceMode": "TAKEOUT",
- "timeSlots": [
- {
- "closes": "1991-02-11 23:59:00",
- "date": "1991-02-11",
- "isClosed": true,
- "opens": "1991-02-11 00:00:00"
}
], - "weekdayHours": [
- {
- "text": "Sunday: 12:00 AM - 11:59 PM"
}
]
}
], - "storeId": "42",
- "timezone": "America/New_York"
}
}
Get store status.
Use this endpoint to determine whether a store is available for ordering.
storeId required | string Unique ID representing a store |
{- "data": {
- "isAvailable": true,
- "isOnline": true,
- "lastOnline": "1991-02-11T20:30:19Z"
}
}
Update heartbeat status for a given store. This endpoint should be executed periodically (eg. every 5 minutes).
storeId required | string Unique ID representing a store |
isOnline required | boolean Whether the store is "online" (able to receive mobile orders). |
{- "isOnline": true
}
{- "data": {
- "isAvailable": true,
- "isOnline": true,
- "lastOnline": "1991-02-11T20:30:19Z"
}
}
Get full menu for an individual store
The menu response is a "flat" JSON (it doesn't have nested structures). All fields are root level properties, so you can refer to them simply by ID. The below example is a walk-through from menu to modifier.
Tenders example | Type | ID | Name |
---|---|---|---|
Menu | Group | menu_1 | Menu |
Section | Group | 4763b543-2d04-40a6-8b95-d55750ec554a | Tenders |
Picker | Group | xdgrygmaqSf78Pjdh6UrTF | 3Pc Tenders Meal |
picker_pickerAspect | Group | xdgrygmaqSf78Pjdh6UrTF-76b9c2d3-536e-46bb-a060-f805a63b0063 | Choose a Size |
picker_pickerAspectOption | Group | xdgrygmaqSf78Pjdh6UrTF-medium | Large Combo |
picker_pickerAspect_pickerAspectOption_pickerAspect | Group | xdgrygmaqSf78Pjdh6UrTF-76b9c2d3-536e-46bb-a060-f805a63b0063-medium-b376ee07-5ba9-464d-a3b0-e79ad3643e2a | Choice of Tenders Preparation |
picker_pickerAspectOption_pickerAspectOption2 | Group | xdgrygmaqSf78Pjdh6UrTF-medium-spicy | Spicy |
combo | Combo | 00cc6fc6-5ce7-4361-aa95-9d6d726b5bbd | 3Pc Tenders Medium Combo - Spicy |
comboSlot | Group | group_item_40961 | Main Item |
comboSlotOption | Group | option_group_item_40961 | N/A |
item | Item | item_40961 | 3Pc Tenders - Spicy |
modifierGroup | Group | ModifierGroup_60 | Sauces - 1 Included |
modifier | Modifier | modifierMultiplier_1-00-163758 | Tartar Sauce |
Default entry: For each Picker & Modifier Group, each group will have a property, “defaultSelection”. DefaultSelection will have an ID for an entry that is default for that group
GROUPS: The menu has four types: Combo, Item, Group and Modifier. The group type exists to wrap relevant references to walk through the menu. Only Combo, Item and Modifier will be passed to and committed to POS in Cart.
Types of Groups | Description | Display type |
---|---|---|
Menu | Group of Sections | List |
Section | Section is a broad container. It can contain pickers, items , combos as well as other sections | List |
Picker | Pickers allows an step by step selection process that ultimate resolve in Combos or Item. Pickers have only one immediate child, a reference to the first aspect. | Single entry |
Picker Aspect | Group of Picker Aspect Options | Select |
Picker Aspect Option | Group of picker Options - References the next aspect for the picker. The picker options of the last aspect reference the final selection result (combo/item) | Single entry |
Combo Slot | Group of Combo Slot Options | Select |
Combo Slot Option | References Combo Slot Option | Single entry |
Modifier Group | Group of Modifiers | Multi-select |
Group display type | Description |
---|---|
List | Group of Sections & Pickers(subsections) |
Single-Entry | One option that maps to options to select from (Size, Choice of Prep) |
Select | Group with Single Selection Option |
Multi-Select | Group with Multiple Selection Options |
storeId required | string (StoreId) ^\d+$ Example: 42 Unique Store ID |
channel required | string (Channel Name) Example: whitelabel Channel name |
serviceMode required | string (Service Mode) Enum: "CURBSIDE" "DELIVERY" "DRIVE_THRU" "EAT_IN" "TABLE_SERVICE" "TAKEOUT" Example: TAKEOUT Service mode |
override | any (Override) Value: "lateNight" Example: override=lateNight The override param is used to handle menu operations using the override pricing |
version | string Example: version=1 Menu version ID |
x-ui-region | string Example: US The Unicode Common Locale Data Repository (CLDR) region code of the country or region of the address. For the full list of country codes, refer to the CLDR Chart. |
{- "data": {
- "meta": {
- "brand": "PLK",
- "currency": "USD",
- "locale": "en_us",
- "serviceMode": "delivery",
- "version": "xyz1"
}, - "dayParts": [
- {
- "id": "breakfast",
- "daysOfWeek": [
- "saturday",
- "sunday"
], - "startTime": "07:00:00",
- "endTime": "22:00:00"
}
], - "rootMenuEntryId": "entry-id",
- "entries": [
- {
- "id": "entry-id",
- "referenceId": "entry-id",
- "type": "COMBO",
- "groupType": "ASPECT_OPTION",
- "name": "string",
- "description": "string",
- "available": true,
- "image": {
- "url": "string",
- "altText": "string"
}, - "isPremium": true,
- "price": {
- "default": 0,
- "max": 0,
- "min": 0
}, - "options": {
- "quantityConstraints": {
- "defaultAmount": 0,
- "minAmount": 0,
- "maxAmount": 0
}, - "defaultSelections": [
- "entry-id"
], - "displayType": "LIST",
- "entries": [
- {
- "amount": 0,
- "entryId": "entry-id"
}
]
}, - "dayParts": [
- "breakfast"
], - "translations": [
- {
- "description": "Notre sandwich WHOPPER® est fait d'un quart de livre de savoureux bœuf grillé sur le feu, garni de tomates juteuses, de laitue fraîche, de mayonnaise onctueuse, de cornichons croquants et d'oignons blancs émincés. Le tout est servi sur un pain aux graines de sésame grillé à point.\n",
- "lang": "fr",
- "name": "Le Whopper"
}
], - "nutrition": {
- "calories": {
- "default": 0,
- "displayType": "Range",
- "lowerRange": 0,
- "upperRange": 0
}, - "nutrients": [
- {
- "name": "SODIUM",
- "value": 0,
- "unit": "G"
}
], - "allergens": [
- {
- "allergen": "PEANUTS",
- "contains": 0
}
]
}, - "nutritionWithModifiers": {
- "calories": {
- "default": 0,
- "displayType": "Range",
- "lowerRange": 0,
- "upperRange": 0
}, - "nutrients": [
- {
- "name": "SODIUM",
- "value": 0,
- "unit": "G"
}
], - "allergens": [
- {
- "allergen": "PEANUTS",
- "contains": 0
}
]
}, - "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}
}
], - "rewardEntries": [
- {
- "id": "foo-reward-entity-id",
- "type": "REWARD",
- "name": "4pc Nuggets",
- "description": "4pc Nuggets",
- "availability": true,
- "discountType": "PERCENTAGE",
- "discountValue": 40,
- "loyaltyPoints": "250",
- "price": {
- "default": 0,
- "max": 0,
- "min": 0
}, - "quantityConstraints": {
- "defaultAmount": 0,
- "minAmount": 0,
- "maxAmount": 0
}, - "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}, - "options": {
- "entries": [
- {
- "entryId": "entry-id",
- "type": "ENTRY"
}
]
}
}
], - "systemWideOfferEntries": [
- {
- "id": "foo-offer-entity-id",
- "type": "SYSTEM_WIDE_OFFER",
- "name": "$5 Double Whopper and Small Fries",
- "description": "1 Double Whopper and 1 Small Fries",
- "availability": true,
- "discountType": "PERCENTAGE",
- "discountValue": 40,
- "loyaltyPoints": 100,
- "price": {
- "default": 0,
- "max": 0,
- "min": 0
}, - "quantityConstraints": {
- "defaultAmount": 0,
- "minAmount": 0,
- "maxAmount": 0
}, - "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}, - "options": {
- "entries": [
- {
- "entryId": "entry-id",
- "type": "ENTRY"
}
]
}
}
], - "configOfferEntries": [
- {
- "id": "entry-id",
- "type": "CONFIG_OFFER",
- "name": "string",
- "description": "string",
- "availability": true,
- "discountType": "PERCENTAGE",
- "discountValue": 40,
- "loyaltyPoints": "250",
- "price": {
- "default": 0,
- "max": 0,
- "min": 0
}, - "quantityConstraints": {
- "defaultAmount": 0,
- "minAmount": 0,
- "maxAmount": 0
}, - "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}, - "options": {
- "entries": [
- {
- "entryId": "entry-id",
- "type": "ENTRY"
}
]
}
}
]
}
}
Get full brand-menu for a channel. The brand-menu is not store specific, but it is the source of content used to generate the store-menu. Differently from the store-menu, the brand-menu does not have any price and availability information.
channel required | string (Channel Name) Example: whitelabel Channel name |
{- "data": {
- "createdAt": "string",
- "configOfferEntities": {
- "property1": {
- "_id": "string",
- "description": {
- "_type": "localeBlockContent",
- "de": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "en": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "es": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "fr": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "it": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
]
}, - "discountType": "string",
- "discountValue": 0,
- "loyaltyEngineId": "string",
- "loyaltyPoints": 0,
- "maxAmount": 0,
- "minAmount": 0,
- "name": null,
- "options": [
- {
- "entries": [
- {
- "entryId": "string",
- "isHidden": true,
- "isMainItem": true,
- "type": "configOfferItem"
}
], - "maxAmount": 0,
- "minAmount": 0
}
], - "type": "string",
- "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}, - "_type": "systemWideOfferItem"
}, - "property2": {
- "_id": "string",
- "description": {
- "_type": "localeBlockContent",
- "de": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "en": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "es": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "fr": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "it": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
]
}, - "discountType": "string",
- "discountValue": 0,
- "loyaltyEngineId": "string",
- "loyaltyPoints": 0,
- "maxAmount": 0,
- "minAmount": 0,
- "name": null,
- "options": [
- {
- "entries": [
- {
- "entryId": "string",
- "isHidden": true,
- "isMainItem": true,
- "type": "configOfferItem"
}
], - "maxAmount": 0,
- "minAmount": 0
}
], - "type": "string",
- "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}, - "_type": "systemWideOfferItem"
}
}, - "donationItems": {
- "property1": {
- "_id": "string",
- "_type": "item",
- "activationDate": "string",
- "allergens": {
- "_type": "opAllergen",
- "celery": 0,
- "eggs": 0,
- "fish": 0,
- "gluten": 0,
- "lupin": 0,
- "milk": 0,
- "mustard": 0,
- "peanuts": 0,
- "sesame": 0,
- "shellfish": 0,
- "soy": 0,
- "sulphurDioxide": 0,
- "treeNuts": 0,
- "wheat": 0
}, - "calories": {
- "default": 0,
- "max": 0,
- "min": 0
}, - "deactivationDate": "string",
- "description": {
- "_type": "localeBlockContent",
- "de": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "en": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "es": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "fr": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "it": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
]
}, - "image": {
- "asset": {
- "_id": "string",
- "_ref": "string",
- "_type": "reference"
}, - "_type": "image"
}, - "imageDescription": {
- "_type": "localeString",
- "de": "string",
- "en": "string",
- "fr": "string",
- "it": "string"
}, - "name": {
- "_type": "localeString",
- "de": "string",
- "en": "string",
- "fr": "string",
- "it": "string"
}, - "nutrition": {
- "_type": "nutrition",
- "calories": 0,
- "caloriesPer100": 0,
- "carbohydrates": 0,
- "carbohydratesPer100": 0,
- "cholesterol": 0,
- "energyKJ": 0,
- "energyKJPer100": 0,
- "fat": 0,
- "fatPer100": 0,
- "fiber": 0,
- "proteins": 0,
- "proteinsPer100": 0,
- "salt": 0,
- "saltPer100": 0,
- "saturatedFat": 0,
- "saturatedFatPer100": 0,
- "sodium": 0,
- "sugar": 0,
- "sugarPer100": 0,
- "transFat": 0,
- "weight": 0
}, - "nutritionWithModifiers": {
- "_type": "nutrition",
- "calories": 0,
- "caloriesPer100": 0,
- "carbohydrates": 0,
- "carbohydratesPer100": 0,
- "cholesterol": 0,
- "energyKJ": 0,
- "energyKJPer100": 0,
- "fat": 0,
- "fatPer100": 0,
- "fiber": 0,
- "proteins": 0,
- "proteinsPer100": 0,
- "salt": 0,
- "saltPer100": 0,
- "saturatedFat": 0,
- "saturatedFatPer100": 0,
- "sodium": 0,
- "sugar": 0,
- "sugarPer100": 0,
- "transFat": 0,
- "weight": 0
}, - "operationalItem": {
- "daypart": [ ],
- "items": "string",
- "launchDate": "string",
- "name": "string",
- "opLaunchDate": "string",
- "opProduct": "string",
- "opProductNumber": 0,
- "product": "string",
- "productNumber": 0
}, - "showInStaticMenu": true,
- "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}
}, - "property2": {
- "_id": "string",
- "_type": "item",
- "activationDate": "string",
- "allergens": {
- "_type": "opAllergen",
- "celery": 0,
- "eggs": 0,
- "fish": 0,
- "gluten": 0,
- "lupin": 0,
- "milk": 0,
- "mustard": 0,
- "peanuts": 0,
- "sesame": 0,
- "shellfish": 0,
- "soy": 0,
- "sulphurDioxide": 0,
- "treeNuts": 0,
- "wheat": 0
}, - "calories": {
- "default": 0,
- "max": 0,
- "min": 0
}, - "deactivationDate": "string",
- "description": {
- "_type": "localeBlockContent",
- "de": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "en": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "es": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "fr": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "it": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
]
}, - "image": {
- "asset": {
- "_id": "string",
- "_ref": "string",
- "_type": "reference"
}, - "_type": "image"
}, - "imageDescription": {
- "_type": "localeString",
- "de": "string",
- "en": "string",
- "fr": "string",
- "it": "string"
}, - "name": {
- "_type": "localeString",
- "de": "string",
- "en": "string",
- "fr": "string",
- "it": "string"
}, - "nutrition": {
- "_type": "nutrition",
- "calories": 0,
- "caloriesPer100": 0,
- "carbohydrates": 0,
- "carbohydratesPer100": 0,
- "cholesterol": 0,
- "energyKJ": 0,
- "energyKJPer100": 0,
- "fat": 0,
- "fatPer100": 0,
- "fiber": 0,
- "proteins": 0,
- "proteinsPer100": 0,
- "salt": 0,
- "saltPer100": 0,
- "saturatedFat": 0,
- "saturatedFatPer100": 0,
- "sodium": 0,
- "sugar": 0,
- "sugarPer100": 0,
- "transFat": 0,
- "weight": 0
}, - "nutritionWithModifiers": {
- "_type": "nutrition",
- "calories": 0,
- "caloriesPer100": 0,
- "carbohydrates": 0,
- "carbohydratesPer100": 0,
- "cholesterol": 0,
- "energyKJ": 0,
- "energyKJPer100": 0,
- "fat": 0,
- "fatPer100": 0,
- "fiber": 0,
- "proteins": 0,
- "proteinsPer100": 0,
- "salt": 0,
- "saltPer100": 0,
- "saturatedFat": 0,
- "saturatedFatPer100": 0,
- "sodium": 0,
- "sugar": 0,
- "sugarPer100": 0,
- "transFat": 0,
- "weight": 0
}, - "operationalItem": {
- "daypart": [ ],
- "items": "string",
- "launchDate": "string",
- "name": "string",
- "opLaunchDate": "string",
- "opProduct": "string",
- "opProductNumber": 0,
- "product": "string",
- "productNumber": 0
}, - "showInStaticMenu": true,
- "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}
}
}, - "entities": {
- "property1": {
- "_id": "string",
- "_type": "item",
- "activationDate": "string",
- "allergens": {
- "_type": "opAllergen",
- "celery": 0,
- "eggs": 0,
- "fish": 0,
- "gluten": 0,
- "lupin": 0,
- "milk": 0,
- "mustard": 0,
- "peanuts": 0,
- "sesame": 0,
- "shellfish": 0,
- "soy": 0,
- "sulphurDioxide": 0,
- "treeNuts": 0,
- "wheat": 0
}, - "calories": {
- "default": 0,
- "max": 0,
- "min": 0
}, - "deactivationDate": "string",
- "description": {
- "_type": "localeBlockContent",
- "de": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "en": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "es": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "fr": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "it": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
]
}, - "image": {
- "asset": {
- "_id": "string",
- "_ref": "string",
- "_type": "reference"
}, - "_type": "image"
}, - "imageDescription": {
- "_type": "localeString",
- "de": "string",
- "en": "string",
- "fr": "string",
- "it": "string"
}, - "name": {
- "_type": "localeString",
- "de": "string",
- "en": "string",
- "fr": "string",
- "it": "string"
}, - "nutrition": {
- "_type": "nutrition",
- "calories": 0,
- "caloriesPer100": 0,
- "carbohydrates": 0,
- "carbohydratesPer100": 0,
- "cholesterol": 0,
- "energyKJ": 0,
- "energyKJPer100": 0,
- "fat": 0,
- "fatPer100": 0,
- "fiber": 0,
- "proteins": 0,
- "proteinsPer100": 0,
- "salt": 0,
- "saltPer100": 0,
- "saturatedFat": 0,
- "saturatedFatPer100": 0,
- "sodium": 0,
- "sugar": 0,
- "sugarPer100": 0,
- "transFat": 0,
- "weight": 0
}, - "nutritionWithModifiers": {
- "_type": "nutrition",
- "calories": 0,
- "caloriesPer100": 0,
- "carbohydrates": 0,
- "carbohydratesPer100": 0,
- "cholesterol": 0,
- "energyKJ": 0,
- "energyKJPer100": 0,
- "fat": 0,
- "fatPer100": 0,
- "fiber": 0,
- "proteins": 0,
- "proteinsPer100": 0,
- "salt": 0,
- "saltPer100": 0,
- "saturatedFat": 0,
- "saturatedFatPer100": 0,
- "sodium": 0,
- "sugar": 0,
- "sugarPer100": 0,
- "transFat": 0,
- "weight": 0
}, - "operationalItem": {
- "daypart": [ ],
- "items": "string",
- "launchDate": "string",
- "name": "string",
- "opLaunchDate": "string",
- "opProduct": "string",
- "opProductNumber": 0,
- "product": "string",
- "productNumber": 0
}, - "showInStaticMenu": true,
- "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}
}, - "property2": {
- "_id": "string",
- "_type": "item",
- "activationDate": "string",
- "allergens": {
- "_type": "opAllergen",
- "celery": 0,
- "eggs": 0,
- "fish": 0,
- "gluten": 0,
- "lupin": 0,
- "milk": 0,
- "mustard": 0,
- "peanuts": 0,
- "sesame": 0,
- "shellfish": 0,
- "soy": 0,
- "sulphurDioxide": 0,
- "treeNuts": 0,
- "wheat": 0
}, - "calories": {
- "default": 0,
- "max": 0,
- "min": 0
}, - "deactivationDate": "string",
- "description": {
- "_type": "localeBlockContent",
- "de": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "en": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "es": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "fr": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "it": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
]
}, - "image": {
- "asset": {
- "_id": "string",
- "_ref": "string",
- "_type": "reference"
}, - "_type": "image"
}, - "imageDescription": {
- "_type": "localeString",
- "de": "string",
- "en": "string",
- "fr": "string",
- "it": "string"
}, - "name": {
- "_type": "localeString",
- "de": "string",
- "en": "string",
- "fr": "string",
- "it": "string"
}, - "nutrition": {
- "_type": "nutrition",
- "calories": 0,
- "caloriesPer100": 0,
- "carbohydrates": 0,
- "carbohydratesPer100": 0,
- "cholesterol": 0,
- "energyKJ": 0,
- "energyKJPer100": 0,
- "fat": 0,
- "fatPer100": 0,
- "fiber": 0,
- "proteins": 0,
- "proteinsPer100": 0,
- "salt": 0,
- "saltPer100": 0,
- "saturatedFat": 0,
- "saturatedFatPer100": 0,
- "sodium": 0,
- "sugar": 0,
- "sugarPer100": 0,
- "transFat": 0,
- "weight": 0
}, - "nutritionWithModifiers": {
- "_type": "nutrition",
- "calories": 0,
- "caloriesPer100": 0,
- "carbohydrates": 0,
- "carbohydratesPer100": 0,
- "cholesterol": 0,
- "energyKJ": 0,
- "energyKJPer100": 0,
- "fat": 0,
- "fatPer100": 0,
- "fiber": 0,
- "proteins": 0,
- "proteinsPer100": 0,
- "salt": 0,
- "saltPer100": 0,
- "saturatedFat": 0,
- "saturatedFatPer100": 0,
- "sodium": 0,
- "sugar": 0,
- "sugarPer100": 0,
- "transFat": 0,
- "weight": 0
}, - "operationalItem": {
- "daypart": [ ],
- "items": "string",
- "launchDate": "string",
- "name": "string",
- "opLaunchDate": "string",
- "opProduct": "string",
- "opProductNumber": 0,
- "product": "string",
- "productNumber": 0
}, - "showInStaticMenu": true,
- "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}
}
}, - "rewardEntities": {
- "property1": {
- "_id": "string",
- "description": {
- "_type": "localeBlockContent",
- "de": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "en": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "es": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "fr": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "it": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
]
}, - "discountType": "string",
- "discountValue": 0,
- "loyaltyEngineId": "string",
- "loyaltyPoints": 0,
- "maxAmount": 0,
- "minAmount": 0,
- "name": null,
- "options": [
- {
- "entries": [
- {
- "entryId": "string",
- "isHidden": true,
- "isMainItem": true,
- "type": "configOfferItem"
}
], - "maxAmount": 0,
- "minAmount": 0
}
], - "type": "string",
- "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}, - "_type": "configOfferItem"
}, - "property2": {
- "_id": "string",
- "description": {
- "_type": "localeBlockContent",
- "de": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "en": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "es": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "fr": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "it": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
]
}, - "discountType": "string",
- "discountValue": 0,
- "loyaltyEngineId": "string",
- "loyaltyPoints": 0,
- "maxAmount": 0,
- "minAmount": 0,
- "name": null,
- "options": [
- {
- "entries": [
- {
- "entryId": "string",
- "isHidden": true,
- "isMainItem": true,
- "type": "configOfferItem"
}
], - "maxAmount": 0,
- "minAmount": 0
}
], - "type": "string",
- "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}, - "_type": "configOfferItem"
}
}, - "parentId": "string",
- "systemWideOfferEntities": {
- "property1": {
- "_id": "string",
- "description": {
- "_type": "localeBlockContent",
- "de": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "en": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "es": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "fr": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "it": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
]
}, - "discountType": "string",
- "discountValue": 0,
- "loyaltyEngineId": "string",
- "loyaltyPoints": 0,
- "maxAmount": 0,
- "minAmount": 0,
- "name": null,
- "options": [
- {
- "entries": [
- {
- "entryId": "string",
- "isHidden": true,
- "isMainItem": true,
- "type": "configOfferItem"
}
], - "maxAmount": 0,
- "minAmount": 0
}
], - "type": "string",
- "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}, - "_type": "systemWideOfferItem"
}, - "property2": {
- "_id": "string",
- "description": {
- "_type": "localeBlockContent",
- "de": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "en": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "es": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "fr": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
], - "it": [
- {
- "_key": "string",
- "_type": "block",
- "children": [
- {
- "_key": "string",
- "_type": "span",
- "marks": [
- { }
], - "text": "string"
}
], - "markDefs": [ ],
- "placeholder": true,
- "style": "string"
}
]
}, - "discountType": "string",
- "discountValue": 0,
- "loyaltyEngineId": "string",
- "loyaltyPoints": 0,
- "maxAmount": 0,
- "minAmount": 0,
- "name": null,
- "options": [
- {
- "entries": [
- {
- "entryId": "string",
- "isHidden": true,
- "isMainItem": true,
- "type": "configOfferItem"
}
], - "maxAmount": 0,
- "minAmount": 0
}
], - "type": "string",
- "vendorConfigs": {
- "carrols": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "carrolsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "hdx": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncr": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "ncrDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheics": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "oheicsDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partner": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "partnerDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumber": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "productNumberDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdi": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qdiDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qst": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "qstDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rpos": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "rposDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicom": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "sicomDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "simplyDeliveryDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tablet": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}, - "tabletDelivery": {
- "pluType": "constantPlu",
- "constantPlu": 12414,
- "multiConstantPlus": [
- {
- "plu": 12414,
- "qualifier": "string",
- "quantity": 0
}
], - "parentChildPlu": {
- "childPlu": "string",
- "plu": "string"
}, - "sizeBasedPlu": {
- "comboPlu": "string",
- "comboSize": "string"
}
}
}, - "_type": "systemWideOfferItem"
}
}, - "version": "string"
}
}
Get price and availability for all entries in the store's menu, by PLU.
storeId required | string (StoreId) ^\d+$ Example: 42 Unique Store ID |
{- "data": {
- "plus": [
- {
- "plu": "string",
- "withAllDescendentPlus": [
- "string"
], - "prices": [
- {
- "price": {
- "currency": "USD",
- "amount": 100
}, - "channel": "WHITELABEL_IN_STORE"
}
]
}
]
}
}
Update PLUs store in the store menu, setting price and availability
Updates are made according to the "PLU" or partner specific identifier associated with each menu entry. Any PLU which is not included in this request will be marked as unavailable for all configured channels.
storeId required | string Unique ID representing a store |
required | Array of objects All PLUs available in the store menu with price information |
{- "plus": [
- {
- "plu": "string",
- "withAllDescendentPlus": [
- "string"
], - "prices": [
- {
- "price": {
- "currency": "USD",
- "amount": 100
}, - "channel": "WHITELABEL_IN_STORE"
}
]
}
]
}
{- "data": {
- "plus": [
- {
- "plu": "string",
- "withAllDescendentPlus": [
- "string"
], - "prices": [
- {
- "price": {
- "currency": "USD",
- "amount": 100
}, - "channel": "WHITELABEL_IN_STORE"
}
]
}
]
}
}
Get price and availability for all entries in the store's menu, by PLU.
storeId required | string (StoreId) ^\d+$ Example: 42 Unique Store ID |
serviceMode required | string (Service Mode) Enum: "pickup" "delivery" Example: delivery Service mode |
channel required | string (Channel Name) Example: whitelabel Channel name |
plus | Array of strings Example: plus=1000&plus=1001 The plus attribute allows users to specify a list of plus to filter the results. |
{- "data": [
- {
- "availability": true,
- "channel": "string",
- "country": "US",
- "overrides": [
- {
- "id": "lateNight",
- "price": 500
}
], - "endDate": 1673872934,
- "plu": "string",
- "price": 500,
- "priority": 1,
- "repetition": [
- "Mo",
- "Fr"
], - "startDate": 1673872934,
- "serviceMode": "delivery",
- "storeId": "641234",
- "version": 20240108163635030
}
], - "meta": {
- "version": 1673872934
}
}
Updates multiple PLU pricing and availability for multiple stores, given a serviceMode.
Array of objects (Store Menu Plu) | |
channel required | string (Channel) Example: "whitelabel" Store's Channel |
region required | string (Region) Example: "US" Country described using ISO Country Code 2 characters |
serviceMode required | string Example: "delivery" Plu Serivce Mode |
storeIds required | Array of strings Example: "100" The ids of stores where the PLUs should be updated |
{- "plus": [
- {
- "availability": true,
- "overrides": [
- {
- "id": "lateNight",
- "price": 500
}
], - "endDate": 1673872934,
- "plu": "string",
- "price": 500,
- "priority": 1,
- "repetition": [
- "Mo",
- "Fr"
], - "startDate": 1673872934
}
], - "channel": "whitelabel",
- "region": "US",
- "serviceMode": "delivery",
- "storeIds": [
- "100"
]
}
{- "data": {
- "version": 1689340763000
}
}
For a given store, serviceMode and channel combination, it provides a history of versions starting from the provided version number. This history contains key/value pairs where the keys refer to a given version and the value contains one object with the created, updated and deleted information for the given version.
storeId required | string (StoreId) ^\d+$ Example: 42 Unique Store ID |
serviceMode required | string (Service Mode) Enum: "pickup" "delivery" Example: delivery Service mode |
channel required | string (Channel Name) Example: whitelabel Channel name |
version required | number (Timestamp) Example: 1679400708 This is the starting point from which the diff with the latest version will be generated from. |
{- "data": {
- "20231004193130033": {
- "created": [
- {
- "availability": true,
- "channel": "whitelabel",
- "country": "PT",
- "endDate": 1673872934,
- "plu": "1000",
- "price": 500,
- "priority": 1,
- "repetition": [
- "Mo",
- "Fr"
], - "startDate": 1673872934,
- "serviceMode": "delivery",
- "storeId": "641234",
- "version": 20231004193130030
}
], - "updated": [
- {
- "availability": true,
- "channel": "whitelabel",
- "country": "PT",
- "endDate": 1673872934,
- "plu": "2000",
- "price": 503,
- "priority": 1,
- "repetition": [
- "Mo",
- "Fr"
], - "startDate": 1673872934,
- "serviceMode": "delivery",
- "storeId": "641234",
- "version": 20231004193130030
}
], - "deleted": [
- {
- "availability": true,
- "channel": "whitelabel",
- "country": "PT",
- "endDate": 1673872934,
- "plu": "1500",
- "price": 501,
- "priority": 1,
- "repetition": [
- "Mo",
- "Fr"
], - "startDate": 1673872934,
- "serviceMode": "delivery",
- "storeId": "641234",
- "version": 20231004193130030
}
]
}, - "20231004203130032": {
- "created": [
- {
- "availability": true,
- "channel": "whitelabel",
- "country": "PT",
- "endDate": 1673872934,
- "plu": "1000",
- "price": 100,
- "priority": 1,
- "repetition": [
- "Mo",
- "Fr"
], - "startDate": 1673872934,
- "serviceMode": "delivery",
- "storeId": "641234",
- "version": 20231004203130030
}
], - "updated": [
- {
- "availability": false,
- "channel": "whitelabel",
- "country": "PT",
- "endDate": 1673872934,
- "plu": "2000",
- "price": 503,
- "priority": 1,
- "repetition": [
- "Mo",
- "Fr"
], - "startDate": 1673872934,
- "serviceMode": "delivery",
- "storeId": "641234",
- "version": 20231004203130030
}
], - "deleted": [
- {
- "availability": true,
- "channel": "whitelabel",
- "country": "PT",
- "endDate": 1673872934,
- "plu": "1500",
- "price": 600,
- "priority": 1,
- "repetition": [
- "Mo",
- "Fr"
], - "startDate": 1673872934,
- "serviceMode": "delivery",
- "storeId": "641234",
- "version": 20231004203130030
}
]
}
}
}
Use this endpoint to sign up a new user
dob | string Example: "1980-02-02" Date of Birth in YYYY-MM-DD format. |
name | string Example: "John Smith" Customer name |
phoneNumber | string Example: "+35123123131" Customer phone number starting with the country code. |
username required | string Example: "username@example.com" Customer username. |
acceptedPromotionalEmails | boolean Example: "true" Whether customer accepts promotional email |
acceptedPush | boolean Example: "true" Whether customer accepts push notification |
gender | string Enum: "FEMALE" "MALE" Customer gender |
required | object (Address) Customer address |
Array of objects Any errors which occurred during order processing |
{- "dob": "1980-02-02",
- "name": "John Smith",
- "phoneNumber": "+35123123131",
- "username": "username@example.com",
- "acceptedPromotionalEmails": true,
- "acceptedPush": true,
- "gender": "FEMALE",
- "address": {
- "administrativeArea": "FL",
- "locality": "Miami-Dade County",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707"
}, - "favoriteStores": [
- {
- "storeId": "restaurant_1111",
- "channel": "4321"
}
]
}
{- "userId": "0ad6deb7-cbef-4fae-9a3c-6fd035f4x9xf"
}
Use this endpoint to send a user event. One of congitoId or email is required in order to identify user
cognitoId | string Example: "b73e218d-aa5c-45bd-8cf2-58f6a49769a4" User ID. |
string Example: "user-email@example.com" User email. | |
type required | string Value: "UPDATE_COMMUNICATION_PREFERENCES" Event type. |
object Optional payload for updates. |
{- "cognitoId": "b73e218d-aa5c-45bd-8cf2-58f6a49769a4",
- "email": "user-email@example.com",
- "type": "UPDATE_COMMUNICATION_PREFERENCES",
- "communicationPreferences": {
- "emailSubscribed": "true",
- "pushSubscribed": "false"
}
}
{- "status": 400,
- "code": "ValidationError",
- "message": "isAvailable must be a boolean value",
- "errors": [
- {
- "code": "ValidationError",
- "message": "string",
- "details": { },
- "domain": "string",
- "location": "isAvailable",
- "locationType": "requestBody",
- "sendReport": "string",
- "extendedHelp": "string"
}
]
}
Use this endpoint to submit a new support ticket for async processing
id required | string (UUID) A UUID that universally identifies the ticket |
category required | string (Category) The category of the ticket |
subcategory | string (Subcategory) The subcategory of the ticket |
subcategoryId | string (SubcategoryID) The subcategoryId of the ticket |
source required | string (Source) Enum: "app" "googleFoodOrdering" "grubhub" "kiosk" "uber" "waitr" "web" The source of the ticket |
comments | string (Comments) Comments |
status required | string (Status) Enum: "OPEN" "CLOSED" Status of the ticket |
created required | string <ISO 8601 Date Time> (DateTime) Example: "1991-02-11T20:30:19Z" The time that the case was created. |
required | object (Customer-2) Customer submitting the ticket |
orderId | string (OrderId) Example: "00000000-0000-0000-0000-000000000000" Unique identifier for an order |
escalated | boolean (Escalated) Indicate if the ticket is being escalated from a previous ticket |
type | string (Type) Enum: "STORE" "GENERAL" Resolution type for the ticket |
{- "id": "string",
- "category": "string",
- "subcategory": "string",
- "subcategoryId": "string",
- "source": "app",
- "comments": "string",
- "status": "OPEN",
- "created": "1991-02-11T20:30:19Z",
- "customer": {
- "email": "string",
- "name": "string",
- "phoneNumber": "string"
}, - "orderId": "00000000-0000-0000-0000-000000000000",
- "escalated": true,
- "type": "STORE"
}
{- "status": 400,
- "code": "ValidationError",
- "message": "isAvailable must be a boolean value",
- "errors": [
- {
- "code": "ValidationError",
- "message": "string",
- "details": { },
- "domain": "string",
- "location": "isAvailable",
- "locationType": "requestBody",
- "sendReport": "string",
- "extendedHelp": "string"
}
]
}
Price a new order.
The price order API must be called to create a new order and to validate the cart prices and item availability with the POS. When the Price Order request returns a success reponse, a subsequent Commit Order request should (but is not guarenteed to) succeed.
Price requests can fail for a variety of reasons. For example:
x-ui-region | string Example: US The Unicode Common Locale Data Repository (CLDR) region code of the country or region of the address. For the full list of country codes, refer to the CLDR Chart. |
channel required | string (Platform) Enum: "biteninja" "bookingall" "doordash" "googlefoodordering" "grubhub" "skip" "uber" Third party platforms
| ||||||||||||||||
externalReferenceId | string (ExternalReferenceId) External reference ID. An example might be the external menu selection ID, customer ID or order ID. | ||||||||||||||||
number | string (OrderNumber) Example: "1234" A human readable number used to identify the order by customers | ||||||||||||||||
referralPlatform | string (ReferralPlatform) Enum: "boltfood" "glovo" "justeat" "smood" "ubereats" "wolt" Example: "ubereats" The name of ReferralVendor where client placed the order | ||||||||||||||||
storeId required | string (StoreId) ^\d+$ Example: "42" Unique Store ID | ||||||||||||||||
serviceMode required | string (ServiceMode) Enum: "CURBSIDE" "DELIVERY" "DRIVE_THRU" "EAT_IN" "TABLE_SERVICE" "TAKEOUT" Example: "TAKEOUT" How a customer would like their order served. Note that not all service modes will be available at all restaurants. | ||||||||||||||||
required | object (AggregatorCart) Cart representing a customer's selections from the menu | ||||||||||||||||
required | object (Customer) Customer personal details | ||||||||||||||||
object (Charges) Order pricing details | |||||||||||||||||
object (Address-2) Standardized representation of a physical address |
{- "channel": "biteninja",
- "externalReferenceId": "string",
- "number": "1234",
- "referralPlatform": "ubereats",
- "storeId": "42",
- "serviceMode": "TAKEOUT",
- "cart": {
- "menuSelections": [
- {
- "id": "item_42",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "menuSelections": [
- {
- "id": "item_42",
- "name": "Whooper",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "type": "Item",
- "menuSelections": [
- { }
]
}
]
}
]
}, - "customer": {
- "id": "string",
- "externalReferenceId": "string",
- "name": "string",
- "username": "string",
- "phone": "+12223334444",
- "email": "user@example.com"
}, - "charges": {
- "tax": {
- "currency": "USD",
- "amount": 100
}, - "mpfTax": {
- "taxRemittedByMpf": {
- "currency": "USD",
- "amount": 100
}, - "isTaxRemittedByMpf": true
}, - "subTotal": {
- "currency": "USD",
- "amount": 100
}, - "total": {
- "currency": "USD",
- "amount": 100
}, - "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "deliveryAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}
}
{- "data": {
- "id": "00000000-0000-0000-0000-000000000000",
- "externalReferenceId": "string",
- "storeId": "42",
- "cart": {
- "menuSelections": [
- {
- "id": "item_42",
- "name": "Whooper",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "type": "Item",
- "menuSelections": [
- { }
]
}
], - "feedback": [
- {
- "entryId": "entry-id",
- "isAvailable": true,
- "price": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "deliveryMode": "MANAGED_BY_STORE",
- "serviceMode": "TAKEOUT",
- "customer": {
- "id": "string",
- "externalReferenceId": "string",
- "name": "string",
- "username": "string",
- "phone": "+12223334444",
- "email": "user@example.com"
}, - "charges": {
- "tax": {
- "currency": "USD",
- "amount": 100
}, - "mpfTax": {
- "taxRemittedByMpf": {
- "currency": "USD",
- "amount": 100
}, - "isTaxRemittedByMpf": true
}, - "subTotal": {
- "currency": "USD",
- "amount": 100
}, - "total": {
- "currency": "USD",
- "amount": 100
}, - "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "discounts": [
- {
- "type": "DISCOUNT",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
], - "payment": {
- "paymentMethod": "CREDIT_CARD",
- "paymentMethodBrand": "SODEXO",
- "total": {
- "currency": "USD",
- "amount": 100
}, - "amountLeftToBePaid": {
- "currency": "USD",
- "amount": 100
}, - "tip": {
- "currency": "USD",
- "amount": 100
}
}, - "posVendor": "CARROLS",
- "status": "CREATED",
- "deliveryAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}, - "loyaltyPointsEarned": 15,
- "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
], - "createdAt": "1991-02-11T20:30:19Z",
- "updatedAt": "1991-02-11T20:30:19Z",
- "fireOrderInSeconds": 600,
- "preparationTimeInSeconds": 300,
- "readyInSeconds": 600
}
}
Commit an order.
orderId required | string Unique Order ID |
x-ui-region | string Example: US The Unicode Common Locale Data Repository (CLDR) region code of the country or region of the address. For the full list of country codes, refer to the CLDR Chart. |
channel required | string (Platform) Enum: "biteninja" "bookingall" "doordash" "googlefoodordering" "grubhub" "skip" "uber" Third party platforms
| ||||||||||||||||
object (Charges) Order pricing details | |||||||||||||||||
paymentMethod required | string (PaymentMethod) Enum: "CREDIT_CARD" "APPLE_PAY" "GOOGLE_PAY" "PAYPAL" "GIFTCARD" "CASH" "UNPAID" How the customer has paid or will pay | ||||||||||||||||
fireOrderInSeconds required | integer or null (FireOrderInSeconds) [ 0 .. 100000 ] Example: "600" Lead time in seconds before an injected order should be fired to the kitchen for preparation.
| ||||||||||||||||
readyInSeconds | integer or null (ReadyInSeconds) >= 0 Example: "600" Time in seconds when the order will be ready. This value incorporates the order |
{- "channel": "biteninja",
- "charges": {
- "tax": {
- "currency": "USD",
- "amount": 100
}, - "mpfTax": {
- "taxRemittedByMpf": {
- "currency": "USD",
- "amount": 100
}, - "isTaxRemittedByMpf": true
}, - "subTotal": {
- "currency": "USD",
- "amount": 100
}, - "total": {
- "currency": "USD",
- "amount": 100
}, - "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "paymentMethod": "CREDIT_CARD",
- "fireOrderInSeconds": 600,
- "readyInSeconds": 600
}
{- "data": {
- "id": "00000000-0000-0000-0000-000000000000",
- "externalReferenceId": "string",
- "storeId": "42",
- "cart": {
- "menuSelections": [
- {
- "id": "item_42",
- "name": "Whooper",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "type": "Item",
- "menuSelections": [
- { }
]
}
], - "feedback": [
- {
- "entryId": "entry-id",
- "isAvailable": true,
- "price": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "deliveryMode": "MANAGED_BY_STORE",
- "serviceMode": "TAKEOUT",
- "customer": {
- "id": "string",
- "externalReferenceId": "string",
- "name": "string",
- "username": "string",
- "phone": "+12223334444",
- "email": "user@example.com"
}, - "charges": {
- "tax": {
- "currency": "USD",
- "amount": 100
}, - "mpfTax": {
- "taxRemittedByMpf": {
- "currency": "USD",
- "amount": 100
}, - "isTaxRemittedByMpf": true
}, - "subTotal": {
- "currency": "USD",
- "amount": 100
}, - "total": {
- "currency": "USD",
- "amount": 100
}, - "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "discounts": [
- {
- "type": "DISCOUNT",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
], - "payment": {
- "paymentMethod": "CREDIT_CARD",
- "paymentMethodBrand": "SODEXO",
- "total": {
- "currency": "USD",
- "amount": 100
}, - "amountLeftToBePaid": {
- "currency": "USD",
- "amount": 100
}, - "tip": {
- "currency": "USD",
- "amount": 100
}
}, - "posVendor": "CARROLS",
- "status": "CREATED",
- "deliveryAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}, - "loyaltyPointsEarned": 15,
- "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
], - "createdAt": "1991-02-11T20:30:19Z",
- "updatedAt": "1991-02-11T20:30:19Z",
- "fireOrderInSeconds": 600,
- "preparationTimeInSeconds": 300,
- "readyInSeconds": 600
}
}
This request creates an order with committed status from aggregators without doing the validations on price.
channel required | string (Platform) Enum: "biteninja" "bookingall" "doordash" "googlefoodordering" "grubhub" "skip" "uber" Third party platforms
| ||||||||||||||||||
deliveryMode | string (DeliveryMode) Enum: "MANAGED_BY_STORE" "MANAGED_EXTERNALLY" It indicates who is responsible to deliver the order.
| ||||||||||||||||||
externalReferenceId | string (ExternalReferenceId) External reference ID. An example might be the external menu selection ID, customer ID or order ID. | ||||||||||||||||||
number | string (OrderNumber) Example: "1234" A human readable number used to identify the order by customers | ||||||||||||||||||
referralPlatform | string (ReferralPlatform) Enum: "boltfood" "glovo" "justeat" "smood" "ubereats" "wolt" Example: "ubereats" The name of ReferralVendor where client placed the order | ||||||||||||||||||
storeId required | string (StoreId) ^\d+$ Example: "42" Unique Store ID | ||||||||||||||||||
serviceMode required | string (ServiceMode) Enum: "CURBSIDE" "DELIVERY" "DRIVE_THRU" "EAT_IN" "TABLE_SERVICE" "TAKEOUT" Example: "TAKEOUT" How a customer would like their order served. Note that not all service modes will be available at all restaurants. | ||||||||||||||||||
required | object (AggregatorCart) Cart representing a customer's selections from the menu | ||||||||||||||||||
required | object (Customer) Customer personal details | ||||||||||||||||||
object (Charges) Order pricing details | |||||||||||||||||||
object (Address-2) Standardized representation of a physical address | |||||||||||||||||||
paymentMethod required | string (PaymentMethod) Enum: "CREDIT_CARD" "APPLE_PAY" "GOOGLE_PAY" "PAYPAL" "GIFTCARD" "CASH" "UNPAID" How the customer has paid or will pay | ||||||||||||||||||
fireOrderInSeconds required | integer or null (FireOrderInSeconds) [ 0 .. 100000 ] Example: "600" Lead time in seconds before an injected order should be fired to the kitchen for preparation.
| ||||||||||||||||||
readyInSeconds | integer or null (ReadyInSeconds) >= 0 Example: "600" Time in seconds when the order will be ready. This value incorporates the order | ||||||||||||||||||
status required | string (OrderStatus) Enum: "CREATED" "PRICED" "COMMITTED" "PREPARING" "PREPARED" "DONE" "CANCELED" "ERROR" Order status, representing current state of order in its lifecycle. When transitioning the order status, the status must always advance further in the lifecycle. All other transitions are invalid.
| ||||||||||||||||||
instructions | string Instruction for the delivery. |
{- "channel": "biteninja",
- "deliveryMode": "MANAGED_BY_STORE",
- "externalReferenceId": "string",
- "number": "1234",
- "referralPlatform": "ubereats",
- "storeId": "42",
- "serviceMode": "TAKEOUT",
- "cart": {
- "menuSelections": [
- {
- "id": "item_42",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "menuSelections": [
- {
- "id": "item_42",
- "name": "Whooper",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "type": "Item",
- "menuSelections": [
- { }
]
}
]
}
]
}, - "customer": {
- "id": "string",
- "externalReferenceId": "string",
- "name": "string",
- "username": "string",
- "phone": "+12223334444",
- "email": "user@example.com"
}, - "charges": {
- "tax": {
- "currency": "USD",
- "amount": 100
}, - "mpfTax": {
- "taxRemittedByMpf": {
- "currency": "USD",
- "amount": 100
}, - "isTaxRemittedByMpf": true
}, - "subTotal": {
- "currency": "USD",
- "amount": 100
}, - "total": {
- "currency": "USD",
- "amount": 100
}, - "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "deliveryAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}, - "paymentMethod": "CREDIT_CARD",
- "fireOrderInSeconds": 600,
- "readyInSeconds": 600,
- "status": "CREATED",
- "instructions": "string"
}
{- "data": {
- "id": "00000000-0000-0000-0000-000000000000",
- "externalReferenceId": "string",
- "storeId": "42",
- "cart": {
- "menuSelections": [
- {
- "id": "item_42",
- "name": "Whooper",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "type": "Item",
- "menuSelections": [
- { }
]
}
], - "feedback": [
- {
- "entryId": "entry-id",
- "isAvailable": true,
- "price": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "deliveryMode": "MANAGED_BY_STORE",
- "serviceMode": "TAKEOUT",
- "customer": {
- "id": "string",
- "externalReferenceId": "string",
- "name": "string",
- "username": "string",
- "phone": "+12223334444",
- "email": "user@example.com"
}, - "charges": {
- "tax": {
- "currency": "USD",
- "amount": 100
}, - "mpfTax": {
- "taxRemittedByMpf": {
- "currency": "USD",
- "amount": 100
}, - "isTaxRemittedByMpf": true
}, - "subTotal": {
- "currency": "USD",
- "amount": 100
}, - "total": {
- "currency": "USD",
- "amount": 100
}, - "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "discounts": [
- {
- "type": "DISCOUNT",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
], - "payment": {
- "paymentMethod": "CREDIT_CARD",
- "paymentMethodBrand": "SODEXO",
- "total": {
- "currency": "USD",
- "amount": 100
}, - "amountLeftToBePaid": {
- "currency": "USD",
- "amount": 100
}, - "tip": {
- "currency": "USD",
- "amount": 100
}
}, - "posVendor": "CARROLS",
- "status": "CREATED",
- "deliveryAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}, - "loyaltyPointsEarned": 15,
- "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
], - "createdAt": "1991-02-11T20:30:19Z",
- "updatedAt": "1991-02-11T20:30:19Z",
- "fireOrderInSeconds": 600,
- "preparationTimeInSeconds": 300,
- "readyInSeconds": 600
}
}
Use this endpoint to provide updated status of a store that has been previously setted as AVAILABLE or UNAVAILABLE via webhook.
storeId required | string (StoreId) ^\d+$ Example: 42 Unique Store ID |
id required | string (id) Unique identifier for an event (uuid format) | ||||||
storeId required | string (StoreId) ^\d+$ Example: "42" Unique Store ID | ||||||
type required | string (DmpEventType) Enum: "ORDERING_AVAILABLE" "ORDERING_UNAVAILABLE" The type of the event triggered by DMP
| ||||||
time required | string (Time) Time that the event was triggered in ISOString format | ||||||
description | string (Description) Description of the reason to the event be triggered on DMP |
{- "id": "string",
- "storeId": "42",
- "type": "ORDERING_AVAILABLE",
- "time": "string",
- "description": "string"
}
Webhook to price an order.
We price an order to confirm how much a customer will be charged. It's also an opportunity to provide feedback on on item level price and availability and surface any applicable discounts.
Webhook type string in the webhook configuration: ORDER_PRICE
callbackUrl required | string URL for responding asynchronously to this request |
required | object (Cart) Cart representing a customer's selections from the menu |
channel required | string (OrderChannel) Enum: "WHITELABEL_IN_STORE" "WHITELABEL_DELIVERY" The channel is the platform by which an order is made |
externalReferenceId | string (ExternalReferenceId) External reference ID. An example might be the external menu selection ID, customer ID or order ID. |
Array of objects (Fees) All applicable fees for an order | |
id required | string (OrderId) Example: "00000000-0000-0000-0000-000000000000" Unique identifier for an order |
instructions | Array of strings (Instructions) Example: "TABLE-1" Additional information regarding the order (e.g. table number) |
number | string (OrderNumber) Example: "1234" A human readable number used to identify the order by customers |
referralPlatform | string (ReferralPlatform) Enum: "boltfood" "glovo" "justeat" "smood" "ubereats" "wolt" Example: "ubereats" The name of ReferralVendor where client placed the order |
serviceMode required | string (ServiceMode) Enum: "CURBSIDE" "DELIVERY" "DRIVE_THRU" "EAT_IN" "TABLE_SERVICE" "TAKEOUT" Example: "TAKEOUT" How a customer would like their order served. Note that not all service modes will be available at all restaurants. |
storeId required | string (StoreId) ^\d+$ Example: "42" Unique Store ID |
Array of objects (OrderDiscounts) Any discounts which ought to be applied to the order or a specific item in the order |
{- "callbackUrl": "string",
- "cart": {
- "menuSelections": [
- {
- "id": "item_42",
- "name": "Whooper",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "type": "Item",
- "menuSelections": [
- { }
]
}
]
}, - "channel": "WHITELABEL_IN_STORE",
- "externalReferenceId": "string",
- "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
], - "id": "00000000-0000-0000-0000-000000000000",
- "instructions": [
- "TABLE-1"
], - "number": "1234",
- "referralPlatform": "ubereats",
- "serviceMode": "TAKEOUT",
- "storeId": "42",
- "orderDiscounts": [
- {
- "type": "percentage",
- "value": 0,
- "plu": "string"
}
]
}
{- "data": {
- "referenceId": "string",
- "charges": {
- "tax": {
- "currency": "USD",
- "amount": 100
}, - "subTotal": {
- "currency": "USD",
- "amount": 100
}, - "total": {
- "currency": "USD",
- "amount": 100
}, - "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
]
}, - "feedback": [
- {
- "entryId": "entry-id",
- "isAvailable": true,
- "price": {
- "currency": "USD",
- "amount": 100
}
}
], - "discounts": [
- {
- "type": "DISCOUNT",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
], - "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
]
}
}
Webhook to commit an order.
By default, committing an order sends the order to the kitchen for preparation.
We use the fireOrderInSeconds
field to indicate whether the order should be prepare
the order at a point in the future, or wait until we send a subsequent "fire" request.
Webhook type string in the webhook configuration: ORDER_COMMIT
id required | string (OrderId) Example: "00000000-0000-0000-0000-000000000000" Internal order ID |
externalReferenceId required | string (ExternalReferenceId) Partner's order ID |
callbackUrl required | string URL to provide events for this order. |
required | object (Customer) Customer personal details |
Array of objects (Fees) All applicable fees for an order | |
required | object (Payment) |
fireOrderInSeconds required | integer or null (FireOrderInSeconds) [ 0 .. 100000 ] Example: "600" Lead time in seconds before an injected order should be fired to the kitchen for preparation.
|
readyInSeconds | integer or null (ReadyInSeconds) >= 0 Example: "600" Time in seconds when the order will be ready. This value incorporates the order |
{- "id": "00000000-0000-0000-0000-000000000000",
- "externalReferenceId": "string",
- "callbackUrl": "string",
- "customer": {
- "id": "string",
- "externalReferenceId": "string",
- "name": "string",
- "username": "string",
- "phone": "+12223334444",
- "email": "user@example.com"
}, - "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
], - "payment": {
- "paymentMethod": "CREDIT_CARD",
- "paymentMethodBrand": "SODEXO",
- "total": {
- "currency": "USD",
- "amount": 100
}, - "amountLeftToBePaid": {
- "currency": "USD",
- "amount": 100
}, - "tip": {
- "currency": "USD",
- "amount": 100
}
}, - "fireOrderInSeconds": 600,
- "readyInSeconds": 600
}
{- "data": {
- "externalReferenceId": "string",
- "status": "CREATED",
- "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
]
}
}
Webhook to fire an order.
Firing an order means that we should begin preparation of an order which was previously committed
Webhook type string in the webhook configuration: ORDER_FIRE
id required | string (OrderId) Example: "00000000-0000-0000-0000-000000000000" Internal order ID |
externalReferenceId required | string (ExternalReferenceId) Partner's order ID |
callbackUrl required | string URL to provide events for this order. |
{- "id": "00000000-0000-0000-0000-000000000000",
- "externalReferenceId": "string",
- "callbackUrl": "string"
}
{- "data": {
- "externalReferenceId": "string",
- "status": "CREATED",
- "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
]
}
}
Webhook for an order event
Webhook type string in the webhook configuration: ORDER_EVENT
id required | string (OrderId) Example: "00000000-0000-0000-0000-000000000000" Internal order ID | ||||||||||||||||||
externalReferenceId required | string (ExternalReferenceId) Partner's order ID | ||||||||||||||||||
fireOrderInSeconds | integer or null (FireOrderInSeconds) [ 0 .. 100000 ] Example: "600" Lead time in seconds before an injected order should be fired to the kitchen for preparation.
| ||||||||||||||||||
status required | string (OrderStatus) Enum: "CREATED" "PRICED" "COMMITTED" "PREPARING" "PREPARED" "DONE" "CANCELED" "ERROR" Order status, representing current state of order in its lifecycle. When transitioning the order status, the status must always advance further in the lifecycle. All other transitions are invalid.
| ||||||||||||||||||
Array of objects (Order Error) Deprecated Any errors which occurred during order processing. Deprecated - Use partnerErrors instead. | |||||||||||||||||||
Array of ItemNotAvailable (object) or ItemPriceMismatch (object) or ItemNotFound (object) or StoreNotFound (object) or StoreClosed (object) or StoreNotOperating (object) or OrderNotFound (object) or OrderCancelled (object) (Partner Error) Any errors which occurred during order processing, which includes errors related to items, stores, or orders. |
{- "id": "00000000-0000-0000-0000-000000000000",
- "externalReferenceId": "string",
- "fireOrderInSeconds": 600,
- "status": "CREATED",
- "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
]
}
{- "data": {
- "externalReferenceId": "string",
- "status": "CREATED",
- "errors": [
- {
- "message": "TERMINAL UPDATE IN PROGRESS",
- "code": "STORE"
}
], - "partnerErrors": [
- {
- "plu": "string",
- "requestedQuantity": 0,
- "availableQuantity": 0,
- "type": "ItemNotAvailable"
}
]
}
}
Webhook for an delivery event
Webhook type string in the webhook configuration: DELIVERY_EVENT
orderId required | string (OrderId) Example: "00000000-0000-0000-0000-000000000000" Internal order ID | ||||||||||||||||||||||
externalReferenceId required | string (ExternalReferenceId) Partner's order ID | ||||||||||||||||||||||
status required | string (DeliveryStatus) Enum: "DELIVERY_CREATED" "DRIVER_ASSIGNED" "DRIVER_STARTING" "DRIVER_AT_STORE" "ORDER_PICKED_UP" "DRIVER_AT_CUSTOMER" "ORDER_DROPPED_OFF" "DRIVER_UNASSIGNED" "ORDER_CANCELLED" "ERROR" Delivery status, representing current state of delivery order in its lifecycle.
| ||||||||||||||||||||||
object (TimeInterval) The time window during which the pickup is expected. | |||||||||||||||||||||||
object (TimeInterval) The time window during which the delivery is expected. | |||||||||||||||||||||||
dropoffEta | string <ISO 8601 Date Time> (DateTime) Example: "1991-02-11T20:30:19Z" Extimated dropoff time (ETA) | ||||||||||||||||||||||
object Optionally provided cancellation details if the fulfillment provider has cancelled for any reason | |||||||||||||||||||||||
object (Courier) Courier information | |||||||||||||||||||||||
pincode | string Example: "1234" In cases of suspected fraud, the last-mile provider can generate a PIN code to confirm the delivery |
{- "orderId": "00000000-0000-0000-0000-000000000000",
- "externalReferenceId": "string",
- "status": "DELIVERY_CREATED",
- "pickupWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "dropoffWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "dropoffEta": "1991-02-11T20:30:19Z",
- "cancellation": {
- "comments": "string",
- "reason": "WRONG_ADDRESS"
}, - "courier": {
- "transportType": "CAR",
- "location": {
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "profileImage": {
- "url": "string",
- "altText": "string"
}, - "phone": "string"
}, - "pincode": 1234
}
Webhook to receive quote requests.
We use quote requests to determine whether any drivers are available to fulfill a delivery order.
Webhook type string in the webhook configuration: DELIVERY_QUOTE
object (Cart) Cart representing a customer's selections from the menu | |
required | object (Address-2) Standardized representation of a physical address |
storeId | string (StoreId) ^\d+$ Example: "42" Unique Store ID |
{- "cart": {
- "menuSelections": [
- {
- "id": "item_42",
- "name": "Whooper",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "type": "Item",
- "menuSelections": [
- { }
]
}
]
}, - "deliveryAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}, - "storeId": "42"
}
{- "data": {
- "quotes": [
- {
- "id": "string",
- "vendor": "string",
- "storeId": "string",
- "pickupAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}, - "cost": {
- "currency": "USD",
- "amount": 100
}, - "pickupWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "dropoffWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "expirationTime": "1991-02-11T20:30:19Z",
- "preOrderTimeSlots": [
- {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}
]
}
], - "errors": [
- {
- "id": "string",
- "vendor": "string",
- "code": "NO_DRIVERS_AVAILABLE"
}
]
}
}
Webhook to receive quote requests.
We use create quote requests to determine whether any restaurants are available to fulfill an order and provide estimated delivery costs.
Webhook type string in the webhook configuration: DELIVERY_QUOTE_CREATE
required | object (Address-2) Standardized representation of a physical address |
Array of objects (StoreAddress) Addresses of restaurants which are eligible to fulfill the order |
{- "deliveryAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}, - "pickupAddresses": [
- {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "storeId": "42",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}
]
}
{- "data": {
- "quotes": [
- {
- "id": "string",
- "vendor": "string",
- "storeId": "string",
- "pickupAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}, - "cost": {
- "currency": "USD",
- "amount": 100
}, - "pickupWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "dropoffWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "expirationTime": "1991-02-11T20:30:19Z",
- "preOrderTimeSlots": [
- {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}
]
}
], - "errors": [
- {
- "id": "string",
- "vendor": "string",
- "code": "NO_DRIVERS_AVAILABLE"
}
]
}
}
Webhook to receive quote requests.
We use apply quote requests to provide final delivery costs for specific order and specific restaurant.
Webhook type string in the webhook configuration: DELIVERY_QUOTE_APPLY
required | object (DeliveryCart) Cart representing a customer's selections from the menu |
required | object (Address-2) Standardized representation of a physical address |
storeId required | string (StoreId) ^\d+$ Example: "42" Unique Store ID |
Array of objects (OrderDiscounts) Any discounts which ought to be applied to the order or a specific item in the order |
{- "cart": {
- "menuSelections": [
- {
- "id": "item_42",
- "name": "Whooper",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "type": "Item",
- "menuSelections": [
- { }
]
}
], - "tax": {
- "currency": "USD",
- "amount": 100
}, - "subTotal": {
- "currency": "USD",
- "amount": 100
}, - "total": {
- "currency": "USD",
- "amount": 100
}
}, - "deliveryAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}, - "storeId": "42",
- "orderDiscounts": [
- {
- "type": "percentage",
- "value": 0,
- "plu": "string"
}
]
}
{- "data": {
- "quotes": [
- {
- "id": "string",
- "vendor": "string",
- "storeId": "string",
- "pickupAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}, - "cost": {
- "currency": "USD",
- "amount": 100
}, - "pickupWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "dropoffWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "expirationTime": "1991-02-11T20:30:19Z",
- "preOrderTimeSlots": [
- {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}
]
}
], - "errors": [
- {
- "id": "string",
- "vendor": "string",
- "code": "NO_DRIVERS_AVAILABLE"
}
]
}
}
Create a delivery order
Webhook type string in the webhook configuration: DELIVERY_CREATE
orderId required | string (OrderId) Example: "00000000-0000-0000-0000-000000000000" Unique identifier for an order |
quoteId required | string The unique identifier of the quote applied to the order. |
number | string Example: "123" Order ID as it should be displayed to the guest |
required | object (Cart) Cart representing a customer's selections from the menu |
channel | string (DeliveryChannel) Enum: "app" "biteninja" "bookingall" "doordash" "googleFoodOrdering" "grubhub" "internal" "kiosk" "skip uber" "waitr" "web" "boltfood" "glovo" "justeat" "smood" "ubereats" "wolt" The channel is the platform by which an order is made |
required | object (Customer) Customer personal details |
Array of objects (Fees) All applicable fees for an order | |
fireOrderInSeconds required | integer or null (FireOrderInSeconds) [ 0 .. 100000 ] Example: "600" Lead time in seconds before an injected order should be fired to the kitchen for preparation.
|
required | object (Payment) |
required | object (Address-2) Standardized representation of a physical address |
Array of objects (AdditionalDetails) This are additional fields that can be specified in the CMS, to be entered by the user at checkout. | |
instructions | string Instruction for the delivery. |
storeId required | string (StoreId) ^\d+$ Example: "42" Unique Store ID |
Array of objects (OrderDiscounts) Any discounts which ought to be applied to the order or a specific item in the order | |
object (PreOrderTimeSlot) Representation of pre order time slot, a range in time, lasting from |
{- "orderId": "00000000-0000-0000-0000-000000000000",
- "quoteId": "string",
- "number": 123,
- "cart": {
- "menuSelections": [
- {
- "id": "item_42",
- "name": "Whooper",
- "externalReferenceId": "string",
- "quantity": 1,
- "price": {
- "currency": "USD",
- "amount": 100
}, - "referenceId": "item_603",
- "type": "Item",
- "menuSelections": [
- { }
]
}
]
}, - "channel": "app",
- "customer": {
- "id": "string",
- "externalReferenceId": "string",
- "name": "string",
- "username": "string",
- "phone": "+12223334444",
- "email": "user@example.com"
}, - "fees": [
- {
- "type": "BAG_FEE",
- "total": {
- "currency": "USD",
- "amount": 100
}
}
], - "fireOrderInSeconds": 600,
- "payment": {
- "paymentMethod": "CREDIT_CARD",
- "paymentMethodBrand": "SODEXO",
- "total": {
- "currency": "USD",
- "amount": 100
}, - "amountLeftToBePaid": {
- "currency": "USD",
- "amount": 100
}, - "tip": {
- "currency": "USD",
- "amount": 100
}
}, - "deliveryAddress": {
- "administrativeArea": "FL",
- "coordinates": {
- "latitude": 25.782379,
- "longitude": -80.289207
}, - "formattedAddress": "5707 Blue Lagoon Drive",
- "instructions": "string",
- "locality": "Miami-Dade County",
- "phoneNumber": "+13056665931",
- "phoneNumberCode": "4556",
- "postalCode": "33126",
- "regionCode": "US",
- "route": "Blue Lagoon Drive",
- "streetNumber": "5707",
- "sublocality": "string",
- "subpremise": "Suite 101"
}, - "additionalDetails": [
- {
- "key": "notes",
- "value": "Any notes"
}
], - "instructions": "string",
- "storeId": "42",
- "orderDiscounts": [
- {
- "type": "percentage",
- "value": 0,
- "plu": "string"
}
], - "selectedPreOrderTimeSlot": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}
}
{- "data": {
- "status": "DELIVERY_CREATED",
- "pickupWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "dropoffWindow": {
- "start": "1991-02-11T20:30:19Z",
- "end": "1991-02-11T20:30:19Z"
}, - "dropoffEta": "1991-02-11T20:30:19Z",
- "cancellation": {
- "comments": "string",
- "reason": "WRONG_ADDRESS"
}, - "courier": {
- "transportType": "CAR",
- "location": {
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "profileImage": {
- "url": "string",
- "altText": "string"
}, - "phone": "string"
}, - "pincode": 1234
}
}
Webhook to update the heartbeat status.
A schedule is established to update the heartbeat status via a webhook, and the frequency of the associated heartbeat requests is every fifteen minutes.
Webhook type string in the webhook configuration: STORE_HEARTBEAT
storeId required | string Example: "99999" An ID of the store. |
{- "storeId": "99999"
}
{- "isOnline": true
}
Store updated events are dispatched when a store's availability or metadata has changed.
The availability of individual stores can change regularly for a variety of reasons. In some cases a store may be experiencing a temporary outage, or a more widespread outage may be affecting the Point of Sale (POS) vendor. In addition, store operators can update operating hours and service modes, and expect these changes to be reflected across all supported platforms.
When these "STORE_UPDATED"
events are delivered, a request must be
made to the provided callbackUrl
to fetch the latest store details.
x-signature | string A hex encoded HMAC signature |
brand required | string (Brand) Enum: "BK" "PLK" "TH" Example: "PLK" |
callbackUrl required | string <url> Example: "https://partners-bk.rbictg.com/api/v1/stores/42" URL from which the updated store details may be retrieved. |
eventTime required | string <ISO 8601 Date Time> (DateTime) Example: "1991-02-11T20:30:19Z" Store update event time. |
eventType required | string Value: "STORE_UPDATED" Webhook event type. |
region required | string (Region) Example: "US" Region
The Unicode Common Locale Data Repository (CLDR)
region code of the country or region of the address.
For example, the code for the United States is For the full list of codes, refer to the CLDR Chart. |
storeId required | string (StoreId) ^\d+$ Example: "42" Unique Store ID |
{- "brand": "PLK",
- "eventTime": "1991-02-11T20:30:19Z",
- "eventType": "STORE_UPDATED",
- "region": "US",
- "storeId": "42"
}
Webhook for a ticket event. (deprecated: use STORE_SUPPORT_TICKET_EVENT
instead)
A ticket event is generated when a guest raises a support request via the Whitelabel app. This webhook then forwards the event to the relevant support system depending on configured business rules. Currently, we support forwarding ticket events to Salesforce and the Delivery Management Platform.
Webhook type string in the webhook configuration: TICKET_EVENT
id required | string (UUID) A UUID that universally identifies the ticket |
category required | string (Category) The category of the ticket |
subcategory | string (Subcategory) The subcategory of the ticket |
subcategoryId | string (SubcategoryID) The subcategoryId of the ticket |
source required | string (Source) Enum: "app" "googleFoodOrdering" "grubhub" "kiosk" "uber" "waitr" "web" The source of the ticket |
comments | string (Comments) Comments |
status required | string (Status) Enum: "OPEN" "CLOSED" Status of the ticket |
created required | string <ISO 8601 Date Time> (DateTime) Example: "1991-02-11T20:30:19Z" The time that the case was created. |
required | object (Customer-2) Customer submitting the ticket |
orderId | string (OrderId) Example: "00000000-0000-0000-0000-000000000000" Internal order ID |
escalated | boolean (Escalated) Indicates if the ticket has been escalated from a previous ticket or not |
{- "id": "string",
- "category": "string",
- "subcategory": "string",
- "subcategoryId": "string",
- "source": "app",
- "comments": "string",
- "status": "OPEN",
- "created": "1991-02-11T20:30:19Z",
- "customer": {
- "email": "string",
- "name": "string",
- "phoneNumber": "string"
}, - "orderId": "00000000-0000-0000-0000-000000000000",
- "escalated": true
}
Webhook for a store ticket event.
These tickets are related to issues that should be addressed within a time frame by the store, such as an order that arrived cold or late. The store support ticket is intended to prompt the support system associated with the store to take action to resolve the issue.
Webhook type string in the webhook configuration: STORE_SUPPORT_TICKET_EVENT
id required | string (UUID) A UUID that universally identifies the ticket |
category required | string (Category) The category of the ticket |
subcategory | string (Subcategory) The subcategory of the ticket |
subcategoryId | string (SubcategoryID) The subcategoryId of the ticket |
source required | string (Source) Enum: "app" "googleFoodOrdering" "grubhub" "kiosk" "uber" "waitr" "web" The source of the ticket |
comments | string (Comments) Comments |
status required | string (Status) Enum: "OPEN" "CLOSED" Status of the ticket |
created required | string <ISO 8601 Date Time> (DateTime) Example: "1991-02-11T20:30:19Z" The time that the case was created. |
required | object (Customer-2) Customer submitting the ticket |
orderId | string (OrderId) Example: "00000000-0000-0000-0000-000000000000" Internal order ID |
escalated | boolean (Escalated) Indicates if the ticket has been escalated from a previous ticket or not |
type | string Value: "STORE" Resolution type for the ticket |
orderDate | string (OrderDate) The incident date in YYYY-MM-DD format |
storeId | string The Store ID where the user raised the ticket |
{- "id": "string",
- "category": "string",
- "subcategory": "string",
- "subcategoryId": "string",
- "source": "app",
- "comments": "string",
- "status": "OPEN",
- "created": "1991-02-11T20:30:19Z",
- "customer": {
- "email": "string",
- "name": "string",
- "phoneNumber": "string"
}, - "orderId": "00000000-0000-0000-0000-000000000000",
- "escalated": true,
- "type": "STORE",
- "orderDate": "string",
- "storeId": "string"
}
Webhook for a general ticket event.
These tickets are for issues that do not necessarily require immediate action from the store, such as a complaint or suggestion. General support tickets are intended to be handled by the support team, who will take appropriate action to resolve the issue or respond to the request.
Webhook type string in the webhook configuration: GENERAL_SUPPORT_TICKET_EVENT
id required | string (UUID) A UUID that universally identifies the ticket |
category required | string (Category) The category of the ticket |
subcategory | string (Subcategory) The subcategory of the ticket |
subcategoryId | string (SubcategoryID) The subcategoryId of the ticket |
source required | string (Source) Enum: "app" "googleFoodOrdering" "grubhub" "kiosk" "uber" "waitr" "web" The source of the ticket |
comments | string (Comments) Comments |
status required | string (Status) Enum: "OPEN" "CLOSED" Status of the ticket |
created required | string <ISO 8601 Date Time> (DateTime) Example: "1991-02-11T20:30:19Z" The time that the case was created. |
required | object (Customer-2) Customer submitting the ticket |
orderId | string (OrderId) Example: "00000000-0000-0000-0000-000000000000" Internal order ID |
escalated | boolean (Escalated) Indicates if the ticket has been escalated from a previous ticket or not |
type | string Value: "GENERAL" Resolution type for the ticket |
orderDate | string (OrderDate) The incident date in YYYY-MM-DD format |
storeId | string The Store ID where the user raised the ticket |
{- "id": "string",
- "category": "string",
- "subcategory": "string",
- "subcategoryId": "string",
- "source": "app",
- "comments": "string",
- "status": "OPEN",
- "created": "1991-02-11T20:30:19Z",
- "customer": {
- "email": "string",
- "name": "string",
- "phoneNumber": "string"
}, - "orderId": "00000000-0000-0000-0000-000000000000",
- "escalated": true,
- "type": "GENERAL",
- "orderDate": "string",
- "storeId": "string"
}
Webhook type string in the webhook configuration: DMP_STORE_EVENT
id required | string (id) Unique identifier for an event (uuid format) | ||||||
storeId required | string (StoreId) ^\d+$ Example: "42" Unique Store ID | ||||||
type required | string (DmpEventType) Enum: "ORDERING_AVAILABLE" "ORDERING_UNAVAILABLE" The type of the event triggered by DMP
| ||||||
time required | string (Time) Example: "2022-07-14T10:27:32-03:00" Time that the event was triggered in ISOString format | ||||||
description | string (Description) Example: "NO_DRIVERS_AVAILABLE" Description of the reason to the event be triggered on DMP |
{- "id": "string",
- "storeId": "42",
- "type": "ORDERING_AVAILABLE",
- "time": "2022-07-14T10:27:32-03:00",
- "description": "NO_DRIVERS_AVAILABLE"
}
Rolling Out: This feature is not available in all partners at the moment. Contact us if you need this feature enabled
.
The webhook through which RBI sends user sign up information. This webhook is used to synchronize RBI users with a Partner. Webhook type string in the webhook configuration: USER_SIGN_UP
userId required | string Example: "25ab9948-d4c4-4643-84b2-44b9608b860a" Customer Id, its unique cognito id. |
firstName | string Example: "John" Customer firstname |
lastName | string Example: "Smith" Customer lastname |
phone | string Example: "+35123123131" Customer phone number starting with the country code. |
email required | string Example: "username@example.com" Customer username, must be a valid email address. |
acceptedPromotionalEmails | boolean Example: "true" Whether customer accepts promotional email |
loyaltyId | string Example: "af570946-7a70-4d18-a02b-86d9a2a6eea2" If loyalty enable in market, store loyaltyId along with user details |
{- "userId": "25ab9948-d4c4-4643-84b2-44b9608b860a",
- "firstName": "John",
- "lastName": "Smith",
- "phone": "+35123123131",
- "email": "username@example.com",
- "acceptedPromotionalEmails": true,
- "loyaltyId": "af570946-7a70-4d18-a02b-86d9a2a6eea2"
}
status | number Example: "400" HTTP status code |
code required | string Example: "ValidationError" Unique error code. Same as errors[0].code |
message required | string Example: "isAvailable must be a boolean value" Human readable error mesage. Same as errors[0].message |
required | Array of objects All errors |
{- "status": 400,
- "code": "ValidationError",
- "message": "isAvailable must be a boolean value",
- "errors": [
- {
- "code": "ValidationError",
- "message": "string",
- "details": { },
- "domain": "string",
- "location": "isAvailable",
- "locationType": "requestBody",
- "sendReport": "string",
- "extendedHelp": "string"
}
]
}
type required | string Enum: "DELIVERY_CREATE" "DELIVERY_EVENT" "DELIVERY_QUOTE" "DELIVERY_QUOTE_APPLY" "DELIVERY_QUOTE_CREATE" "MENU_EVENT" "MENU_PRICES_AVAILABILITY_UPDATE" "ORDER_COMMIT" "ORDER_EVENT" "ORDER_FIRE" "ORDER_PRICE" "STORE_HEARTBEAT" "TICKET_EVENT" "STORE_SUPPORT_TICKET_EVENT" "GENERAL_SUPPORT_TICKET_EVENT" "USER_SIGN_UP" Example: "ORDER_PRICE" Type of webhook which is trigger in a specific action
| ||||||||||||||||||||||||||||||||||
url required | string Example: "https://partnert.example.com/order_price" Endpoint on partner side that should receive the webhook call |
{- "type": "ORDER_PRICE",
}