Skip to content

Order List

POST/channel/api/v1/order/list

Auth: request-token (channel_partner)

Return a paginated list of orders belonging to shops bound to the authenticated channel partner. The shop_id filter, if provided, is restricted to the partner's bound set.

Request Headers

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

Request Body

FieldTypeRequiredDescription
pageNumberintegernoPage number, 1-based. Default 1
pageSizeintegernoPage size, max 100. Default 20
shop_idintegernoFilter by shop. Out-of-scope shops are silently ignored
stateintegernoOrder status filter (same enum as admin order list)
keywordsstringnoFree-text search across order number, shop order number, buyer name
order_nostringnoFilter by internal order number
shop_order_nostringnoFilter by the partner's own order number
start_timestringnoLower bound of create_time, format YYYY-MM-DD HH:mm:ss
end_timestringnoUpper bound of create_time, format YYYY-MM-DD HH:mm:ss

Response

json
{
  "code": 200,
  "msg": "success",
  "data": {
    "list": [
      {
        "id": 456,
        "order_no": "E2C-20260813-0001",
        "shop_order_no": "SO-1001",
        "order_status": "100",
        "order_status_text": "Pending Fulfillment",
        "create_time": "2026-08-13 10:00:00",
        "update_time": "2026-08-13 10:05:00",
        "delivery_time": null,
        "shop_id": 123,
        "shop": { "id": 123, "name": "Test Shop" },
        "warehouse": { "id": 1, "name": "Shenzhen Warehouse" },
        "shipping_standard": "STD",
        "currency_symbol": "EUR",
        "labels": [],
        "shipping_address": { "full_name": "John Doe", "country_code": "DE", "city": "Munich" },
        "billing_address": { "full_name": "John Doe", "country_code": "DE", "city": "Munich" },
        "order_item": [
          {
            "sku_id": 789,
            "sku": "PPS-500-BLK",
            "name": "Portable Power Station",
            "quantity": 2,
            "price": 49.90,
            "weight": 5.2,
            "origin_country": "CN",
            "hs_code": "8507600000",
            "shipping_standard": "STD",
            "remark": ""
          }
        ],
        "shipping_packages": [
          {
            "id": 1001,
            "order_id": 456,
            "tracking_number": "1Z999AA10123456784",
            "carrier_code": "UPS",
            "carrier_service_code": "GROUND",
            "gross_weight": 10.4,
            "container_gauge": "60*40*50",
            "std_meta": { "length": 60, "width": 40, "height": 50 },
            "shipped": true,
            "fulfillment_document": {
              "file": [],
              "document": []
            }
          }
        ],
        "fee_lines": [],
        "shop_total": 99.80,
        "meta_documents": [],
        "pallet_label_documents": []
      }
    ],
    "total": 1,
    "current_page": 1,
    "last_page": 1,
    "page_size": 20
  }
}

Sensitive Fields (filtered)

The following fields are never returned in the list response: sale_staff_id, up_staff, sales, member, transaction, invoice_infos, vip_group_id, sale_region, salesman, accountant, container_analysis, work_logs, private_remark, inner_remark, cost, margin.

Error Codes

codeMeaning
909Missing/invalid token, disabled app, or non-channel_partner type
200 (empty list)No orders match the filter or shop scope

cURL

cURL
curl -X POST 'https://apigate.e2c-energy.com/channel/api/v1/order/list' \
  -H 'request-token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "pageNumber": 1,
  "pageSize": 20,
  "state": 100
}'