Get Eligible Shipping Services

POST

/fulfillment/202309/orders/{order_id}/shipping_services/query

Retrieve available shipping services in the US and JP. Package dimensions and weight are optional inputs used to calculate the available options. Shipping fees and delivery times are estimates based on the package attributes used for the query, and the available options may change if those attributes change at the time of shipping.

Authorizations

• accessToken

Parameters

Path Parameters

order_id

required

string

TikTok Shop order ID

Query Parameters

shop_cipher

required

string

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

Request Body

Media typeapplication/json

object

order_line_item_ids

Order line item ID list

Array<string>

weight

The weight of the scheduled package.

object

value

required

The weight of the scheduled package.

string

unit

required

The unit of measurement is used to measure the weight.

• GRAM
• POUND

string

dimension

The dimensions of the scheduled package.

object

length

required

The length of the package. The length, width, height must be passed together.

string

width

required

The width of the package. The length, width, height must be passed together.

string

height

required

The height of the package. The length, width, height must be passed together.

string

unit

required

The unit of measurement for the package dimensions.

• CM
• INCH

string

order_line_list

This new parameter is completely backward compatible with the previous oder_line_items_ids field and in addition this supports bundle order splitting, use the sub items accordingly

Array<object>

object

order_line_id

The corresponding order line ID.

string

sub_item_id

The sub-order-line ID inside a bundle product.

• Required for bundle products.
• Not required for non-bundle products.

string

Example

{
  "order_line_item_ids": [
    "32132124331234"
  ],
  "weight": {
    "value": "0.4",
    "unit": "GRAM"
  },
  "dimension": {
    "length": "0.3",
    "width": "0.2",
    "height": "0.2",
    "unit": "INCH"
  },
  "order_line_list": [
    {
      "order_line_id": "57632132124331234",
      "sub_item_id": "57632132124331234"
    }
  ]
}

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

order_id

TikTok Shop order ID

string

order_line_id

Line item ID list

Array<string>

weight

The weight of the scheduled package.

object

value

The weight of the scheduled package.

string

unit

The unit of measurement is used to measure the weight.

• GRAM
• POUND

string

shipping_services

The shipping services available for the order.

Array<object>

object

id

Shipping service ID

string

name

Shipping service Name

string

price

Estimated total price for this Shipping services

string

currency

Currency of the price

string

earliest_delivery_days

The minimum estimated duration required for parcel delivery.US only.

integer format: int64

latest_delivery_days

The maximum estimated duration required for parcel delivery.US only.

integer format: int64

is_default

Whether it is the default shipping service

boolean

shipping_provider_name

The name of shipping provider.US only.

string

shipping_provider_id

The ID of shipping provider.US only.

string

shipping_fee

Shipping fee

string

shipping_app_service_fee

Shipping surcharge paid to the ERPs

string

signature_fee

Signature service fee

string

dimension

The dimension of the scheduled package.

object

length

The length of the package.

string

width

The width of the package.

string

height

The height of the package.

string

unit

The unit of measurement for the package dimensions.

• CM
• INCH

string

Example

{
  "code": 0,
  "data": {
    "order_id": "28823355942588",
    "order_line_id": [
      "32132124331234"
    ],
    "weight": {
      "value": "1.2",
      "unit": "GRAM"
    },
    "shipping_services": [
      {
        "id": "288233559123860015",
        "name": "UPS-first class",
        "price": "5",
        "currency": "USD",
        "earliest_delivery_days": 3,
        "latest_delivery_days": 5,
        "is_default": false,
        "shipping_provider_name": "UPS",
        "shipping_provider_id": "288233559123860012",
        "shipping_fee": "3",
        "shipping_app_service_fee": "1",
        "signature_fee": "1"
      }
    ],
    "dimension": {
      "length": "0.3",
      "width": "0.2",
      "height": "0.04",
      "unit": "INCH"
    }
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}