Skip to main content

​
Overview

Retrieve detailed information about a single order. You can retrieve an order using either the e-CROSS order ID or the sales channel order ID. The detailed response includes the complete order information plus status history.
Retrieve an order using the e-CROSS order ID.
curl -X GET 'https://order.api.e-cross.tech/ext/orders/ACME-ECOM-TEST-003' \
  -H 'Authorization: Bearer YOUR_TOKEN'

{
  "orderId": "ACME-ECOM-TEST-003",
  "merchantId": "ACME",
  "salesChannelOrderId": "TEST-003",
  "salesChannel": "ECOM",
  "status": "READY_TO_SHIP",
  "value": 234,
  "currency": "BRL",
  "foreignCurrency": "USD",
  "creationDate": "2023-10-27T19:10:00Z",
  "lastUpdateDate": "2023-10-27T19:18:54.301Z",
  "statusHistory": [
    {
      "receivedDate": "2023-10-27T19:18:27.139Z",
      "eventDate": "2023-10-27T19:10:00Z",
      "status": "CREATED"
    },
    {
      "receivedDate": "2023-10-27T19:18:32.293Z",
      "eventDate": "2023-10-27T19:20:00Z",
      "status": "APPROVED"
    },
    {
      "receivedDate": "2023-10-27T19:18:37.126Z",
      "eventDate": "2023-10-27T19:20:00Z",
      "status": "HANDLING"
    },
    {
      "eventData": {
        "packedSkuList": [
          {
            "skuId": "1",
            "quantity": 1
          }
        ],
        "parcelCode": "CARD_SMALL"
      },
      "receivedDate": "2023-10-27T19:18:38.232Z",
      "eventDate": "2023-10-27T19:18:38.232Z",
      "status": "PACKED"
    },
    {
      "eventData": {
        "number": "0000001",
        "value": 45,
        "items": [
          {
            "skuId": "1",
            "quantity": 1,
            "invoicedPrice": 45
          }
        ],
        "invoiceUrl": "https://pdfobject.com/pdf/sample.pdf"
      },
      "receivedDate": "2023-10-27T19:18:43.885Z",
      "eventDate": "2023-10-27T19:18:39.665Z",
      "status": "INVOICED"
    },
    {
      "eventData": {
        "documents": [
          {
            "name": "Label",
            "url": "https://pdfobject.com/pdf/sample.pdf"
          }
        ],
        "parcelId": "ACME800413194788BR"
      },
      "receivedDate": "2023-10-27T19:18:53.587Z",
      "eventDate": "2023-10-27T19:18:53.587Z",
      "status": "READY_TO_SHIP"
    }
  ],
  "items": [],
  "customer": {},
  "shipping": {},
  "payments": []
}

​
Path Parameters

​
orderId
string
required
The e-CROSS order ID. Use this when retrieving by order ID.
​
salesChannelOrderId
string
required
The sales channel order ID. Use this when retrieving by sales channel order ID.

​
Response Fields

The response includes all fields from the List Orders endpoint, plus:
​
statusHistory
array
required
The detailed status history of the order, showing all status changes and associated event data.
The statusHistory field is particularly useful for understanding the order lifecycle and retrieving important information like parcelId (found in READY_TO_SHIP status events) and document URLs.
To find the parcelId for shipment creation, look for the READY_TO_SHIP status in statusHistory and extract eventData.parcelId.

Get Order Documents

Next: Learn how to retrieve order documents