Skip to content

Order Documents

POST/channel/api/v1/order/documents

Auth: request-token (channel_partner)

Return documents associated with an order. This includes order-level documents stored in t_documents and the fulfillment_document field on the order record.

Request Headers

HeaderRequiredDescription
request-tokenyesChannel partner app token
Content-Typeyesapplication/json

Request Body

FieldTypeRequiredDescription
order_idintegeryesOrder ID

Response

json
{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "source": "order",
      "name": "Commercial Invoice",
      "type": "pdf",
      "url": "https://cdn.example.com/docs/order-456-invoice.pdf",
      "template_id": 3,
      "created_at": "2026-08-13 10:05:00"
    },
    {
      "source": "order",
      "name": "Packing List",
      "type": "pdf",
      "url": "https://cdn.example.com/docs/order-456-packing.pdf",
      "template_id": 5,
      "created_at": "2026-08-13 10:06:00"
    }
  ]
}

Each entry has a source field:

  • "order" — from t_documents where type = 'order' and primary_key = order_id
  • "order" — from Order.fulfillment_document JSON field

Error Codes

codeMeaning
909Missing/invalid token
403Order not in partner's shop scope

cURL

cURL
curl -X POST 'https://apigate.e2c-energy.com/channel/api/v1/order/documents' \
  -H 'request-token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "order_id": 456
}'

Package Documents

POST/channel/api/v1/order/package/documents

Auth: request-token (channel_partner)

Return fulfillment documents for a specific order package.

Request Body

FieldTypeRequiredDescription
order_package_idintegeryesPackage ID

Response

json
{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "source": "package",
      "name": "Shipping Label",
      "type": "pdf",
      "url": "https://cdn.example.com/docs/pkg-1001-label.pdf"
    }
  ]
}

Pickup Documents

POST/channel/api/v1/order/pickup/documents

Auth: request-token (channel_partner)

Return documents attached to a pickup task. If at least one order linked to this pickup belongs to the partner's bound shops, all pickup documents are returned.

Request Body

FieldTypeRequiredDescription
pickup_task_idintegeryesPickup task ID

Response

json
{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "source": "pickup",
      "name": "Pickup Manifest",
      "type": "pdf",
      "url": "https://cdn.example.com/docs/pickup-500-manifest.pdf"
    }
  ]
}

If no linked order belongs to the partner's shops, a 403 is returned.