Get Shipping Template Availability

GET

/logistics/202510/seller_templates

Get seller’s available shipping template and return the reason why the template is not available，this api is now only available for JP and UK market

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Request Body

Media typeapplication/json

object

product_attribute

The product’s dimensions and weight to use when evaluating shipping template availability.

object

weight

The weight of product

object

weight

The weight of product

string

unit

1:gram 2:pound 3:ounce 4:kilogram

integer format: int64

dimension

The dimension of the product

object

length

The length of the product

string

width

The width of the product

string

height

The height of the product

string

unit

1: centimeter 2:inch 3:foot 4:millimeter 5:meter

integer format: int64

Example^generated

{
  "product_attribute": {
    "weight": {
      "weight": "example",
      "unit": 1
    },
    "dimension": {
      "length": "example",
      "width": "example",
      "height": "example",
      "unit": 1
    }
  }
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

templates

Shipping templates evaluated for availability for the seller’s shop.

Array<object>

object

template_is_available

Whether the template is available

boolean

template

Shipping template details, including the template ID, name, fulfillment party, and whether it is the default template.

object

template_name

The template name

string

template_id

The template_id

string

is_default

Is default template or not

boolean

template_party

1 for shipping by platform template 2 for shipping by seller template

integer format: int64

service_unreachable_reason

Reasons the shipping template is unavailable, grouped by shipping service. This field is omitted when the template is available.

Array<object>

object

service_id

Id of the service

string

filter_reason

Reasons this shipping service is unavailable for the template.

Array<object>

object

filter_type

1 for length filter 2 for width filter 3 for height filter 4 for weight filter 9 for service mode filter 11 for service filter

string

reason

Detailed reason for unreachable

string

Example

{
  "code": 0,
  "data": {
    "templates": [
      {
        "template_is_available": false,
        "template": {
          "template_name": "test template",
          "template_id": "1234566",
          "is_default": false,
          "template_party": 1
        },
        "service_unreachable_reason": [
          {
            "service_id": "23241",
            "filter_reason": [
              {
                "filter_type": "9",
                "reason": "Ship by seller is banned"
              }
            ]
          }
        ]
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}