Skip to content

Get Order Detail

GET
/order/202507/orders

Get the detailed order information of an order, including important attributes such as order status, shipping addresses, payment details, price and tax info, and package information.

shop_cipher
required
string

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

ids
required
Array<string>
<= 50 items

A list of TikTok Shop order ID values. Max count: 50

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
orders

Order information.

Array<object>
object
id

A unique identifier for a TikTok Shop order.

string
cancellation_initiator

The initiator of a cancellation request. Possible values:

  • SELLER
  • BUYER
  • SYSTEM
string
Allowed values: SELLER BUYER SYSTEM
shipping_provider

The name of the current shipping provider.

string
shipping_provider_id

The ID of the current shipping provider.

string
user_id

The buyer’s user ID.

string
status

The order status. Possible values:

  • UNPAID: The order is placed, but payment is not yet completed.
  • ON_HOLD: The order is accepted and is waiting for fulfillment so the buyer may still cancel without the seller’s approval. If order_type=PRE_ORDER, it also means the product is still awaiting release so payment will only be authorized 1 day before the release, but the seller should start preparing for the release.
  • AWAITING_SHIPMENT: The order is ready for shipment, but no items are shipped yet.
  • PARTIALLY_SHIPPING: Some items in the order are shipped, but not all.
  • AWAITING_COLLECTION: The shipment is arranged, but the package is waiting to be collected by the carrier.
  • IN_TRANSIT: The package is collected by the carrier and delivery is in progress.
  • DELIVERED: The package is delivered to buyer.
  • COMPLETED: The order is completed, and no further returns or refunds are allowed.
  • CANCELLED: The order is cancelled.
string
Allowed values: UNPAID ON_HOLD AWAITING_SHIPMENT PARTIALLY_SHIPPING AWAITING_COLLECTION IN_TRANSIT DELIVERED COMPLETED CANCELLED
rts_time

The time seller shipped the order (call Ship Order endpoint successfully). Unix timestamp.

integer format: int64
payment

Payment info about a TikTok Shop order.

object
currency

Currency for payment.

string
sub_total

Buyer paid subtotal of all the SKUs in the order. For the US market, this is pre-tax total amount. sub_total = original_total_product_price - seller_discount - platform_discount

string
shipping_fee

Buyer paid shipping fee. shipping_fee = original_shipping_fee - shipping_fee_seller_discount - shipping_fee_platform_discount For the US market, this is pre-tax total amount.

string
seller_discount

Product discount by seller.

string
platform_discount

Product discount by platform.

string
payment_platform_discount

Discount applied to the order funded by a payment platform

string
payment_discount_service_fee

Service fee as paid by the buyer to apply payment platform discount

string
total_amount

Buyer paid total amount. total_amount = sub_total + shipping_fee + taxes + retail_delivery_fee

string
original_total_product_price

Total original price of products (VAT included for crossborder shop). For the US market, this is pre-tax total amount.

string
original_shipping_fee

Shipping fee before discount

string
shipping_fee_seller_discount

Shipping fee discount provided by seller for an order that will not qualify for co-funded reimbursement. Note: If an order meets the minimum order value for co-funded reimbursement, this will be 0. In this case, refer to shipping_fee_cofunded_discount for the shipping discount the buyer received.

string
shipping_fee_platform_discount

Shipping fee discount by platform.

string
shipping_fee_cofunded_discount

Shipping fee discount provided by seller, eligible for co-funded reimbursement upon order delivery, based on Co-Funded Free Shipping program terms. Note: This will be 0 for orders that did not meet minimum order value for co-funded reimbursement. In this case, refer to shipping_fee_seller_discount for the shipping discount the buyer received.

string
tax

Buyer paid total taxes of the order. Applicable to crossborder shops and the US market.

string
small_order_fee

Small order fee for TH. Small order fee is for Thailand only. small order fee means that the platform will set a minimum order spending amount, when the order amount is lower than the minimum order spending amount, the user needs to pay small order fee to meet the platform minimum spending amount. e.g. Minimum order spending amount is 100, order amount is 80. So the small order fee will be 20.

string
shipping_fee_tax

The tax on the shipping price.

string
product_tax

The tax on the total item price.

string
retail_delivery_fee

RDF (retail delivery fee). Available only in the US market.

string
buyer_service_fee

A service fee is charged on every transaction made. The charge is applied from the fifth order onwards and collected directly from customers during checkout. Only available in Indonesia market.

string
handling_fee

A fee charged to buyers to cover the additional processing, handling, and/or installment costs associated with the chosen payment method.

string
shipping_insurance_fee

The cost incurred by the buyers for coverage against loss or damage to goods during transit. Note: Available only in the Indonesia market.

