# Submit Cart v2.0Beta
The Submit Cart endpoint submits a cart to the Order API for order processing. The cart is submitted and an order will be created. Our order processor will perform a number of checks and tasks before sending the order to the POS in the restaurant.
Currently this is a simple submission to start the order processors that attempt to get the order into our restaurant POS systems however this will evolve over time to cater for new or changed requirements.
The Order Status endpoint can be used to track the status of the order as it is processed through various third party systems.
# Request
# Authorization
An OAuth 2.0 Bearer token with the Order.Write
scope is required. For more information, see Authentication.
# Path Parameters
A list of the supported path parameters is described below.
Name | Required | Type | Description |
---|---|---|---|
profileKey | true | guid | The profile key for the customer. |
cartId | true | guid | The cart id for the cart. |
# Request Body
The request body is currently empty.
# Sample
{
// Empty
}
# Response
# Response Body
The endpoint returns our ApiResponse envelope. The data
property of the response will contain an orderId
that can be used to check the status of the order using the Order Status endpoint.
Name | Required | Type | Description |
---|---|---|---|
orderId | true | string | The unique identifier for the order that was created. |
# Sample
{
"message": "The operation succeeded!",
"notifications": [
{
"severity": "Success",
"text": "The cart was submitted and an order was created.",
"code": null,
"additionalData": null
}
],
"data": {
"orderId": "1366e104-94ac-4fb6-a4f2-6d81bb7d93bd"
}
}
# Errors
The standard error responses apply.
← Get Cart List Items →