Skip to content
platform
EN PT

API reference · Orders · Marketplace Management

List Marketplace Orders

Method
GET
Route
/partnerOrders/list/store
Base URL
https://ws.autorei.net
Query parameters in the example
limit=5 offset=0
Token
Requires Bearer token
Test in Postman

Opens this request in the public API documentation, the official source of the reference.

Description

Lists the orders originated in your store — those your customers placed, including those that will be fulfilled by other partners —, from newest to oldest, with pagination and filters.

The scope is what sets this route apart from the store listing: here the criterion is the order's origin store, there it is the supplier partner. The response and the filters are identical.

Query Parameters

Parameter Type Required Description
limit integer No Orders per page. Default 5, cap 25. Above the cap, the cap applies.
offset integer No How many orders to skip. Default 0.
status string No Filters by status. Can be repeated to bring more than one: ?status=READY&status=SHIPPED. Without the parameter, all are returned.
createdFrom datetime No Created from this date, inclusive. ISO-8601: 2026-09-01T00:00:00Z.
createdTo datetime No Created up to this date, inclusive.
updatedFrom datetime No Changed from this date, inclusive.
updatedTo datetime No Changed up to this date, inclusive.

The values of status: PRE_ORDER · AWAITING_PAYMENT · PAYMENT_APPROVED · WITHOUT_CREDIT_LIMIT · READY · SHIPPED · DELIVERED · COMPLETED · CANCELED · STRAYED · RETURNED · STORE_PAYMENT.

Response · 200

Array of orders, sorted by creation date, newest to oldest. The nine fields are always present.

Field Description
id Partner order id (partnerOrderId). It is the one used in the route of the other order endpoints.
orderId Customer order id, the "parent" order. One orderId can have more than one id.
total Total value, as a string already formatted in reais: "R$637,57".
status Current order status.
dateCreated · lastUpdated Creation and last change, in UTC.
gateway Payment method used. Comes as null when the order has no payment yet.
partner.partnerName · partner.partnerDocument Name and document of the supplier partner.
customer.customerName · customer.customerDocument Name and document of the customer.

With no results, the response is an empty array.

Errors

Code When
401 Token missing, malformed, or expired.

Example request

curl --request GET 'https://ws.autorei.net/partnerOrders/list/store?limit=5&offset=0' \
  --header 'Authorization: Bearer {{access_token}}'

Example responses

200Success — two orders

[
  {
    "id": 900201,
    "orderId": 900100,
    "total": "R$637,57",
    "status": "PAYMENT_APPROVED",
    "dateCreated": "2026-09-02T11:04:18Z",
    "lastUpdated": "2026-09-02T11:12:40Z",
    "gateway": "GATEWAY_DE_PAGAMENTO",
    "partner": {
      "partnerName": "Loja Exemplo",
      "partnerDocument": "30.424.972/0001-74"
    },
    "customer": {
      "customerName": "Ana Paula Ribeiro",
      "customerDocument": "700.413.648-56"
    }
  },
  {
    "id": 900202,
    "orderId": 900101,
    "total": "R$81,64",
    "status": "AWAITING_PAYMENT",
    "dateCreated": "2026-09-01T13:26:05Z",
    "lastUpdated": "2026-09-01T13:27:26Z",
    "gateway": null,
    "partner": {
      "partnerName": "Loja Exemplo",
      "partnerDocument": "30.424.972/0001-74"
    },
    "customer": {
      "customerName": "Ana Paula Ribeiro",
      "customerDocument": "700.413.648-56"
    }
  }
]

Used in

Related endpoints

← See the group: Orders

Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.