string
item_insurance_fee

The cost incurred by the buyers for coverage against defects or damage to the product after purchase. Note: Only available in the US and Indonesia markets.

string
item_insurance_tax

The tax paid on the insurance purchased by buyers.

Note: Only applicable in US market.

string
distance_shipping_fee

Distance shipping fee is fee that charged charged by our logistics partner and covers the separate distance-based cost for deliveries outside Java island as a part of Horizon+ Program. Only applicable in ID Market.

string
distance_fee

Total distance fee for Horizon+ Program. Only applicable for ID market

string
recipient_address

recipient_address is not available under UNPAID and ON_HOLD status.

object
full_address

The complete recipient addresses information.

string
phone_number

The telephone number of the buyer. Please notice, if this order uses platform logistics, phone number will be desensitized.

string
name

The name of the recipient. Please note, if this order uses platform logistics, recipient name will be desensitized

string
first_name

The first name of the recipient. If the buyer does not provide their first and last name separately, this parameter will have the same value as the “name” parameter.

string
last_name

The last name of the recipient. If the buyer does not provide their first and last name separately, this parameter will be empty.

string
first_name_local_script

Recipient first name in katakana. Note: Applicable only for the JP market.

string
last_name_local_script

Recipient last name in katakana. Note: Applicable only for the JP market.

string
region_code

Region code.

string
postal_code

The postal code that can be used by seller for shipping (in the U.S, this is the ZIP code).

string
post_town

Post town of the address Note: Available only in UK market

string
address_line1

The first line of the street address.

string
address_line2

The second line of the street address

string
address_line3

The third line of the street address.

string
address_line4

The fourth line of the street address.

string
district_info

District information list.

Array<object>
object
address_level_name

The name of administrative division that can be used by seller for ship. e.g. state/county/city/district/town etc.

string
address_name

Administrative area name. eg: London

string
address_level

Administrative district level code. Value can be L0/L1/L2/L3/L4. eg. US is L0

string
iso_code

ISO code of the administrative district level

string
delivery_preferences

Contains all of the delivery instructions provided by the buyer for the shipping address. Currently, only available in the US market.

object
drop_off_location

Drop-off location selected by the buyer.

string
address_detail

Full buyer detail address.

string
buyer_message

The note from buyer.

string
create_time

The date and time that the order was created. Unix timestamp.

integer format: int64
tracking_number

Tracking number. Available after ship package.

string
cancel_reason

The order level cancellation reason. Note: A multi-line order may have different cancel_reason across the multiple items. If this occurs, the order-level cancel_reason will surface the cancel_reason from the first line item. See here for more details on cancellation reasons.

string
rts_sla_time

The latest shipping time specified by the platform. Unix timestamp.

integer format: int64
paid_time

The date and time that the order was paid. Unix timestamp.

integer format: int64
fulfillment_type

Fulfillment type. Only orders with fulfillment type can be shipped by sellers. Possible values:

  • FULFILLMENT_BY_SELLER: a method where sellers fulfill orders directly from their own inventory, without using TikTok’s fulfillment centers. In this model, the seller is responsible for storing, packaging, and shipping the product to customers.
  • FULFILLMENT_BY_TIKTOK: a service offered by TikTok that enables sellers to send their products to TikTok’s fulfillment centers. TikTok then takes care of storing, picking, packing, and shipping the products to customers.
  • FULFILLMENT_BY_DILAYANI_TOKOPEDIA: a method where Tokopedia GoTo Logistics provides warehousing and logistics services to sellers and charges a fee for the service.
string
Allowed values: FULFILLMENT_BY_SELLER FULFILLMENT_BY_TIKTOK FULFILLMENT_BY_DILAYANI_TOKOPEDIA
seller_note

This field return the note, which seller notes in TikTok Seller Center.

string
tts_sla_time

The latest collection time specified by the platform. Unix timestamp.

integer format: int64
cancel_order_sla_time

The automatic cancellation time for orders specified by the platform. Unix timestamp.

integer format: int64
update_time

Time of order status changes. Unix timestamp.

integer format: int64
packages

List of packages included in this order

Array<object>
object
id

Package ID

string
delivery_type

Indicates whether it is a PickUp DropOff (PUDO) location. The PUDO location is selected by the buyer when placing orders.

  • HOME_DELIVERY: not a PUDO location
  • COLLECTION_POINT: a PUDO location
string
is_sample_order

Use this field to determine whether the order is a sample order.

boolean
warehouse_id

Seller warehouse ID.

string
split_or_combine_tag

Indicate whether the order is combined or split.

  • COMBINED
  • SPLIT This field will be used in future fulfillment apis.
