Skip to main content

​
Overview

List orders based on specified filters such as status, creation date range, and pagination. This endpoint is commonly used to identify orders ready for fulfillment (status READY_TO_SHIP).

​
List Orders

Retrieve a paginated list of orders matching your filters. 
curl -X GET 'https://order.api.e-cross.tech/ext/orders?status=READY_TO_SHIP&nextPageToken=' \
  -H 'Authorization: Bearer YOUR_TOKEN'

{
  "orders": [
    {
      "orderId": "ACME-ECOM-TEST-003",
      "merchantId": "ACME",
      "salesChannelOrderId": "TEST-003",
      "salesChannel": "ECOM",
      "status": "READY_TO_SHIP",
      "value": 234,
      "taxType": "DDU",
      "currency": "BRL",
      "foreignCurrency": "USD",
      "customerDocument": "1234567890",
      "creationDate": "2023-10-27T19:10:00Z",
      "lastUpdateDate": "2023-10-27T19:18:54.301Z",
      "totals": {
        "orderValue": 234,
        "itemsGross": 234,
        "itemsDiscount": 0,
        "shippingGross": 0,
        "shippingDiscount": 0,
        "taxes": 0,
        "grossInboundValue": 234,
        "fees": 0,
        "netInboundValue": 234
      },
      "totalsForeignCurrency": {
        "orderValue": 45,
        "itemsGross": 45,
        "itemsDiscount": 0,
        "shippingGross": 0,
        "shippingDiscount": 0,
        "taxes": 0,
        "grossOutboundValue": 45,
        "fees": 0,
        "netOutboundValue": 45
      },
      "items": [
        {
          "id": "c62c9ca2-de02-4580-94e5-e1fef5cb8e7c",
          "skuId": "ACME-1",
          "salesChannelSkuId": "1",
          "ean": "0799439112766",
          "quantity": 1,
          "name": "Awesome Toy",
          "listPrice": 234,
          "salePrice": 234,
          "foreignListPrice": 45,
          "foreignSalePrice": 45,
          "weight": 0.16,
          "hsCode": "29362900"
        }
      ],
      "customer": {
        "type": "PERSON",
        "firstName": "John",
        "lastName": "Doe",
        "document": "1234567890",
        "email": "[email protected]",
        "phone": {
          "countryCode": "55",
          "areaCode": "11",
          "number": "999999994"
        },
        "billingAddress": {
          "country": "BR",
          "state": "SP",
          "city": "São Paulo",
          "postalCode": "01218-000",
          "street": "Alameda Cleveland",
          "number": "31",
          "neighborhood": "Campos Elíseos",
          "receiverName": "John Doe"
        }
      },
      "shipping": {
        "outboundCountry": "CN",
        "deliveryAddress": {
          "country": "BR",
          "state": "SP",
          "city": "São Paulo",
          "postalCode": "01218-000",
          "street": "Alameda Cleveland",
          "number": "31",
          "neighborhood": "Campos Elíseos",
          "receiverName": "John Doe"
        },
        "deliveries": [
          {
            "name": "Normal",
            "company": "Company",
            "clearance": "Postal",
            "lastMileTrackingNumber": "NL970165916BR",
            "leadTime": 7,
            "listPrice": 0,
            "salePrice": 0,
            "deliveryTime": 7,
            "deliveryEstimateDate": "2023-11-07T19:10:00Z",
            "items": [
              "c62c9ca2-de02-4580-94e5-e1fef5cb8e7c"
            ],
            "parcels": [
              {
                "name": "Cardboard Small",
                "code": "CARD_SMALL",
                "length": 15,
                "width": 10,
                "height": 8,
                "weight": 0.04,
                "netWeight": 0.16,
                "grossWeight": 0.2,
                "items": [
                  {
                    "salesChannelSkuId": "1",
                    "quantity": 1
                  }
                ]
              }
            ]
          }
        ]
      },
      "payments": [
        {
          "type": "BILL",
          "value": 234
        }
      ]
    }
  ],
  "nextPageToken": "eyJjcmVhdGlvbkRhdGUiOiIyMDIzLTA5LTE2VDIyOjI1OjM5LjkzNloiLCJvcmRlcklkIjoiTVZQLVRFU1QtRUNPTS0wMDEiLCJ0eXBlIjoib3JkZXIifQ=="
}

​
Query Parameters

​
status
string
A single or comma-separated list of order statuses to filter. Supported statuses: CREATED, APPROVED, HANDLING, ON_HOLD, PACKED, INVOICED, READY_TO_SHIP, SHIPPED, DELIVERED, CANCELLED.
​
creationDateFrom
string
Filter only orders created after the specified date and time, in ISO 8601 format, inclusive. Example: 2025-03-06T17:14:53Z.
​
creationDateUntil
string
Filter only orders created before the specified date and time, in ISO 8601 format, inclusive. Example: 2025-03-06T17:14:53Z.
​
nextPageToken
string
The token to fetch the next page of results. Use the value returned in the nextPageToken field of the previous request.

​
Response Fields

​
orders
array
required
Array containing orders that match the specified filters.
​
nextPageToken
string
The token to be used in the query parameter to retrieve the next page of results. If there are no more results, this field won’t be returned.

​
Order Object Fields

​
orderId
string
required
The unique identifier of the order within e-CROSS. Use this in subsequent API calls.
​
salesChannelOrderId
string
required
The order identifier in the sales channel.
​
status
string
required
Current status of the order. See status values above.
​
value
number
required
The total value of the order.
​
currency
string
required
The currency used by the buyer to place the order.
​
foreignCurrency
string
required
The currency used by the merchant to sell the products.
​
totals
object
required
Order amounts summary in the buyer’s local currency.
​
totalsForeignCurrency
object
required
Order amounts summary in the merchant currency. Same structure as totals but in foreign currency.
​
items
array
required
Array with one line for each order item.
​
customer
object
required
Information about the customer who placed the order.
​
shipping
object
required
Shipping information including delivery address and deliveries (packages).
When an order is ready to be handled by fulfillment (picked and packed), its status changes to READY_TO_SHIP. Use status=READY_TO_SHIP to identify orders available for picking and packing.

Get Order

Next: Learn how to retrieve detailed order information