Confirm Package Shipment

POST

/supply_chain/202309/packages/sync

Use this API to submit package shipment information. Only warehouse service providers certified by TikTok Shop can access this API. Packages are processed independently, so a request can partially succeed. Review both success_packages and errors when handling the response.

Authorizations

• accessToken

Request Body^required

Media typeapplication/json

object

warehouse_provider_id

required

The unique warehouse provider ID assigned by TikTok Shop. The value must represent a positive base-10 integer.

string

packages

required

List of packages to confirm. Provide at least one package.

Array<object>

object

id

required

Package ID. The value must be a non-zero base-10 integer string no longer than 40 UTF-8 bytes.

string

wms_order_id

required

Warehouse Management System order number

string

provider_warehouse_code

Warehouse code. Maximum: 40 UTF-8 bytes.

string

shipping_origin_city

Origin city name for the shipment

string

time_zone

required

The warehouse time zone

string

ship_time_millis

required

Time when the order is shipped out of the warehouse (Unix timestamp in milliseconds)

integer format: int64

create_time_millis

required

Time when warehouse receives the order (Unix timestamp in milliseconds)

integer format: int64

handover_time_millis

required

Time when the order is handed over to the shipping provider (Unix timestamp in milliseconds)

integer format: int64

shipping_provider_id

required

Shipping service provider ID

string

shipping_provider_name

required

Shipping service provider name

string

tracking_number

required

Tracking number

string

dimension

required

Package dimension information

object

length

Package length. Must be greater than or equal to 0.

integer format: int64

width

Package width. Must be greater than or equal to 0.

integer format: int64

height

Package height. Must be greater than or equal to 0.

integer format: int64

unit

Package dimension unit Possible values:

• METER
• CENTIMETER
• MILLIMETER
• MICRON
• FOOT
• INCH

string

Allowed values: METER CENTIMETER MILLIMETER MICRON FOOT INCH

weight

Package weight information

object

value

Package weight. Must be greater than or equal to 0.

integer format: int64

unit

Package weight unit Possible values:

• KILOGRAM
• GRAM
• MILLIGRAM
• POUND
• OUNCE

string

Allowed values: KILOGRAM GRAM MILLIGRAM POUND OUNCE

skus

required

List of order SKUs in the package. Provide at least one SKU.

Array<object>

object

id

required

The TikTok Shop SKU ID. The value must represent a positive base-10 integer.

string

quantity

required

Quantity of this SKU in the package. Must be greater than 0.

integer format: int64

provider_warehouse_name

Warehouse name

string

tcw_warehouse_type

TikTok warehouse type Possible values:

• STANDARD: Standard warehouse that has not been specifically certified by TikTok
• TIKTOK_CERTIFIED_WAREHOUSE_FULFILLMENT: TikTok certified warehouse usually offering better service levels. Certified warehouses are required to meet fulfillment timeline standards set by TikTok

string

Allowed values: STANDARD TIKTOK_CERTIFIED_WAREHOUSE_FULFILLMENT

Example

{
  "warehouse_provider_id": "7342984797904049750",
  "packages": [
    {
      "id": "28427944530283",
      "wms_order_id": "324246554745",
      "provider_warehouse_code": "7475973290484254255",
      "shipping_origin_city": "CityA",
      "time_zone": "UTC+8",
      "ship_time_millis": 1694176625765,
      "create_time_millis": 1694176625765,
      "handover_time_millis": 1694176625765,
      "shipping_provider_id": "2435653524354624",
      "shipping_provider_name": "ProviderA",
      "tracking_number": "WB53452356",
      "dimension": {
        "length": 34,
        "width": 425,
        "height": 42,
        "unit": "METER"
      },
      "weight": {
        "value": 342,
        "unit": "KILOGRAM"
      },
      "skus": [
        {
          "id": "4235346547",
          "quantity": 13
        }
      ],
      "provider_warehouse_name": "Central Warehouse",
      "tcw_warehouse_type": "STANDARD"
    }
  ]
}

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

success_packages

List of packages that have been successfully confirmed

Array<string>

errors

List of packages that were not confirmed, with failure information for each package. This field is omitted when every package is confirmed.

Array<object>

object

code

Error code

string

message

Error message

string

detail

Failed package details

object

package_id

Package ID.

string

Example

{
  "code": 0,
  "data": {
    "success_packages": [
      "5345241234",
      "42365346"
    ],
    "errors": [
      {
        "code": "39003015",
        "message": "Provider is not supported by TikTok Shop",
        "detail": {
          "package_id": "4645645645"
        }
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}