string
has_updated_recipient_address

Whether the recipient address has been updated.

  • false: no update
  • true: updated
boolean
cpf

CPF (invoice number), used to issue an invoice. Exclusive for the Brazil market.

string
delivery_option_id

Order delivery option ID.

string
delivery_sla_time

Order should arrive by this date to be considered on-time and to avoid late delivery penalties.

integer format: int64
payment_method_name

Payment method name, only for display

string
payment_card_type

Code to distinguish different payment method. Only assigned when the payment method is using bank card. Possible values are: Debit, Credit, Prepaid

string
Allowed values: Debit Credit Prepaid
channel_entity_national_registry_id

The national channel entity registration ID of payment institution/creditor. In Brazil, it is the CNPJ of payment instituion.

string
payment_method_code

Payment method code identifying current transaction. It will contains payment method and card brand if it is card transaction.

string
payment_auth_code

Authorization code of current transaction (only for the Brazilian market). For card transactions (credit/debit card), this field will be transaction authorization code. For PIX transactions, this field will be E2E ID.

string
shipping_due_time

If the order hasn’t updated its status to AWAITING_COLLECTION before this time, the order will be automatically canceled by TikTok Shop.

integer format: int64
line_items

Line item info list.

Array<object>
object
id

Line item ID.

string
sku_id

SKU ID.

string
combined_listing_skus

For a virtual bundle SKU, returns an array of related product SKUs that compose the virtual bundle SKU.

Array<object>
object
sku_id

The original sku_id related to the virtual bundle SKU.

string
sku_count

The quantity of original SKU that compose the virtual bundle SKU.

integer format: int64
product_id

The original product_id related to the virtual bundle SKU.

string
seller_sku

The original seller_sku (which is defined by sellers) related to the virtual bundle SKU.

string
product_id

Product ID.

string
product_name

Product name.

string
sku_name

The name of the SKU, combined by product SKU attribute like size or color. For example, “Black, 26.”

string
sku_image

SKU image.

string
original_price

Item original price, please refer to the currency of payment_info.

string
sale_price

Item sale price, please refer to the currency of payment_info.

string
pfand_fee

Deposit fee that is applied to certain products, typically beverage containers such as bottles or cans. Note Only available in Germany market

string
platform_discount

Platform discount amount, please refer to the currency of payment_info.

string
display_status
  • UNPAID: The order is placed, but payment is not yet completed.
  • AWAITING_SHIPMENT: The order is ready for shipment, but no items are shipped yet.
  • AWAITING_COLLECTION: The shipment is arranged, but the package is waiting to be collected by the carrier.
  • IN_TRANSIT: The package is collected by the carrier and delivery is in progress.
  • DELIVERED: The package is delivered to buyer.
  • COMPLETED: The order is completed, and no further returns or refunds are allowed.
  • CANCELLED: The order is canceled.
string
cancel_user

The initiator of a cancellation request:

  • BUYER
  • SELLER
  • OPERATOR
  • SYSTEM
string
sku_type

[Deprecated: This field is deprecated and will be removed in a future API version. Use order_type instead.] The order line type: Possible values based on region: All regions

  • NORMAL: An item that is in stock and available for immediate purchase and fulfillment.
  • ZERO_LOTTERY: An item purchased during a lottery event in TikTok LIVE.
  • SHOP_PARTNER: An item purchased from a TikTok Shop partner store. US
  • PRE_ORDER: An item that is not yet available or released. Fulfillment starts on a specific date in the future.
  • MADE_TO_ORDER: An item that is produced only after the order is received. Fulfillment starts after the product is produced.
string
Allowed values: NORMAL ZERO_LOTTERY SHOP_PARTNER PRE_ORDER MADE_TO_ORDER
seller_sku

The seller stock keeping unit (SKU) of the item.

string
shipping_provider_id

The shipping provider ID of the item.

string
seller_discount

Seller discount amount. Please refer to the currency of payment_info.

string
currency

Currency for payment.

string
package_id

An order can contain one or more packages based on how the seller chooses to ship. Each package has a unique package_id (and also a tracking_id, which is used to track the progress of the package as it is shipped). For local sellers in the US and UK markets, the package_id and package_status property will not be returned before the package is shipped

string
rts_time

The time seller shipped line order (call Ship Order endpoint successfully). Unix timestamp.

integer format: int64
item_tax

Item tax detail.

Array<object>
object
tax_type

Tax type.

  • SALES_TAX (US market sales tax) Currently only sales tax is available.
string
tax_amount

Tax amount.

string
tax_rate

Tax rate.

string
package_status

