Operation Definitions

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

body

body

cart_external

Yes

The JSON formatted request

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The identifier of the entity

query

$skip

integer

No

The documents to skip before returning. For example, if skip is 5, and top is 100, the system returns documents 6 to 105.

query

$top

integer

No

The maximum documents to return. See $skip above as an example.

header

X-COMPANY-ID

string

Yes

The identifier of the company to manage data for

path

entity_id

string

Yes

The identifier of the entity

query

$skip

integer

No

The documents to skip before returning. For example, if skip is 5, and top is 100, the system returns documents 6 to 105.

query

$top

integer

No

The maximum documents to return. See $skip as an example.

name

string

Yes

transaction_id

string

No

is_scheduled

boolean

No

The cart is scheduled for the future date and can still be updated.

If is_scheduled=true, effective_date is required.

The possible values are "true" or "false."

effective_date

string, object

No

The date-time. If the entity is updated on a specific date, then specifying an effective_date prior to that date returns a previous version of the entity.

site_ids

[ string, object ]

No

entity_types

[ string ]

No

The list of entities that is touched by all the changes, such as product, product-price

changes

[ object ]

Yes

status

string

Yes

The possible values are "open," "scheduled," "ready_to_deploy," "in_progress," "deployed," or "failed."

open - The cart is created and can be updated with packages.

scheduled - The cart is scheduled for the future date and can still be updated with packages.

ready_to_deploy - The cart is ready to deploy and waiting for the Data Management (DM) worker to start the deployment and cannot be updated.

in_progress - The cart is deploying right now and cannot be changed.

deployed - The cart is deployed and cannot be changed. These fields are required:

failed - The cart is failing during deployment or scheduling and can be updated.

meta

object

No

type

string

No

The possible values are "manual," "system_dm," "system_ol," or "dmb."

manual - Created by the user through the user interface (UI) or the application programming interface (API)

system_dm - Created by the DM API internal logic.

system_ol - Created by Onboarding Lambda by inserting to the database.

dmb - Created by the Digital Menu Board Portal (DMB TVs content deployments)

deployed_at

string, object

No

The date-time the cart is deployed

deployed_by

string

No

Contains information about the person who deployed a cart. The DM worker sends it to set.

expire_at

string, object

No

The date-time the cart expires

_id

_id

No

company_id

company_id

No

entity_id

entity_id

No

is_master

is_master

No

is_active

is_active

No

external_id

external_id

No

created_by

created_by

No

updated_by

updated_by

No

created_at

created_at

No

updated_at

updated_at

No

name

string

Yes

transaction_id

string

No

is_scheduled

boolean

No

The cart is scheduled for the future date and can still be updated.

If is_scheduled=true, effective_date is required.

The possible values are "true" or "false."

effective_date

string, object

No

The date-time. If the entity is updated on a specific date, then specifying an effective_date prior to that date returns a previous version of the entity.

site_ids

[ string, object ]

No

entity_types

[ string ]

No

The list of entities that is touched by all the changes, such as product, product-price

changes

[ object ]

Yes

status

string

Yes

The possible values are "open," "scheduled," "ready_to_deploy," "in_progress," "deployed," or "failed."

open - The cart is created and can be updated with packages.

scheduled - The cart is scheduled for the future date and can still be updated with packages.

ready_to_deploy - The cart is ready to deploy and waiting for Data Management (DM) worker to start the deployment and cannot be updated.

in_progress - The cart is deploying right now and cannot be changed.

deployed - The cart is deployed and cannot be changed. These fields are required:

failed - The cart is failing during deployment or scheduling and can be updated.

meta

object

No

type

string

No

The possible values are "manual," "system_dm," "system_ol," or "dmb."

manual - Created by the user through the user interface (UI) or the application programming interface (API).

system_dm - Created by the DM API internal logic.

system_ol - Created by Onboarding Lambda by inserting to the database.

dmb - Created by the Digital Menu Board Portal (DMB TVs content deployments).

deployed_at

string, object

No

The date-time the cart is deployed

deployed_by

string

No

Contains information about the person who deployed a cart. The DM worker sends it to set.

expire_at

string, object

No

The date-time the cart expires

entity_id

entity_id

No

external_id

external_id

No

name

string

transaction_id

string

is_scheduled

