Orders

Buyer order structuring commercial lines before invoice, payment, or fulfillment.

Business object

Vue d’ensemble

Order endpoints cover creation, commercial transitions, and links with invoices. They expose line items as attached resources.

See also the business-model page order for semantics, relationships, and functional lifecycle.

Contrat JSON

Responses use the prefixed identifier ord_ and the field object to make the type explicit.

buyer_idstring

Identifier of the buyer company.

statusenum

`draft`, `created`, `confirmed`, `fulfilled`, `completed`, or `cancelled`.

amount_excluding_tax / amount_tax / amount_including_taxnumber

Order amounts. `amount_including_tax` must equal `amount_excluding_tax + amount_tax`.

currencystring

ISO currency of the amount.

checkout_session_idstring

Source checkout session, when applicable.

line_itemsarray

Attached commercial lines.

REST

Method	Endpoint	Usage
POST	`/v1/orders`	Create an order.
GET	`/v1/orders`	List orders, with filters for `merchant_id`, `buyer_id`, `contact_id`, `checkout_session_id`, or `status`.
GET	`/v1/orders/{id}`	Retrieve an order.
POST	`/v1/orders/{id}`	Update an order.
POST	`/v1/orders/{id}/confirm`	Confirm a `created` order.
POST	`/v1/orders/{id}/fulfill`	Mark a `confirmed` order as fulfilled.
POST	`/v1/orders/{id}/complete`	Mark a `fulfilled` order as completed.
POST	`/v1/orders/{id}/cancel`	Cancel a `draft`, `created`, or `confirmed` order.
GET	`/v1/orders/{id}/invoices`	List linked invoices.
POST	`/v1/orders/{id}/invoices`	Create an invoice from the order.
GET	`/v1/orders/{id}/line-items`	List order lines.

Events

These events can be consumed through platform webhooks when the account is configured to receive them.

order.createdorder.updatedorder.confirmedorder.fulfilledorder.completedorder.cancelled

Behavior

State transitions are strict and return an error when the order is not in the expected status.
Invoice/order links reference invoices and orders by their identifiers.