v2.logistics.ship_booking

Use this api to initiate logistics including arrange pickup, dropoff. Should call v2.logistics.get_booking_shipping_parameter to fetch all required param first.

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
	"booking_sn": "201214JASXYXY6",
	"pickup": {
		"pickup_time_id": "-"
	},
	"dropoff": {}
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://open.admin.uat.shopee.io/api/v2/logistics/ship_booking?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"booking_sn\": \"201214JASXYXY6\",
   \"dropoff\": {},
   \"pickup\": {
      \"pickup_time_id\": \"-\"
   }
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://open.admin.uat.shopee.io/api/v2/logistics/ship_booking?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 => '{
    "booking_sn": "201214JASXYXY6",
    "dropoff": {},
    "pickup": {
        "pickup_time_id": "-"
    }
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

cURL

curl --location --request POST 'https://open.admin.uat.shopee.io/api/v2/logistics/ship_booking?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "booking_sn": "201214JASXYXY6",
   "dropoff": {},
   "pickup": {
      "pickup_time_id": "-"
   }
}'

Python

import requests
import json

url = "https://open.admin.uat.shopee.io/api/v2/logistics/ship_booking?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "booking_sn": "201214JASXYXY6",
  "dropoff": {},
  "pickup": {
    "pickup_time_id": "-"
  }
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
	"request_id": "2880a5a28510424eaa3288fd941fae2c",
	"error": "error_auth",
	"message": "Invalid access_token."
}

Error example

JSON

{
   "error": "common.unknown_error",
   "message": "Unknown error, detail: error_key:FULFILLMENT_BOOKING_DOES_NOT_EXIST.",
   "request_id": "635c3210a2cf49ab97c64226e6edb531"
}

Errors

Common errors

Update log