boolean

The cart is scheduled for the future date and can still be updated.

If is_scheduled=true, effective_date is required.

The possible values are "true" or "false."

effective_date

string, object

The date-time. If the entity is updated on a specific date, then specifying an effective_date prior to that date returns a previous version of the entity.

site_ids

[ string, object ]

entity_types

[ string ]

The list of entities that is touched by all the changes, such as product, product-price

changes

[ object ]

status

string

The possible values are "open," "scheduled," "ready_to_deploy," "in_progress," "deployed," or "failed."

open - The cart is created and can be updated with packages.

scheduled - The cart is scheduled for the future date and can still be updated with packages.

ready_to_deploy - The cart is ready to deploy and waiting for The Data Management (DM) worker to start the deployment and cannot be updated.

in_progress - The cart is deploying right now and cannot be changed.

deployed - The cart is deployed and cannot be changed. These fields are required:

failed - The cart is failing during deployment or scheduling and can be updated.

meta

object

type

string

The possible values "manual," "system_dm," "system_ol," or "dmb."

manual - Created by the user through the user interface (UI) or the application programming interface (API).

system_dm - Created by the DM API internal logic.

system_ol - Created by Onboarding Lambda by inserting to the database.

dmb - Created by the Digital Menu Board Portal (DMB TVs content deployments).

deployed_at

string, object

date-time

deployed_by

string

Contains informations about the person who deployed a cart. The DM worker sends it to set.

expire_at

string, object

The date-time the cart expires

external_id

external_id

total

integer

items

[ cart ]

_change_id

string, object

Yes

The service field to access certain changes in the cart

document_entity_id

string, object

Yes

A reference link to the document to which the change is related

entity_type

string

Yes

The entity that is touched by this change (For example, product, product-price).

The possible values are "action-type," "address-type," "allergen," "allowed-labor-cost," "audio-file," "break-time," "bundle-component," "bundle-component-price," "bundle-type," "business-rule-group," "business-rule-validate-model," "calendar," "calendar-type," "card-bin-data," "configuration-group," "count-frequency," "country," "country-state," "currency-scheme," "custom-label-definition," "data-kit," "date-range," "day-part," "day-part-group," "day-part-type," "dictionary," "discount-definition," "donation," "dynamic-matrix," "email-type," "employee-status-change-reason," "employee-status-config," "ethnicity," "event-type," "fee-definition," "fixed-matrix," "floor-plan," "forecast-definition," "forecast-definition-mapping," "general-ledger-account," "gift-service," "history-definition," "house-account," "house-account-status," "i9-document-class," "i9-status," "image-set," "inventory-item," "inventory-location," "job-change-reason," "job-code," "job-code-category," "job-code-rate," "job-station," "kitchen-printer-role," "kitchen-routing-category," "lookup," "loyalty-customer-identification-method," "measure," "media-library," "menu," "menu-category," "menu-item-group," "metadata," "min-wage-config," "modifier-build," "modifier-collection," "modifier-group," "modifier-priority," "named-calculation," "notification-template," "online-ordering-settings," "order-destination," "order-lane," "order-screen," "order-source," "pay-type," "pay-type-scheme," "payroll-compensation-mapping," "payroll-employee-status-mapping," "payroll-job-category-mapping," "payroll-job-mapping," "payroll-rate-name-mapping," "payroll-termination-reason-mapping," "payroll-work-site-mapping," "payrule-group," "peripheral," "peripheral-schema," "phone-type," "pos-job-code," "pos-pay-mapping," "pos-punch-type," "pos-reason-code," "preferences," "product," "product-availability," "product-category," "product-ingredient," "product-price," "punch-adjustment-reason," "punch-type," "receipt-content-template," "receipt-message," "receipt-template," "recipe," "report-options," "report-options-category," "reporting-category," "schedule-type," "school-district," "store-hours-config," "store-hours-config-group," "tag," "tag-rule," "tare," "tax-definition," "tax-group," "tax-group-set," "tax-jurisdiction," "tender-category," "tender-currency," "tender-mapping," "terminal," "terminal-scheme," "time-period," "tip-group," "variant," "variant-type," "vendor," "vendor-type," "w4-filing-status," "web-menu-metadata," "web-meta-data," "work-type," "xks-bumpbar," "xks-display," "xks-display-definition," "xks-display-scheme," "xks-general-settings," "xks-screen-config," "xks-screen-filter," or "xks-station-config."

