QueryFreightForward

GET /freight-forward/{carrier}

Query a specfic waybill in Freight Forwarding DB

Path parameters

  • carrier string Required

    Carrier name to ship, e.g. samarkand.sfexpress.test

Query parameters

  • status string Required

    package status, available options: UNPROCESSED, PACKED, PROCESSED, SHIPPED, CANCEL, ALL

    Values are UNPROCESSED, PACKED, PROCESSED, SHIPPED, CANCEL, or ALL. Default value is UNPROCESSED.

  • page_no integer(int32) Required

    Page number, between 1 and 1000

    Minimum value is 1, maximum value is 1000. Default value is 1.

  • page_size integer(int32) Required

    Page size, options: [1, 10, 50, 100, 1000]

    Values are 1, 10, 50, 100, or 1000. Default value is 10.

  • created_range string

    the time range of package update, use ISO_8601 format here, e.g. 2020-07-10T13:00:00Z/2020-07-11T15:30:00Z

Responses

GET /freight-forward/{carrier} 
curl \
 -X GET https://nomad.samarkand-global.cn/pilot/freight-forward/{carrier}?status=UNPROCESSED&page_no=1&page_size=10 \
 -H "x-ca-key: $API_KEY"
Response example (200) 
{
  "code": 42,
  "message": "string",
  "data": [],
  "total": 42
}
Response example (500) 
{
  "code": 42,
  "message": "string",
  "data": [],
  "total": 42
}