v2.logistics.update_self_collection_order_logistics
POST /api/v2/logistics/update_self_collection_order_logistics
Use this api to update the order status for buyer to collect the orders directly from your pharmacy. This includes indicating that order is ready for collection, and that the order has been picked up by the buyer. You should call v2.logistics.get_order_detail or v2.logistics.get_package_detail first to get the package_number of such orders.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/logistics/update_self_collection_order_logistics
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 |
|---|---|---|---|---|
| package_number | string | True | OFG211171863281841 | Shopee's unique identifier for the package under an order. |
| self_collection_logistics_action | string | True | order_collected | Order logistics action. available values: - ready_for_collection - order_collected |
| epoc_image_list | string[] | False | ["id-11134284-7r98o-mef6xcoiw1nt15"] | List of image_id for the proof that buyer already collected the order at the store. Required when self_collection_logistics_action is order_collected. Max: 3. You can call the v2.media.upload_image to upload image and get the image_id, for this scenario, please pass the business = 1 and scene = 1. |
| pin | string | False | 123456 | PIN code required for prescription orders when buyer collects at your shop. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| 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. |
| request_id | string | 3dad66f43b8447d282ae6da36626c6b7 | The identifier for an API request for error tracking. |