cart_entity_id

string, object

Yes

name

string

No

status

string

No

The possible values are "deployed" or "failed"

_ui_entity_type

string

No

deployed_at

string, object

No

The date-time the cart deployed.

deployed_by

string

No

document_change

object

Yes

meta

object

No

_id

_id

No

company_id

company_id

No

entity_id

entity_id

No

is_master

is_master

No

is_active

is_active

No

external_id

external_id

No

created_by

created_by

No

updated_by

updated_by

No

created_at

created_at

No

updated_at

updated_at

No

_change_id

string, object

Yes

The service field to access certain changes in the cart

document_entity_id

string, object

Yes

A reference link to the document to which the change is related

entity_type

string

Yes

The entity that is touched by this change (For example, product, product-price).

The possible values are "action-type," "address-type," "allergen," "allowed-labor-cost," "audio-file," "break-time," "bundle-component," "bundle-component-price," "bundle-type," "business-rule-group," "business-rule-validate-model," "calendar," "calendar-type," "card-bin-data," "configuration-group," "count-frequency," "country," "country-state," "currency-scheme," "custom-label-definition," "data-kit," "date-range," "day-part," "day-part-group," "day-part-type," "dictionary," "discount-definition," "donation," "dynamic-matrix," "email-type," "employee-status-change-reason," "employee-status-config," "ethnicity," "event-type," "fee-definition," "fixed-matrix," "floor-plan," "forecast-definition," "forecast-definition-mapping," "general-ledger-account," "gift-service," "history-definition," "house-account," "house-account-status," "i9-document-class," "i9-status," "image-set," "inventory-item," "inventory-location," "job-change-reason," "job-code," "job-code-category," "job-code-rate," "job-station," "kitchen-printer-role," "kitchen-routing-category," "lookup," "loyalty-customer-identification-method," "measure," "media-library," "menu," "menu-category," "menu-item-group," "metadata," "min-wage-config," "modifier-build," "modifier-collection," "modifier-group," "modifier-priority," "named-calculation," "notification-template," "online-ordering-settings," "order-destination," "order-lane," "order-screen," "order-source," "pay-type," "pay-type-scheme," "payroll-compensation-mapping," "payroll-employee-status-mapping," "payroll-job-category-mapping," "payroll-job-mapping," "payroll-rate-name-mapping," "payroll-termination-reason-mapping," "payroll-work-site-mapping," "payrule-group," "peripheral," "peripheral-schema," "phone-type," "pos-job-code," "pos-pay-mapping," "pos-punch-type," "pos-reason-code," "preferences," "product," "product-availability," "product-category," "product-ingredient," "product-price," "punch-adjustment-reason," "punch-type," "receipt-content-template," "receipt-message," "receipt-template," "recipe," "report-options," "report-options-category," "reporting-category," "schedule-type," "school-district," "store-hours-config," "store-hours-config-group," "tag," "tag-rule," "tare," "tax-definition," "tax-group," "tax-group-set," "tax-jurisdiction," "tender-category," "tender-currency," "tender-mapping," "terminal," "terminal-scheme," "time-period," "tip-group," "variant," "variant-type," "vendor," "vendor-type," "w4-filing-status," "web-menu-metadata," "web-meta-data," "work-type," "xks-bumpbar," "xks-display," "xks-display-definition," "xks-display-scheme," "xks-general-settings," "xks-screen-config," "xks-screen-filter," or "xks-station-config."

cart_entity_id

string, object

Yes

name

string

No

status

string

No

The possible values are "deployed" or "failed"

_ui_entity_type

string

No

deployed_at

string, object

No

The date-time the cart is deployed

deployed_by

string

No

document_change

object

Yes

meta

object

No

entity_id

entity_id

No

external_id

external_id

No

_change_id

string, object

No

The service field to access certain changes in the cart

document_entity_id

string, object

No

A reference link to the document to which the change is related

entity_type

string

No

The entity that is touched by this change (For example, product, product-price).