The package status of the item:

  • TO_FULFILL: package waiting seller to arrange shipment.
  • PROCESSING: package shipment has been arranged by seller. Waiting carrier to collect the parcel.
  • FULFILLING: package has been collected by carrier and in transit.
  • COMPLETED: package has been delivered.
  • CANCELLED: package has been canceled. Normally, the package is canceled due to the package being lost or damaged.
string
shipping_provider_name

The shipping provider name of the item.

string
is_gift

Indicates whether the current order line is a gift.

boolean
cancel_reason

Item cancellation reason.

string
small_order_fee

Small order fee for TH.

string
retail_delivery_fee

RDF (retail delivery fee). Available only in the US market.

string
tracking_number

Tracking number. Available after package has been shipped.

string
buyer_service_fee

A service fee is charged on every transaction made. The charge is applied from the fifth order onwards and collected directly from customers during checkout. Only available in Indonesia market.

string
handling_duration_days

[Deprecated: This field is deprecated and will be removed in a future API version. Use handling_duration instead.] The number of business days required for the seller to process the order and hand it over to a shipping carrier after the order is placed. Applicable only if the value for sku_type is MADE_TO_ORDER.

string
is_dangerous_good

Whether the SKU is a hazmat item. When creating the label for a hazmat item, you must follow the platform rules to put certain items into one package. Please refer to the relationship between sku_id and package_id to determine how to follow platform rules.

boolean
needs_prescription

A flag to indicate whether the included product requires a prescription.

boolean
gift_retail_price

Retail price of the free item in orders Live giveaway, free sample and gift with purchase. For other orders, this field always returns 0. This amount can be used for free samples and live giveaway order invoice in Brazil

string
is_unboxing_item

If true, indicates the sku is a blind box item that will need be unboxed to reveal the actual product to the buyer. The actual product sku name and picture can also be updated to TikTok after the unboxing is completed.

Note: This is currently only available in the US market.

boolean
unboxing_sku_code

A seller’s third party sku code for the actual unboxed item, which warehouse fulfillment operations can reference to identify the accurate product they are shipping.

Note: This is currently only available in the US market.

string
unboxing_case_list

A seller’s third party sku code for the case unboxed item, which warehouse fulfillment operations can reference to identify the accurate product they are shipping.

Note: This is currently only available in the US market.

Array<object>
object
unbox_sku

Unboxed sku code associated with the actual unboxed item.

string
unbox_sku_type

Indicates if the unboxed sku is a gift item Enumerations: NORMAL or GIFT

string
Allowed values: NORMAL GIFT
sub_item_info

Sub items represent skus that belong to a “virtual bundle” that has been defined by a seller. The sub_item_info will include all relevant information about each item that is required to be fulfilled as part of the virtual bundle. Note: Each quantity of any sku has a unique sub_item_info “id”, which allows the seller to perform line-level fulfillments, in the event the items are split across different warehouse locations.

Array<object>
object
id

Line item id of the sub_item. This unique identifier can be used when performing split/line-level fulfillment events.

string
sku_id

SKU ID.

string
display_status

Available values:

  • UNPAID: The order has been placed, but payment has not yet completed.
  • AWAITING_SHIPMENT: The order is ready for shipment, but no items have been shipped yet.
  • AWAITING_COLLECTION: Shipping has been arranged, but the package is waiting to be collected by the carrier.
  • IN_TRANSIT: The package has been collected by the carrier and delivery is in progress.
  • DELIVERED: The package has been delivered to the buyer.
  • COMPLETED: The order has been completed, and no further returns or refunds are allowed.
  • CANCELLED: The order has been cancelled.
string
Allowed values: UNPAID AWAITING_SHIPMENT AWAITING_COLLECTION IN_TRANSIT DELIVERED COMPLETED CANCELLED
product_name

Product name.

string
seller_sku

The seller stock keeping unit (SKU) of the item.

string
sku_image

SKU image.

string
sku_name

The name of the SKU, combined by product SKU attribute like size or color. e.g. “Black, 26”

string
product_id

Product ID.

string
sale_price

Item sale price. Please refer to the currency of payment_info.

string
platform_discount

Platform discount amount. Please refer to the currency of payment_info.

string
seller_discount

Seller discount amount. Please refer to the currency of payment_info.

string
cancel_reason

The cancellation reason. Please visit our list of cancel reasons for more information.

string
original_price

Item original price. Please refer to the currency of payment_info.

string
rts_time

The time sellers shipped the order (called Ship Package API successfully). Unix timestamp.

integer format: int64
package_status

The package status of the item. Available values:

  • TO_FULFILL: Package awaiting seller to arrange shipment.
  • PROCESSING: Shipping has been arranged by the seller. Awaiting carrier collection.
  • FULFILLING: Package has been collected by carrier and is in transit.
  • COMPLETED: Package has been delivered.
  • CANCELLED: Package has been canceled. Normally, the package is canceled due to the package being lost or damaged.
