v2.logistics.download_shipping_document
POST /api/v2/logistics/download_shipping_document
Use this api to download shipping_document. You have to call v2.logistics.create_shipping_document to create a new shipping document task first and call v2.logistics.get_shipping_document_resut to get the task status second. If the task is READY, you can download this shipping document.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/logistics/download_shipping_document
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| shipping_document_type | string | False | NORMAL_AIR_WAYBILL | The type of shipping document. Available values: NORMAL_AIR_WAYBILL, THERMAL_AIR_WAYBILL, NORMAL_JOB_AIR_WAYBILL, THERMAL_JOB_AIR_WAYBILL, THERMAL_UNPACKAGED_LABEL |
| order_list | object[] | True | The list of orders you need to download it's shipping document. | |
| order_sn | string | True | 201118BCKPJQQ8 | Shopee's unique identifier for an order. |
| package_number | string | False | 2485710696837122445 | Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| waybill | file | The waybill file. |