The possible values are "action-type," "address-type," "allergen," "allowed-labor-cost," "audio-file," "break-time," "bundle-component," "bundle-component-price," "bundle-type," "business-rule-group," "business-rule-validate-model," "calendar," "calendar-type," "card-bin-data," "configuration-group," "count-frequency," "country," "country-state," "currency-scheme," "custom-label-definition," "data-kit," "date-range," "day-part," "day-part-group," "day-part-type," "dictionary," "discount-definition," "donation," "dynamic-matrix," "email-type," "employee-status-change-reason," "employee-status-config," "ethnicity," "event-type," "fee-definition," "fixed-matrix," "floor-plan," "forecast-definition," "forecast-definition-mapping," "general-ledger-account," "gift-service," "history-definition," "house-account," "house-account-status," "i9-document-class," "i9-status," "image-set," "inventory-item," "inventory-location," "job-change-reason," "job-code," "job-code-category," "job-code-rate," "job-station," "kitchen-printer-role," "kitchen-routing-category," "lookup," "loyalty-customer-identification-method," "measure," "media-library," "menu," "menu-category," "menu-item-group," "metadata," "min-wage-config," "modifier-build," "modifier-collection," "modifier-group," "modifier-priority," "named-calculation," "notification-template," "online-ordering-settings," "order-destination," "order-lane," "order-screen," "order-source," "pay-type," "pay-type-scheme," "payroll-compensation-mapping," "payroll-employee-status-mapping," "payroll-job-category-mapping," "payroll-job-mapping," "payroll-rate-name-mapping," "payroll-termination-reason-mapping," "payroll-work-site-mapping," "payrule-group," "peripheral," "peripheral-schema," "phone-type," "pos-job-code," "pos-pay-mapping," "pos-punch-type," "pos-reason-code," "preferences," "product," "product-availability," "product-category," "product-ingredient," "product-price," "punch-adjustment-reason," "punch-type," "receipt-content-template," "receipt-message," "receipt-template," "recipe," "report-options," "report-options-category," "reporting-category," "schedule-type," "school-district," "store-hours-config," "store-hours-config-group," "tag," "tag-rule," "tare," "tax-definition," "tax-group," "tax-group-set," "tax-jurisdiction," "tender-category," "tender-currency," "tender-mapping," "terminal," "terminal-scheme," "time-period," "tip-group," "variant," "variant-type," "vendor," "vendor-type," "w4-filing-status," "web-menu-metadata," "web-meta-data," "work-type," "xks-bumpbar," "xks-display," "xks-display-definition," "xks-display-scheme," "xks-general-settings," "xks-screen-config," "xks-screen-filter," or "xks-station-config."

cart_entity_id

string, object

No

name

string

No

status

string

No

The possible values are "deployed" or "failed"

_ui_entity_type

string

No

deployed_at

string, object

No

The date-time the cart is deployed

deployed_by

string

No

document_change

object

No

meta

object

No

external_id

external_id

No

total

integer

items

[ cart_change ]

_change_id

string, object

Yes

This is service field to access to certain change in the cart

document_entity_id

string, object

Yes

Is a reference link to the document to which the change is related

entity_type

string

Yes

It means the entity that is touched by this change (For example, product, product-price).

