Checkout

POST

/api/method/public/online-ordering/checkout

Transitions the cart into the next workflow stage (typically creating a bona fide order). The access token must have permission to checkout carts for the assigned online store.

Request

Authorization

Add parameter in header

X-Access-Token

Example:

X-Access-Token: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Checkout completed. The response body is empty on success.

Body

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST '/api/method/public/online-ordering/checkout' \
--header 'X-Access-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cart_id": "string"
}'

Response Example

200 - Example 1

null

Get address from coordinates

List currently online branches