Skip to main content

v2.first_mile.bind_courier_delivery_first_mile_tracking_number

POST /api/v2/first_mile/bind_courier_delivery_first_mile_tracking_number

Use this api to bind first mile tracking number for courier delivery method.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/first_mile/bind_courier_delivery_first_mile_tracking_number

Common Request Parameters

NameTypeSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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

NameTypeRequiredSampleDescription
shipment_methodstringTruecourier_deliveryThe shipment method for generate and bind orders. Available value: courier_delivery.
binding_idstringTrueDCN247547439397PUIf using courier_delivery as the shipment method, the "binding_id" field should pass the value generated from v2.first_mile.generate_and_bind_first_mile_tracking_number.
order_listobject[]TrueThe list of order_sn. You can specify up to 50 order_sns in this call. One fm_tn maximum number of total bind orders is 10000.
order_snstringTrue2410106R7DE3BXShopee's unique identifier for an order.
package_numberstringFalseShopee's unique identifier for the package under an order. You should't fill the field with empty string when there isn't a package number.

Response Parameters

NameTypeSampleDescription
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
request_idstringThe identifier for an API request for error tracking.
responseobject
binding_idstringDCN249601021852HUBinding ID
success_listobject[]
order_snstring2410106R7DE3BXShopee's unique identifier for an order.
package_numberstringShopee's unique identifier for the package under an order.
fail_listobject[]
order_snstring2004239MRBBFPJShopee's unique identifier for an order.
package_numberstringShopee's unique identifier for the package under an order.
fail_errorstringfirstmile.invalid_order_statusIndicate error type if one element hit error.
fail_messagestringThe status of order(order_sn: 2004239MRBBFPJ) is invalid.Indicate error details if one element hit error.