Skip to main content

​
Overview

Retrieve all documents related to an order, including the commercial invoice and shipping labels. Documents are available after the order has been invoiced. You can retrieve documents using either the e-CROSS order ID or the sales channel order ID.

​
Get Order Documents

Retrieve documents for an order. Documents include the commercial invoice (which must be printed and placed inside the package) and package labels (which must be printed and attached to the external side of the package). 
curl -X GET 'https://order.api.e-cross.tech/ext/orders/ACME-ECOM-TEST-003/documents' \
  -H 'Authorization: Bearer YOUR_TOKEN'

{
  "status": "success",
  "documents": [
    {
      "name": "Invoice",
      "url": "https://pdfobject.com/pdf/sample.pdf"
    },
    {
      "name": "Label",
      "url": "https://pdfobject.com/pdf/sample.pdf"
    }
  ]
}

{
  "status": "processing"
}

​
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

​
status
string
required
Status of document availability:
  • success - Order is invoiced and all documents are available
  • processing - Documents are not available yet, order is waiting to be invoiced
​
documents
array
Array of documents related to the order. Only present when status is success. If status is processing, this field won’t be present.

​
Document Types

​
Invoice

The commercial invoice (name == "Invoice") must be:
  • Printed
  • Placed inside the package together with the SKU(s)

​
Labels

Package labels (name starts with "Label") must be:
  • Printed (there can be one or many labels)
  • Attached to the external side of the package
  • Recognized by logistic operators involved in the order’s linehaul
Documents are only available after the order reaches the INVOICED status. If you receive a processing status, wait for the order to be invoiced and try again.
After the package is sealed with the invoice inside and labels attached, it’s ready to move to the dispatch/pickup process, following what was commercially agreed.

Cancel Order

Next: Learn how to cancel an order