string
Allowed values: TO_FULFILL PROCESSING FULFILLING COMPLETED CANCELLED
currency

Currency for payment.

string
shipping_provider_name

The shipping provider name.

string
cancel_user

Cancellation request initiator. Available values:

  • BUYER
  • SELLER
  • OPERATOR
  • SYSTEM
string
Allowed values: BUYER SELLER OPERATOR SYSTEM
shipping_provider_id

The shipping provider ID of the item.

string
item_tax

Item tax detail.

Array<object>
object
tax_type

Tax type. Available values:

  • SALES_TAX (US market sales tax)

Note: Currently only sales tax is available.

string
Allowed values: SALES_TAX
tax_amount

Tax amount.

string
tax_rate

Tax rate.

string
tracking_number

Tracking number. Available after package has been shipped.

string
package_id

An order can contain one or more packages based on how the seller chooses to ship. Each package has a unique package_id and tracking_id.

string
retail_delivery_fee

Retail delivery fee (RDF). Note: Only available in the US market.

string
is_dangerous_good

Whether the SKU is a hazmat item. When creating the label for a hazmat item, you must follow the platform rules to put certain items into one package. Please refer to the relationship between sku_id and package_id to determine how to follow platform rules.

boolean
warehouse_id

Seller warehouse ID.

string
distance_shipping_fee

Distance shipping fee is fee that charged charged by our logistics partner and covers the separate distance-based cost for deliveries outside Java island as a part of Horizon+ Program. Only applicable in ID Market.

string
distance_fee

Total distance fee for Horizon+ Program. Only applicable for ID market

string
shipping_vat_amount

Shipping vat amount Available in EU market

string
shipping_vat_rate

Shipping vat rate Available in EU market

string
is_pod_customized

Identifies if this SKU contains print on demand customization

boolean
pod_info_id

ID of the print on demand customization details. This ID can be used to query for the exact details of the customization

string
room_id

The unique ID of the LIVE session where the order line item was created. If the order line item was not created from a LIVE session, this field returns an empty string.

string
product_listing_type

This describes the product listing type of the SKU. Possible values:

  • TEMPORARY_LISTING
string
Allowed values: TEMPORARY_LISTING
shipping_type

The method of delivery.

  • TIKTOK: shipping service provided by TikTok. The seller should obtain shipping label from TikTok.
  • SELLER: seller provides shipping, including through 3rd party fulfillment providers on behalf of the seller.
  • TIKTOK_DIGITAL: Tiktok delivers virtual goods directly to buyers. There is no action needed.
string
buyer_email

The anonymized email address of the buyer. It is not recommended to send messages directly to this email address. If you need to contact the buyer, please go to Seller Center - Buyer Messages page.

string
delivery_time

The timestamp of the order’s status update to DELIVERED.

integer format: int64
need_upload_invoice

Whether an invoice needs to be uploaded and uploaded status (only for Brazil market).

  • UNKNOWN: Currently unable to confirm whether an invoice is needed
  • NEED_INVOICE: This order requires an invoice and the invoice has not been uploaded yet
  • NO_NEED:This order does not require an invoice
  • INVOICE_UPLOADED: The invoice for this order has been uploaded and verified. If the order is split, it will be marked as “uploaded” once any sub-order’s invoice is uploaded.
  • INVOICE_PROCESSING: The invoice for this order is currently being uploaded/cancelled. Please wait for the final result and do not repeat the operation
string
is_cod

This option is for sellers that accept cash payment on delivery which is rare. Buyers will pay in cash upon receipt of package. Default value is FALSE. Only applicable to countries where Cash on Delivery (COD) is supported.

boolean
request_cancel_time

Buyer request cancel time.

integer format: int64
delivery_option_required_delivery_time

Order should be delivered before this time.

integer format: int64
delivery_option_name

Delivery option name. For display purposes only.

string
is_buyer_request_cancel

True when the buyer has a pending cancellation request

boolean
delivery_due_time

If the order hasn’t updated its status to DELIVERED before this time, the order will be automatically canceled by TikTok Shop.

integer format: int64
collection_time

The timestamp of the order’s status update to IN_TRANSIT.

integer format: int64
is_on_hold_order

Indicates whether the order experienced or will be experienced ON_HOLD status.

boolean
cancel_time

The timestamp of the order’s status update to CANCELLED.

integer format: int64
is_replacement_order

When true, this is a replacement order.

boolean
replaced_order_id

The order ID for the order that is being replaced. Returned only if is_replacement_order = true

