Orders

Create an Order record.

post

This endpoint receives orders from external systems. It requires a comprehensive payload that includes details about the order, such as the items purchased, applicable taxes, discounts, and the source and POS system of the order. It can optionally link the order to a program membership if the program_membership_id is provided.

Authorizations

Body

payload[order][line_items]arrayrequired

Line items in the order

payload[order][amount]numberrequired

Total amount of the order in cents

payload[order_source]stringrequired

Source of the order.

payload[type]stringrequired

What type of transaction occurred.

payload[merchant_pos_system]stringrequired

Type of POS system from which the order originates.

payload[external_order_guid]stringrequired

Unique identifier for the order from the external system.

payload[external_location_type]stringrequired

Type of the external location (e.g., ToastRestaurant).

payload[external_location_id]stringrequired

Unique identifier for the location from the external system (e.g., a restaurant ID from Toast).

payload[program_membership_id]stringoptional

Program membership ID if available. Nullable field to tie the order to a specific membership.

payload[external_customer_id]stringoptional

External customer ID associated with the order.

payload[order][applied_discounts]arrayoptional

List of reward IDs applied to the transaction as a whole

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/external/orders' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'payload[order][line_items]=&payload[order][amount]=1&payload[order_source]=text&payload[type]=text&payload[merchant_pos_system]=text&payload[external_order_guid]=text&payload[external_location_type]=text&payload[external_location_id]=text&payload[program_membership_id]=text&payload[external_customer_id]=text&payload[order][applied_discounts]='

200

200

No body

ok