Description

Query Parcel List Interface，query by created_time asc

Request URL

/rest/sc_api/parcel/list

Request Method

POST

Content-Type

application/json

Common Parameter (Request Header)

Request Parameter

Name	Data Type	Mandatory	Description
order_no	String[]	N	order no of Orders. limit 50
fp_parcel_no	String[]	N	parcel no of fulfillment point. limit 50
tracking_no	String	N	tracking no
created_date_from	Long	N	from date of created_date range.
created_date_to	Long	N	to date of created_date range.
offset	Int	N	Number of datas to skip at the beginning of the list. Default 0.
limit	Int	N	The maximum number of datas that can be returned. The supported maximum number is 50.

Request Example

{
    "offset": 0,
    "limit": 50,
    "order_no": ["ORDER001", "ORDER002"],
    "fp_parcel_no": ["PARCEL001", "PARCEL002"],
    "tracking_no": "TN001",
    "created_date_from": 1630454400000,
    "created_date_to": 1630540800000
}

Parcel Standard Response Properties Definition (Object[])

Name	Data Type	Description
parcel_id	Integer	Unique identifier for parcel id
parcel_type	String	Description of parcel type
created_date	Integer	Date related to the created date (in UNIX timestamp)
fulfillment_point	String	Description of fulfillment point
fp_parcel_no	String	Description of fp parcel no
us_parcel_no	String	Description of us parcel no
status	String	Description of status
weight	Double	Description of weight
length	Double	Description of length
height	Double	Description of height
width	Double	Unique identifier for width
tracking_no	String	Description of tracking no
source_location	String	Description of source location
dest_location	String	Description of dest location
waybill_url	String	Description of waybill url
items	Object[]	Description of items
├── orig_order_item_id	Integer	Unique identifier for orig order item id
├── order_item_status	String	Description of order item status
├── sc_spu_id	String	Unique identifier for sc spu id
├── sc_sku_code	String	Description of sc sku code
├── sku_code	String	Description of sku code
├── sku_name	String	Name of the sku name
├── qty	Integer	Description of qty
├── weight	Double	Description of weight
├── brand_name	String	Name of the brand name
├── brand_sku_code	String	Description of brand sku code

Success Response Example

  {
   "code": "200",
   "data": [
   {
       "parcel_id": 1212,
       "parcel_type": "",
       "created_date": 1616317631,
       "fulfillment_point": "FP0001",
       "fp_parcel_no": "PARCEL001",
       "us_parcel_no": "SHOPEE-PARCEL001",
       "status": "In Transit",
       "weight": 1.11,
       "length": 1.11,
       "height": 1.11,
       "width": 1.11,
       "tracking_no": "TN001",
       "source_location": "8 Bulim Ave, Singapore 648166",
       "dest_location": "",
       "waybill_url":"https://xxxxxxxxxx",
       "items":[{
           "orig_order_item_id": 1001,
           "order_item_status":"PACKED",
           "sc_spu_id": "1001",
           "sc_sku_code": "SHOPEE-SKU0001",
           "sku_code": "SKU001",
           "sku_name": "SKU001",
           "qty": 10,
           "weight": 1.11,
           "brand_name": "",
           "brand_sku_code": ""
       }]
    }
    ],
    "total_count": 1,
    "message": "success",
    "request_id": "2d48f902-7efa-4718-8b88-9686803a8a02"
  }

Error Response Example

results matching ""

No results matching ""