v2.logistics.ship_order

Use this api to initiate logistics including arrange pickup, dropoff or shipment for non-integrated logistic channels. Should call v2.logistics.get_shipping_parameter to fetch all required param first. It's recommended to initiate logistics one hour after the orders were placed.

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
	"order_sn": "201212DCXHJUIKJ",
	"package_number": "",
	"pickup": {
		"address_id": 0,
		"pickup_time_id": "",
		"tracking_number": ""
	}
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/logistics/ship_order?partner_id=partner_id&sign=sign&access_token=access_token&timestamp=timestamp&shop_id=shop_id")
.header("Content-Type","application/json")
.body("{
   \"order_sn\": \"201212DCXHJUIKJ\",
   \"package_number\": \"\",
   \"pickup\": {
      \"address_id\": 0,
      \"pickup_time_id\": \"\",
      \"tracking_number\": \"\"
   }
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/logistics/ship_order?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 => '{
    "order_sn": "201212DCXHJUIKJ",
    "package_number": "",
    "pickup": {
        "address_id": 0,
        "pickup_time_id": "",
        "tracking_number": ""
    }
}',
  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/logistics/ship_order?partner_id=partner_id&sign=sign&access_token=access_token&timestamp=timestamp&shop_id=shop_id' \
--header 'Content-Type: application/json' \
--data-raw '{
   "order_sn": "201212DCXHJUIKJ",
   "package_number": "",
   "pickup": {
      "address_id": 0,
      "pickup_time_id": "",
      "tracking_number": ""
   }
}'

Python

import requests
import json

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

payload=json.dumps({
  "order_sn": "201212DCXHJUIKJ",
  "package_number": "",
  "pickup": {
    "address_id": 0,
    "pickup_time_id": "",
    "tracking_number": ""
  }
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.request("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
    "error": "",
    "message": "",
    "request_id": "3dad66f43b8447d282ae6da36626c6b7"
}

Error example

JSON

{
    "error": "logistics.ship_order_need_sender_real_name",
    "message": "Parameter sender_real_name can not be null.",
    "request_id": "6ea20540431c35f2a76cfbaa0c090683"
}

Errors

Common errors

Update log