v2.first_mile.bind_courier_delivery_first_mile_tracking_number

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

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
	"shipment_method": "courier_delivery",
	"binding_id": "DCN249601021852HU",
	"order_list": [
		{
			"order_sn": "2410106R7DE3BX"
		},
		{
			"order_sn": "2004239MRBBFPJ"
		}
	]
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/first_mile/bind_courier_delivery_first_mile_tracking_number?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"binding_id\": \"DCN249601021852HU\",
   \"order_list\": [
      {
         \"order_sn\": \"2410106R7DE3BX\",
         \"package_number\": \"-\"
      },
      {
         \"order_sn\": \"2004239MRBBFPJ\",
         \"package_number\": \"-\"
      }
   ],
   \"shipment_method\": \"courier_delivery\"
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/first_mile/bind_courier_delivery_first_mile_tracking_number?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
    "binding_id": "DCN249601021852HU",
    "order_list": [
        {
            "order_sn": "2410106R7DE3BX",
            "package_number": "-"
        },
        {
            "order_sn": "2004239MRBBFPJ",
            "package_number": "-"
        }
    ],
    "shipment_method": "courier_delivery"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

cURL

curl --location --request POST 'https://partner.shopeemobile.com/api/v2/first_mile/bind_courier_delivery_first_mile_tracking_number?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "binding_id": "DCN249601021852HU",
   "order_list": [
      {
         "order_sn": "2410106R7DE3BX",
         "package_number": "-"
      },
      {
         "order_sn": "2004239MRBBFPJ",
         "package_number": "-"
      }
   ],
   "shipment_method": "courier_delivery"
}'

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/first_mile/bind_courier_delivery_first_mile_tracking_number?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "binding_id": "DCN249601021852HU",
  "order_list": [
    {
      "order_sn": "2410106R7DE3BX",
      "package_number": "-"
    },
    {
      "order_sn": "2004239MRBBFPJ",
      "package_number": "-"
    }
  ],
  "shipment_method": "courier_delivery"
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
    "error": "",
    "message": "",
    "request_id": "317a860d24f7d1b81a941ef69e6f4300:040000adff1a0067:0300023c865b00dd",
    "response": {
        "binding_id": "DCN247547439397PU",
        "success_list": [
            {
                "order_sn": "2410106R7DE3BX",
                "package_number": "OFG182232177201507"
            }
        ],
        "fail_list": [
            {
                "order_sn": "2004239MRBBFPJ",
                "package_number": "",
                "fail_error": "firstmile.invalid_order_status",
                "fail_message": "The status of order(order_sn: 2004239MRBBFPJ) is invalid."
            }
        ]
    }
}

Errors

Common errors

Update log