The possible values are "action-type," "address-type," "allergen," "allowed-labor-cost," "audio-file," "break-time," "bundle-component," "bundle-component-price," "bundle-type," "business-rule-group," "business-rule-validate-model," "calendar," "calendar-type," "card-bin-data," "configuration-group," "count-frequency," "country," "country-state," "currency-scheme," "custom-label-definition," "data-kit," "date-range," "day-part," "day-part-group," "day-part-type," "dictionary," "discount-definition," "donation," "dynamic-matrix," "email-type," "employee-status-change-reason," "employee-status-config," "ethnicity," "event-type," "fee-definition," "fixed-matrix," "floor-plan," "forecast-definition," "forecast-definition-mapping," "general-ledger-account," "gift-service," "history-definition," "house-account," "house-account-status," "i9-document-class," "i9-status," "image-set," "inventory-item," "inventory-location," "job-change-reason," "job-code," "job-code-category," "job-code-rate," "job-station," "kitchen-printer-role," "kitchen-routing-category," "lookup," "loyalty-customer-identification-method," "measure," "media-library," "menu," "menu-category," "menu-item-group," "metadata," "min-wage-config," "modifier-build," "modifier-collection," "modifier-group," "modifier-priority," "named-calculation," "notification-template," "online-ordering-settings," "order-destination," "order-lane," "order-screen," "order-source," "pay-type," "pay-type-scheme," "payroll-compensation-mapping," "payroll-employee-status-mapping," "payroll-job-category-mapping," "payroll-job-mapping," "payroll-rate-name-mapping," "payroll-termination-reason-mapping," "payroll-work-site-mapping," "payrule-group," "peripheral," "peripheral-schema," "phone-type," "pos-job-code," "pos-pay-mapping," "pos-punch-type," "pos-reason-code," "preferences," "product," "product-availability," "product-category," "product-ingredient," "product-price," "punch-adjustment-reason," "punch-type," "receipt-content-template," "receipt-message," "receipt-template," "recipe," "report-options," "report-options-category," "reporting-category," "schedule-type," "school-district," "store-hours-config," "store-hours-config-group," "tag," "tag-rule," "tare," "tax-definition," "tax-group," "tax-group-set," "tax-jurisdiction," "tender-category," "tender-currency," "tender-mapping," "terminal," "terminal-scheme," "time-period," "tip-group," "variant," "variant-type," "vendor," "vendor-type," "w4-filing-status," "web-menu-metadata," "web-meta-data," "work-type," "xks-bumpbar," "xks-display," "xks-display-definition," "xks-display-scheme," "xks-general-settings," "xks-screen-config," "xks-screen-filter," or "xks-station-config."

cart_entity_id

string, object

Yes

name

string

No

status

string

No

The possible values are "deployed," "failed," "skipped," or "in_progress"

_ui_entity_type

string

No

deployed_at

string, object (date-time)

No

deployed_by

string

No

document_change

object

Yes

meta

object

No

dependent_on

string

No

group_id

string

No

expire_at

string, object (date-time)

No

_id

_id

No

company_id

company_id

No

entity_id

entity_id

No

is_master

is_master

No

is_active

is_active

No

external_id

external_id

No

created_by

created_by

No

updated_by

updated_by

No

created_at

created_at

No

updated_at

updated_at

No

_change_id

string, object

Yes

Service field to access certain changes in the cart

document_entity_id

string, object

Yes

A reference link to the document to which the change is related

entity_type

string

Yes

The entity that is touched by this change (For example, product, product-price).

The possible values are "action-type," "address-type," "allergen," "allowed-labor-cost," "audio-file," "break-time," "bundle-component," "bundle-component-price," "bundle-type," "business-rule-group," "business-rule-validate-model," "calendar," "calendar-type," "card-bin-data," "configuration-group," "count-frequency," "country," "country-state," "currency-scheme," "custom-label-definition," "data-kit," "date-range," "day-part," "day-part-group," "day-part-type," "dictionary," "discount-definition," "donation," "dynamic-matrix," "email-type," "employee-status-change-reason," "employee-status-config," "ethnicity," "event-type," "fee-definition," "fixed-matrix," "floor-plan," "forecast-definition," "forecast-definition-mapping," "general-ledger-account," "gift-service," "history-definition," "house-account," "house-account-status," "i9-document-class," "i9-status," "image-set," "inventory-item," "inventory-location," "job-change-reason," "job-code," "job-code-category," "job-code-rate," "job-station," "kitchen-printer-role," "kitchen-routing-category," "lookup," "loyalty-customer-identification-method," "measure," "media-library," "menu," "menu-category," "menu-item-group," "metadata," "min-wage-config," "modifier-build," "modifier-collection," "modifier-group," "modifier-priority," "named-calculation," "notification-template," "online-ordering-settings," "order-destination," "order-lane," "order-screen," "order-source," "pay-type," "pay-type-scheme," "payroll-compensation-mapping," "payroll-employee-status-mapping," "payroll-job-category-mapping," "payroll-job-mapping," "payroll-rate-name-mapping," "payroll-termination-reason-mapping," "payroll-work-site-mapping," "payrule-group," "peripheral," "peripheral-schema," "phone-type," "pos-job-code," "pos-pay-mapping," "pos-punch-type," "pos-reason-code," "preferences," "product," "product-availability," "product-category," "product-ingredient," "product-price," "punch-adjustment-reason," "punch-type," "receipt-content-template," "receipt-message," "receipt-template," "recipe," "report-options," "report-options-category," "reporting-category," "schedule-type," "school-district," "store-hours-config," "store-hours-config-group," "tag," "tag-rule," "tare," "tax-definition," "tax-group," "tax-group-set," "tax-jurisdiction," "tender-category," "tender-currency," "tender-mapping," "terminal," "terminal-scheme," "time-period," "tip-group," "variant," "variant-type," "vendor," "vendor-type," "w4-filing-status," "web-menu-metadata," "web-meta-data," "work-type," "xks-bumpbar," "xks-display," "xks-display-definition," "xks-display-scheme," "xks-general-settings," "xks-screen-config," "xks-screen-filter," or "xks-station-config."

