Mark Package As Shipped

POST

/fulfillment/202610/orders/{order_id}/packages

This API is currently exclusive to the following markets: US, UK, ES, IE, IT, DE, FR, JP. This API is for sellers who fulfill orders through their own selected/preferred logistics carrier, and allows sellers to upload valid package information (items in packages, shipping provider information, and tracking number) orders/order line items to TikTok Shop. Use Get Shipping Providers API to retrieve the shipping_provider_id for shipping providers.

Authorizations

• accessToken

Parameters

Path Parameters

order_id

required

string

The unique identifier for a TikTok Shop order.

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_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

shipping_info_list

“Only supports uploading multiple tracking numbers for split-shipment in 3PL single item scenarios (non-virtual bundle) (This function is only support for whitelist sellers； If you are not on the allowlist, it is recommended to contact AM to apply) For other scenarios, only one tracking number can be uploaded at a time.”

Array<object>

object

tracking_number

Tracking number.​

string

shipping_provider_id

Use Get Shipping Provider API to retrieve the shipping_provider_id for shipping providers.​

string

note

“Only available for a part of white list merchants.This applies to scenarios where a large single item needs to be shipped in multiple packages.Merchants not on the whitelist who upload this field will have it automatically ignored by the platform. For example, where Package 1 is marked with ““headboard”” and Package 2 is marked with ““bed frame”“. This field will be displayed to buyers, so please fill it in carefully.”

string

Example

{
  "order_line_list": [
    {
      "order_line_id": "5767675021119438849",
      "sub_item_id": "5767675021119438849"
    }
  ],
  "shipping_info_list": [
    {
      "tracking_number": "6617675021119438849",
      "shipping_provider_id": "12312312321323432",
      "note": "this is a table"
    }
  ]
}

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_item_ids

List of order line item IDs.

Array<string>

package_id

Package ID.

string

warning

Warning message.

object

message

Warning information that needs attention. Review and address it when applicable. Its presence alone does not mean check_result is FAILED.

string

Example

{
  "code": 0,
  "data": {
    "order_id": "32131324123321",
    "order_line_item_ids": [
      "31322412312312"
    ],
    "package_id": "32141235124234",
    "warning": {
      "message": "match more than one provider"
    }
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}