v2.logistics.get_shipping_document_job_status
POST /api/v2/logistics/get_shipping_document_job_status
This API retrieves the status of a shipping document job using the job ID provided.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/logistics/get_shipping_document_job_status
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 |
|---|---|---|---|---|
| job_id | string | True | SDK0001_a86148a97a6e04ce2ed468968de344b7 | Generated Job ID for status tracking and download the Shipping Document |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | 5551ce8db5314c70a362dfe33544f074 | The identifier of the API request for error tracking. |
| error | string | error_auth | Indicate error type if hit error. Empty if no error happened. |
| message | string | Invalid access_token | Indicate error details if hit error. Empty if no error happened. |
| response | object | Detail informations you are querying. | |
| job_id | string | SDK0001_a86148a97a6e04ce2ed468968de344b7 | Generated Job ID for status tracking and download the Shipping Document |
| job_name | string | SKU ID (Thermal).*0.pdf | Generated Shipping Document file name. |
| job_status | string | READY | Requested Shipping Document current status. Available values: PROCESSING, READY, EXPIRED, FAILED |