Create point-of-sale orders and retrieve them by ID or external reference. Orders convert to invoices at checkout.
GET Order by externalOrderId.
Looks up an order by the externalOrderId your application supplied at creation.
path Parameters
externalOrderIdThe external order identifier.
Headers
x-api-keyThe x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
GET Order by externalOrderId. › Responses
Returns the order details.
idUnique internal identifier for the order.
customerIdCustomer identifier associated with this order.
List of order line items.
invoiceNumberInvoice number associated with this order.
statusRepresents the current status of an order.
dateTimeCreatedDate when the order was created.
externalOrderIdExternal order identifier (maximum 20 characters).
Represents a delivery address with contact information.
orderMethodRepresents the method by which an order will be fulfilled.
pickupDeliveryTimeScheduled pickup or delivery time.
noteAny additional notes for the order.
routeDelivery route code. Inherited from the customer when not supplied explicitly.
seqStop sequence within the delivery route.
List of pre-payments made for this order.
Represents a payment endpoint configuration for external payment systems.
paymentMethodPayment method for an order.
cardLast4Last 4 digits of the card number, for display. Only populated when payment method is a credit card.
cardExpCard expiration in MMYY format. Only populated when payment method is a credit card.
GET Order by id.
Looks up an order by its internal POS identifier — the one assigned at creation and returned in the Location header of POST /orders.
path Parameters
idThe internal order identifier.
Headers
x-api-keyThe x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
GET Order by id. › Responses
Returns the order details.
idUnique internal identifier for the order.
customerIdCustomer identifier associated with this order.
List of order line items.
invoiceNumberInvoice number associated with this order.
statusRepresents the current status of an order.
dateTimeCreatedDate when the order was created.
externalOrderIdExternal order identifier (maximum 20 characters).
Represents a delivery address with contact information.
orderMethodRepresents the method by which an order will be fulfilled.
pickupDeliveryTimeScheduled pickup or delivery time.
noteAny additional notes for the order.
routeDelivery route code. Inherited from the customer when not supplied explicitly.
seqStop sequence within the delivery route.
List of pre-payments made for this order.
Represents a payment endpoint configuration for external payment systems.
paymentMethodPayment method for an order.
cardLast4Last 4 digits of the card number, for display. Only populated when payment method is a credit card.
cardExpCard expiration in MMYY format. Only populated when payment method is a credit card.
POST Order.
Create a point-of-sale order capturing the customer's purchase intent. Responds 201 Created with a Location header pointing to the created order (e.g. /orders/id/15007763).
X-Customer-Pin is required when payment.method is OnAccount, or when paying with a stored credit card (by cardId). It is not required for ad-hoc temp-card, cash, or food-stamp payments.
Include a paymentEndpoint to receive payment webhooks at checkout — without one, the invoice generated from the order remains unpaid and requires manual processing. Webhooks time out at 30 seconds.
Webhook orders: when a paymentEndpoint is supplied, the order's payment method is automatically set to Webhook — the configured processor settles the order at checkout. A paymentEndpoint therefore cannot be combined with a payment block (OnAccount/CreditCard); sending both returns 400.
Temp credit cards: a one-off payment.card is tokenized with the payment gateway on order creation and stored as a masked PAN + expiry + gateway token — the raw card number is never persisted.
Headers
x-api-keyThe x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
X-Customer-PinCustomer PIN for second-factor verification. Required when payment is OnAccount or uses a stored credit card (CardId).
POST Order. › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: customerId | |
| type = object · requires: customer |
customerIdExisting customer ID. If provided, the customer object is ignored.
externalOrderIdExternal order identifier (maximum 20 characters).
Request model for creating a new customer.
statusRepresents the current status of an order.
List of items in the order.
Request model for a delivery address.
orderMethodRepresents the method by which an order will be fulfilled.
pickupDeliveryTimeScheduled pickup or delivery time.
orderDateTimeThe Date and time when the order was placed. If not provided (or null), it defaults to the current date and time.
noteAny additional notes for the order.
routeDelivery route code (maximum 8 characters). Optional — defaults to the customer's route.
seqStop sequence within the delivery route. Optional — defaults to the customer's sequence.
List of pre-payments made for this order.
Represents a payment endpoint configuration for external payment systems.
Payment information for an order. Nested within OrderRequest. Supports On-Account or Credit Card (stored card by ID, or temp card).
POST Order. › Responses
Order created successfully.