cart_entity_id

string, object

Yes

name

string

No

status

string

No

The possible values are "deployed," "failed," "skipped," or "in_progress"

_ui_entity_type

string

No

deployed_at

string, object (date-time)

No

deployed_by

string

No

document_change

object

Yes

meta

object

No

dependent_on

string

No

group_id

string

No

expire_at

string, object (date-time)

No

entity_id

entity_id

No

external_id

external_id

No

_change_id

string, object

The service field to access certain changes in the cart

document_entity_id

string, object

Reference link to the document to which the change is related

entity_type

string

The entity that is touched by the change (For example, product, product-price).

The possible values are "action-type," "address-type," "allergen," "allowed-labor-cost," "audio-file," "break-time," "bundle-component," "bundle-component-price," "bundle-type," "business-rule-group," "business-rule-validate-model," "calendar," "calendar-type," "card-bin-data," "configuration-group," "count-frequency," "country," "country-state," "currency-scheme," "custom-label-definition," "data-kit," "date-range," "day-part," "day-part-group," "day-part-type," "dictionary," "discount-definition," "donation," "dynamic-matrix," "email-type," "employee-status-change-reason," "employee-status-config," "ethnicity," "event-type," "fee-definition," "fixed-matrix," "floor-plan," "forecast-definition," "forecast-definition-mapping," "general-ledger-account," "gift-service," "history-definition," "house-account," "house-account-status," "i9-document-class," "i9-status," "image-set," "inventory-item," "inventory-location," "job-change-reason," "job-code," "job-code-category," "job-code-rate," "job-station," "kitchen-printer-role," "kitchen-routing-category," "lookup," "loyalty-customer-identification-method," "measure," "media-library," "menu," "menu-category," "menu-item-group," "metadata," "min-wage-config," "modifier-build," "modifier-collection," "modifier-group," "modifier-priority," "named-calculation," "notification-template," "online-ordering-settings," "order-destination," "order-lane," "order-screen," "order-source," "pay-type," "pay-type-scheme," "payroll-compensation-mapping," "payroll-employee-status-mapping," "payroll-job-category-mapping," "payroll-job-mapping," "payroll-rate-name-mapping," "payroll-termination-reason-mapping," "payroll-work-site-mapping," "payrule-group," "peripheral," "peripheral-schema," "phone-type," "pos-job-code," "pos-pay-mapping," "pos-punch-type," "pos-reason-code," "preferences," "product," "product-availability," "product-category," "product-ingredient," "product-price," "punch-adjustment-reason," "punch-type," "receipt-content-template," "receipt-message," "receipt-template," "recipe," "report-options," "report-options-category," "reporting-category," "schedule-type," "school-district," "store-hours-config," "store-hours-config-group," "tag," "tag-rule," "tare," "tax-definition," "tax-group," "tax-group-set," "tax-jurisdiction," "tender-category," "tender-currency," "tender-mapping," "terminal," "terminal-scheme," "time-period," "tip-group," "variant," "variant-type," "vendor," "vendor-type," "w4-filing-status," "web-menu-metadata," "web-meta-data," "work-type," "xks-bumpbar," "xks-display," "xks-display-definition," "xks-display-scheme," "xks-general-settings," "xks-screen-config," "xks-screen-filter," or "xks-station-config."

cart_entity_id

string, object

name

string

status

string

The possible values are "deployed," "failed," "skipped," or "in_progress"

_ui_entity_type

string

deployed_at

string, object (date-time)

deployed_by

string

document_change

object

meta

object

dependent_on