string
collection_due_time

If the order hasn’t updated its status to IN_TRANSIT before this time, the order will be automatically canceled by TikTok Shop

integer format: int64
pick_up_cut_off_time

To avoid LDR, you must ensure the package is picked up by this time. Only applicable in Southeast Asia regions.

integer format: int64
fast_dispatch_sla_time

The latest collection time to gain incentives of NDD (Next Day Delivery) project. Unix timestamp Only available in Thailand and Philippines.

integer format: int64
commerce_platform

The platform where the order was placed. Possible values:

  • TIKTOK_SHOP
  • TOKOPEDIA Note: Available only in the Indonesia market.
string
Allowed values: TIKTOK_SHOP TOKOPEDIA
order_type

The order type. Possible values based on region: All regions

  • NORMAL: An item that is in stock and available for immediate purchase and fulfillment.
  • ZERO_LOTTERY: An order placed during a lottery event in TikTok LIVE.
  • AUCTION: An order placed during auction, where the price of the product is not fixed. US
  • PRE_ORDER: An advance order for items that are not yet available or released. Fulfillment starts on a specific date in the future.
  • MADE_TO_ORDER: An order for items that are produced only after the order is received. Fulfillment starts after the product is produced.
  • BACK_ORDER: An order for items that are out of stock but expected to be restocked. Fulfillment starts after the product is restocked.
  • VIRTUAL_ORDER: An order for items that are digital goods, requiring no physical delivery. Fulfillment is immediate or automated upon payment confirmation. Returns an empty value for standard orders or other types that don’t fall into the above categories.
string
Allowed values: NORMAL ZERO_LOTTERY AUCTION PRE_ORDER MADE_TO_ORDER BACK_ORDER VIRTUAL_ORDER
release_date

The date on which order handling starts and the status of the order changes to AWAITING_SHIPMENT. Applicable only if the order_type is PRE_ORDER.

integer format: int64
handling_duration

The duration for the seller to process the order and hand it over to a shipping carrier after the order is placed. Applicable only if the order_type is MADE_TO_ORDER or BACK_ORDER.

object
days

The number of days.

string
type

Indicates if the duration is calculated in calendar days or business days. Possible values:

  • CALENDAR_DAY: Represents consecutive days, including weekends and holidays.
  • BUSINESS_DAY: Represents business days, excluding weekends and public holidays. Default: BUSINESS_DAY
string
Allowed values: CALENDAR_DAY BUSINESS_DAY
auto_combine_group_id

An identifier assigned to orders from the same customer during a LIVE session to facilitate combined order shipping when “auto-combination” is activated in Seller Center.

string
cpf_name

Name belonging to the CPF number for the Brazil market.

string
is_exchange_order

When TRUE, this is an exchange order. Note: Only available in US and UK.

boolean
exchange_source_order_id

If the order is an exchange order, this field returns the original order’s order ID, from which the exchange order was generated. Returned only if is_exchange_order = true. Note: Only available in US and UK.

string
is_subscription_order

Subscription orders are recurring orders set up by customers. If TRUE, this order is generated from a subscription order

boolean
is_refundable_sample

This indicates if an order is a refundable sample. Refundable samples lets sellers collaborate with creators by refunding product costs only when creators meet sales thresholds.

boolean
authentication_required

If true, order requires authentication. Use an approved in-house authentication service after an order has been placed for verification. This must be completed before shipment.

boolean
consultation_id

An ID to identify the corresponding ePharmacy consultation. Applicable only if an ePharmacy consultation was initiated. Not applicable if the prescription was provided by the customer through an image upload.

string
fast_delivery_program

A badge presented on the merchandise to tell the buyer that the seller participates in the fast delivery program, such that the order should arrive in a promised time period. Possible values:

  • 3_DAY_DELIVERY
  • 3_DAY_POTENTIAL_SHIPPING
  • 3_DAY_POTENTIAL_TRANSIT Not returned if order did not meet fast delivery program requirements. Note: Applicable only for the US market.
string
Allowed values: 3_DAY_DELIVERY 3_DAY_POTENTIAL_SHIPPING 3_DAY_POTENTIAL_TRANSIT
buyer_nickname

The nickname of the TikTok buyer, which is defined by the TikTok user. The buyer_nickname can be used to identify the buyer when displaying the unboxing results within the TikTok Live Session.

string
buyer_avatar

The avatar of the TikTok buyer, which is defined by the TikTok user. The buyer_avatar can be used in conjunction with the buyer_nickname when displaying the unboxing results within the TikTok Live Session.

string
order_rights

Order tag identifier if has certain rights within the order based on the program subscribed by sellers. 1 = Shipping Fee Reimbursement Program 2 = Horizon+ Program Applicable for SEA market only

