Sales

A sale is the business’s part of a buyer’s order. A marketplace order can hold items from several sellers; each seller’s part ships, settles and pays out on its own, and each is one sale. These routes read the sales of the business that connected your app, as the seller. Orders the business placed as a buyer are not here.

Access

• A token from the authorization-code grant. A client-credentials token answers 403 0010010000406.
• The business must keep a valid payment card on file; without one, 403 0010010000407.
• Scope order:read, declared by your app and granted by the business on the consent page — see Business resources.

List sales

GET /api/order/v1/sales?status=SHIPPED&page=1&pageSize=20

status filters on the sale’s status (any case; an unknown one gives an empty page). Newest first.

{
  "data": [
    {
      "id": "6a1d4f0e-2b7c-4e55-9a10-0c3f6b8e2d71",
      "orderId": "1c9e7b52-0d4a-4c3e-8f61-5b2a9e0d7c44",
      "number": "UPC-2026-104233",
      "status": "SHIPPED",
      "orderStatus": "PARTIALLY_FULFILLED",
      "subtotal": 50.00,
      "discount": 5.00,
      "tax": 4.50,
      "feesAndLevies": 1.25,
      "deposit": 10.00,
      "shipping": 7.00,
      "totalAmount": 67.75,
      "currency": "USD",
      "placedAt": "2026-10-18T12:00:00Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 20, "total": 1 }
}

Get a sale

GET /api/order/v1/sales/{id}

{id} is the sale id (id above), not the order id. Another seller’s part of the same order answers 404, exactly like an id that does not exist.

/api/order/v1/orders and /api/order/v1/orders/{id} are aliases of these two routes (the module’s first name). They take the same parameters and the same sale id, and answer sales.

Fields

Field	Meaning
id	The sale.
orderId, number	The buyer’s order and the order number the buyer sees. One order number can appear in the sales of several businesses.
status	The sale’s status: PENDING, CONFIRMED, PROCESSING, READY, SHIPPED, PARTIALLY_FULFILLED, FULFILLED, CANCELLED, REFUNDED, ON_HOLD.
orderStatus	The whole order’s status.
subtotal … shipping	The sale’s own amounts, in major units of currency.
totalAmount	subtotal − discount + tax + feesAndLevies + deposit + shipping: what the buyer pays for this sale. It is not the business’s payout, which is net of platform fees.

Errors

Status	platformResponseCode	Cause
400	0010010000400	page or pageSize out of range.
404	Order_OrderCommerce_GT_Resource_FL	No such sale for this business.

Everything else follows Errors.