string

group_id

string

expire_at

string, object (date-time)

external_id

external_id

total

integer

items

[ cart_change_history ]

current_page

number

page_count

number

page_size

number

items

[ object ]

current_page

number

page_count

number

page_size

number

entity_id

string

name

string

is_scheduled

boolean

A possible values are "true" or "false"

status

string

name

string

No

is_scheduled

boolean

No

External carts cannot be scheduled for now.

The possible values are "true" or "false"

status

string

Yes

External carts should have the ready_to_deploy status.

The possible value is "ready_to_deploy"

changes

[ cart_external_change_item ]

No

The entities changes array

entity_reference_id

string, number

Yes

The identifier that should be provided by the integrator

entity_id

string

No

entity_type

string

Yes

The entity that is touched by the change. For example, product, product-price).

The possible values are "action-type," "address-type," "allergen," "allowed-labor-cost," "audio-file," "break-time," "bundle-component," "bundle-component-price," "bundle-type," "business-rule-group," "business-rule-validate-model," "calendar," "calendar-type," "card-bin-data," "configuration-group," "count-frequency," "country," "country-state," "currency-scheme," "custom-label-definition," "data-kit," "date-range," "day-part," "day-part-group," "day-part-type," "dictionary," "discount-definition," "donation," "dynamic-matrix," "email-type," "employee-status-change-reason," "employee-status-config," "ethnicity," "event-type," "fee-definition," "fixed-matrix," "floor-plan," "forecast-definition," "forecast-definition-mapping," "general-ledger-account," "gift-service," "history-definition," "house-account," "house-account-status," "i9-document-class," "i9-status," "image-set," "inventory-item," "inventory-location," "job-change-reason," "job-code," "job-code-category," "job-code-rate," "job-station," "kitchen-printer-role," "kitchen-routing-category," "lookup," "loyalty-customer-identification-method," "measure," "media-library," "menu," "menu-category," "menu-item-group," "metadata," "min-wage-config," "modifier-build," "modifier-collection," "modifier-group," "modifier-priority," "named-calculation," "notification-template," "online-ordering-settings," "order-destination," "order-lane," "order-screen," "order-source," "pay-type," "pay-type-scheme," "payroll-compensation-mapping," "payroll-employee-status-mapping," "payroll-job-category-mapping," "payroll-job-mapping," "payroll-rate-name-mapping," "payroll-termination-reason-mapping," "payroll-work-site-mapping," "payrule-group," "peripheral," "peripheral-schema," "phone-type," "pos-job-code," "pos-pay-mapping," "pos-punch-type," "pos-reason-code," "preferences," "product," "product-availability," "product-category," "product-ingredient," "product-price," "punch-adjustment-reason," "punch-type," "receipt-content-template," "receipt-message," "receipt-template," "recipe," "report-options," "report-options-category," "reporting-category," "schedule-type," "school-district," "store-hours-config," "store-hours-config-group," "tag," "tag-rule," "tare," "tax-definition," "tax-group," "tax-group-set," "tax-jurisdiction," "tender-category," "tender-currency," "tender-mapping," "terminal," "terminal-scheme," "time-period," "tip-group," "variant," "variant-type," "vendor," "vendor-type," "w4-filing-status," "web-menu-metadata," "web-meta-data," "work-type," "xks-bumpbar," "xks-display," "xks-display-definition," "xks-display-scheme," "xks-general-settings," "xks-screen-config," "xks-screen-filter," or "xks-station-config."

site_values_patch

cart_site_value_patch

No

cart_site_value_patch

object

name

string

effective_date

string

The date and time the document becomes "current."

If the entity is updated on a specific date, then specifying an effective_date prior to that date returns a previous version of the entity.

site_ids

array

An array of site identifiers

_id

string

The auto-assigned system document identifier

company_id

string

The identifier of the company that owns the document

entity_id

string

The auto-assigned UID of the entity, set on creation. All future versions of the entity share the same entity_id.

is_master

boolean

is_active

boolean

Marking property is the essence of active documents. Sets in true by default.

external_id

string

created_by

string

The identifier of the OPRA user or site that created the document

updated_by

string

The identifier of the OPRA user or site that last updated the document

created_at

string

The last date and time the document was updated

updated_at

string

The last date and time the document was updated