Array<integer>
fulfillment_priority_level

Fulfillment priority value that can be used to prioritize shipping (only available in SEA) 100 = Instant 200 = Sameday 8 Hours 300 = Sameday 400 = Next Day Delivery 500 = Express 600 = Standard 700 = Economy 800 = Cargo

integer format: int64
recommended_shipping_time

Recommended time to ship based on the each LSP service type (only available in SEA)

integer format: int64
instore_pickup_sla_time

The latest buyer pickup time for instore pickup method specified by the platform. Currently applicable for SEA market. Unix timestamp.

integer format: int64
fast_rts_sla_time

Indicate fast fulfillment SLA for shipping action. Applicable for SEA market only. Unix timestamp

integer format: int64
fast_collection_sla_time

Indicate fast fulfillment SLA for collection action. Applicable for SEA market only. Unix timestamp

integer format: int64
Example
{
"code": 0,
"data": {
"orders": [
{
"id": "576461413038785752",
"cancellation_initiator": "SELLER",
"shipping_provider": "TT Virtual express",
"shipping_provider_id": "6617675021119438849",
"user_id": "7021436810468230477",
"status": "UNPAID",
"rts_time": 1619611563,
"payment": {
"currency": "IDR",
"sub_total": "5000",
"shipping_fee": "5000",
"seller_discount": "5000",
"platform_discount": "5000",
"payment_platform_discount": "10",
"payment_discount_service_fee": "10",
"total_amount": "5000",
"original_total_product_price": "5000",
"original_shipping_fee": "5000",
"shipping_fee_seller_discount": "5000",
"shipping_fee_platform_discount": "5000",
"shipping_fee_cofunded_discount": "7",
"tax": "5000",
"small_order_fee": "3000",
"shipping_fee_tax": "11",
"product_tax": "21.3",
"retail_delivery_fee": "1.28",
"buyer_service_fee": "1000",
"handling_fee": "1000",
"shipping_insurance_fee": "1000",
"item_insurance_fee": "1000",
"item_insurance_tax": "10",
"distance_shipping_fee": "1000",
"distance_fee": "2000"
},
"recipient_address": {
"full_address": "1199 Coleman Ave San Jose, CA 95110",
"phone_number": "(+1)213-***-1234",
"name": "David Kong",
"first_name": "David",
"last_name": "Kong",
"first_name_local_script": "ジョン",
"last_name_local_script": "ドゥ",
"region_code": "US",
"postal_code": "95110",
"post_town": "Ribbleton",
"address_line1": "TikTok 5800 bristol Pkwy",
"address_line2": "Suite 100",
"address_line3": "Vila Olímpia",
"address_line4": "Avenida Presidente Juscelino Kubitschek",
"district_info": [
{
"address_level_name": "Country",
"address_name": "United Kingdom",
"address_level": "L0",
"iso_code": "VAN"
}
],
"delivery_preferences": {
"drop_off_location": "Front Door"
},
"address_detail": "Unit one building 8"
},
"buyer_message": "Please ship asap!",
"create_time": 1619611561,
"tracking_number": "JX12345",
"cancel_reason": "Pricing error",
"rts_sla_time": 1619611688,
"paid_time": 1619611563,
"fulfillment_type": "FULFILLMENT_BY_SELLER",
"seller_note": "seller note",
"tts_sla_time": 1619611761,
"cancel_order_sla_time": 1619621355,
"update_time": 1619621355,
"packages": [
{
"id": "1152321127278713123"
}
],
"delivery_type": "HOME_DELIVERY",
"is_sample_order": false,
"warehouse_id": "6955005333819123123",
"split_or_combine_tag": "COMBINED",
"has_updated_recipient_address": false,
"cpf": "3213-31231412",
"delivery_option_id": "7091146663229654785",
"delivery_sla_time": 1678389618,
"payment_method_name": "CCDC",
"payment_card_type": "Debit",
"channel_entity_national_registry_id": "26.545.167/0001-21",
"payment_method_code": "pm_pi_ccdc_visa_c_d",
"payment_auth_code": "AUTH123457",
"shipping_due_time": 1678389618,
"line_items": [
{
"id": "577086512123755123",
"sku_id": "2729382476852921560",
"combined_listing_skus": [
{
"sku_id": "2729382476852921123",
"sku_count": 1,
"product_id": "1729582718312380456",
"seller_sku": "yellow-24-XL"
}
],
"product_id": "1729582718312380123",
"product_name": "Women's Winter Crochet Clothes",
"sku_name": "Iphone",
"sku_image": "https://p16-oec-va.itexeitg.com/tos-maliva-d-o5syd03w52-us/46123e87d14f40b69b839",
"original_price": "0.01",
"sale_price": "0.01",
"pfand_fee": "1.5",
"platform_discount": "0",
"display_status": "TO_SHIP",
"cancel_user": "BUYER",
"sku_type": "PRE_ORDER",
"seller_sku": "red_iphone_256",
"shipping_provider_id": "6617675021119438849",
"seller_discount": "0",
"currency": "IDR",
"package_id": "1153132168123859123",
"rts_time": 1678389618,
"item_tax": [
{
"tax_type": "SALES_TAX",
"tax_amount": "21.2",
"tax_rate": "0.35"
}
],
"package_status": "TO_FULFILL",
"shipping_provider_name": "TT Virtual express",
"is_gift": false,
"cancel_reason": "Discount not as expected",
"small_order_fee": "5000",
"retail_delivery_fee": "1.28",
"tracking_number": "JX12345",
"buyer_service_fee": "1000",
"handling_duration_days": "7",
"is_dangerous_good": true,
"needs_prescription": true,
"gift_retail_price": "20",
"is_unboxing_item": false,
"unboxing_sku_code": "14531134",
"unboxing_case_list": [
{
"unbox_sku": "14531134",
"unbox_sku_type": "GIFT"
}
],
"sub_item_info": [
{
"id": "577086512123755123",
"sku_id": "2729382476852921560",
"display_status": "UNPAID",
"product_name": "Women's Winter Crochet Clothes",
"seller_sku": "red_iphone_256",
"sku_image": "https://p16-oec-va.itexeitg.com/tos-maliva-d-o5syd03w52-us/46123e87d14f40b69b839",
"sku_name": "Iphone",
"product_id": "1729582718312380123",
"sale_price": "0.01",
"platform_discount": "0",
"seller_discount": "0",
"cancel_reason": "Discount not as expected",
"original_price": "0.01",
"rts_time": 1678389618,
"package_status": "TO_FULFILL",
"currency": "USD",
"shipping_provider_name": "TT Virtual express",
"cancel_user": "BUYER",
"shipping_provider_id": "6617675021119438849",
"item_tax": [
{
"tax_type": "SALES_TAX",
"tax_amount": "21.2",
"tax_rate": "0.35"
}
],
"tracking_number": "JX12345",
"package_id": "1153132168123859123",
"retail_delivery_fee": "1.28",
"is_dangerous_good": false,
"warehouse_id": "6955005333819123123"
}
],
"distance_shipping_fee": "1000",
"distance_fee": "2000",
"shipping_vat_amount": "3.5",
"shipping_vat_rate": "0.25",
"is_pod_customized": false,
"pod_info_id": "789123812334",
"room_id": "7652884452049160991",
"product_listing_type": "TEMPORARY_LISTING"
}
],
"shipping_type": "TIKTOK",
"buyer_email": "v2b2V5@chat.seller.tiktok.com",
"delivery_time": 1678389618,
"need_upload_invoice": "NEED_INVOICE",
"is_cod": false,
"request_cancel_time": 1678389618,
"delivery_option_required_delivery_time": 1678389618,
"delivery_option_name": "Express shipping",
"is_buyer_request_cancel": false,
"delivery_due_time": 1678389618,
"collection_time": 1678389618,
"is_on_hold_order": false,
"cancel_time": 1678389618,
"is_replacement_order": false,
"replaced_order_id": "576461416728782174",
"collection_due_time": 1678389618,
"pick_up_cut_off_time": 1678389618,
"fast_dispatch_sla_time": 1678389618,
"commerce_platform": "TIKTOK_SHOP",
"order_type": "ZERO_LOTTERY",
"release_date": 1619611762,
"handling_duration": {
"days": "7",
"type": "BUSINESS_DAY"
},
"auto_combine_group_id": "12345677",
"cpf_name": "John Smith",
"is_exchange_order": false,
"exchange_source_order_id": "576461413038785752",
"is_subscription_order": true,
"is_refundable_sample": false,
"authentication_required": false,
"consultation_id": "123241",
"fast_delivery_program": "3_DAY_DELIVERY",
"buyer_nickname": "user213123",
"buyer_avatar": "https://p16-oec-va.itexeitg.com/tos-maliva-d-o5syd03w52-us/46123e87d14f40b69b839",
"order_rights": [
1
],
"fulfillment_priority_level": 100,
"recommended_shipping_time": 1619611561,
"instore_pickup_sla_time": 1784090976,
"fast_rts_sla_time": 1784090976,
"fast_collection_sla_time": 1784090976
}
]
},
"message": "Success",
"request_id": "202203070749000101890810281E8C70B7"
}