v2.logistics.get_shipping_parameter

Use this api to check if the package support pickup, dropoff, or non-integrated method. For pickup, will return addresses and pickup time id options. For dropoff, will return branch id, sender real name etc, depending on 3PL requirements. [Please call this API when packages meet: 1) fulfillment status is LOGISTICS_READY; or 2) fulfillment status is LOGISTICS_PICKUP_RETRY; or 3) fulfillment status is LOGISTICS_REQUEST_CREATED and meet Instant Order Reschedule Pickup conditions]

Overview

Request parameters

Response parameters

Common parameters

Request samples

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/logistics/get_shipping_parameter?access_token=access_token&timestamp=timestamp&sign=sign&shop_id=shop_id&partner_id=partner_id&order_sn=201214JASXYXY6")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/logistics/get_shipping_parameter?access_token=access_token&order_sn=201214JASXYXY6&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 => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/logistics/get_shipping_parameter?shop_id=shop_id&partner_id=partner_id&order_sn=201214JASXYXY6&access_token=access_token&timestamp=timestamp&sign=sign' 

Python

import requests

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

payload={}
headers = {

}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
    "error": "",
    "message": "",
    "response": {
        "info_needed": {
            "dropoff": [],
            "pickup": [
                "address_id",
                "pickup_time_id"
            ]
        },
        "dropoff": null,
        "pickup": {
            "address_list": [
                {
                    "address_id": 123,
                    "region": "SG",
                    "state": "",
                    "city": "",
                    "district": "",
                    "town": "",
                    "address": "",
                    "zipcode": "40009",
                    "address_flag": [
                        "default_address",
                        "pickup_address",
                        "return_address"
                    ],
                    "time_slot_list": null
                },
                {
                    "address_id": 234,
                    "region": "SG",
                    "state": "",
                    "city": "",
                    "district": "",
                    "town": "",
                    "address": "hhh, #34",
                    "zipcode": "xxx",
                    "address_flag": [],
                    "time_slot_list": null
                }
            ]
        }
    },
    "request_id": "2880a5a28510424eaa3288fd941fae2c"
}

Error example

JSON

{
    "error": "error_not_found",
    "message": "Wrong parameters, detail: the order is not found.",
    "request_id": "44c2f2077941a5393c402cc42daf246e"
}

Errors

Common errors

Update log