来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /order/202507/orders
#§2 Method: [GET]
#§3 Function Description
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.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
| Get by API Get Authorization Shop | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| ids | []string | Y | 57668123555,57668123555 | A list of TikTok Shop order ID values. |
| Max count: 50 |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/order/202507/orders?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&ids=57668123555,57668123555
§7 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^orders | []object | Order information. | |
| ^^id | string | 576461413038785752 | A unique identifier for a TikTok Shop order. |
| ^^cancellation_initiator | string | SELLER | The initiator of a cancellation request. |
| Possible values: |
SELLERBUYERSYSTEM| ^^shipping_provider |string |TT Virtual express |The name of the current shipping provider. | ^^shipping_provider_id |string |6617675021119438849 |The ID of the current shipping provider. | ^^user_id |string |7021436810468230477 |The buyer's user ID. | ^^status |string |UNPAID |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. Iforder_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. | ^^rts_time |int |1619611563 |The time seller shipped the order (call Ship Order endpoint successfully). Unix timestamp. | ^^payment |object | |Payment info about a TikTok Shop order. | ^^^currency |string |IDR |Currency for payment. | ^^^sub_total |string |5000 |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| ^^^shipping_fee |string |5000 |Buyer paid shipping fee.shipping_fee=original_shipping_fee-shipping_fee_seller_discount-shipping_fee_platform_discountFor the US market, this is pre-tax total amount. | ^^^seller_discount |string |5000 |Product discount by seller. | ^^^platform_discount |string |5000 |Product discount by platform. | ^^^payment_platform_discount |string |10 |Discount applied to the order funded by a payment platform | ^^^payment_discount_service_fee |string |10 |Service fee as paid by the buyer to apply payment platform discount | ^^^total_amount |string |5000 |Buyer paid total amount.total_amount=sub_total+shipping_fee+taxes+retail_delivery_fee| ^^^original_total_product_price |string |5000 |Total original price of products (VAT included for crossborder shop). For the US market, this is pre-tax total amount. | ^^^original_shipping_fee |string |5000 |Shipping fee before discount | ^^^shipping_fee_seller_discount |string |5000 |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 toshipping_fee_cofunded_discountfor the shipping discount the buyer received. | ^^^shipping_fee_platform_discount |string |5000 |Shipping fee discount by platform. | ^^^shipping_fee_cofunded_discount |string |7 |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 toshipping_fee_seller_discountfor the shipping discount the buyer received. | ^^^tax |string |5000 |Buyer paid total taxes of the order. Applicable to crossborder shops and the US market. | ^^^small_order_fee |string |3000 |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. | ^^^shipping_fee_tax |string |11 |The tax on the shipping price. | ^^^product_tax |string |21.3 |The tax on the total item price. | ^^^retail_delivery_fee |string |1.28 |RDF (retail delivery fee). Available only in the US market. | ^^^buyer_service_fee |string |1000 |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. | ^^^handling_fee |string |1000 |A fee charged to buyers to cover the additional processing, handling, and/or installment costs associated with the chosen payment method. | ^^^shipping_insurance_fee |string |1000 |The cost incurred by the buyers for coverage against loss or damage to goods during transit. Note: Available only in the Indonesia market. | ^^^item_insurance_fee |string |1000 |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. | ^^^item_insurance_tax |string |10 |The tax paid on the insurance purchased by buyers.
Note: Only applicable in US market. |
^^^distance_shipping_fee |string |1000 |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. |
^^^distance_fee |string |2000 |Total distance fee for Horizon+ Program. Only applicable for ID market |
^^recipient_address |object | |recipient_address is not available under UNPAID and ON_HOLD status. |
^^^full_address |string |1199 Coleman Ave San Jose, CA 95110 |The complete recipient addresses information. |
^^^phone_number |string |(+1)213-***-1234 |The telephone number of the buyer. Please notice, if this order uses platform logistics, phone number will be desensitized. |
^^^name |string |David Kong |The name of the recipient. Please note, if this order uses platform logistics, recipient name will be desensitized |
^^^first_name |string |David |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. |
^^^last_name |string |Kong |The last name of the recipient. If the buyer does not provide their first and last name separately, this parameter will be empty. |
^^^first_name_local_script |string |ジョン |Recipient first name in katakana.
Note: Applicable only for the JP market. |
^^^last_name_local_script |string |ドゥ |Recipient last name in katakana.
Note: Applicable only for the JP market. |
^^^region_code |string |US |Region code. |
^^^postal_code |string |95110 |The postal code that can be used by seller for shipping (in the U.S, this is the ZIP code). |
^^^post_town |string |Ribbleton |Post town of the address
Note: Available only in UK market |
^^^address_line1 |string |TikTok 5800 bristol Pkwy |The first line of the street address. |
^^^address_line2 |string |Suite 100 |The second line of the street address |
^^^address_line3 |string |Vila Olímpia |The third line of the street address.
Applicable only for the BR market. |
^^^address_line4 |string |Avenida Presidente Juscelino Kubitschek |The fourth line of the street address.
Applicable only for the BR market. |
^^^district_info |[]object | |District information list. |
^^^^address_level_name |string |Country |The name of administrative division that can be used by seller for ship. e.g. state/county/city/district/town etc. |
^^^^address_name |string |United Kingdom |Administrative area name. eg: London |
^^^^address_level |string |L0 |Administrative district level code. Value can be L0/L1/L2/L3/L4. eg. US is L0 |
^^^^iso_code |string |VAN |ISO code of the administrative district level |
^^^delivery_preferences |object | |Contains all of the delivery instructions provided by the buyer for the shipping address. Currently, only available in the US market. |
^^^^drop_off_location |string |Front Door |Drop-off location selected by the buyer. |
^^^address_detail |string |Unit one building 8 |Full buyer detail address. |
^^buyer_message |string |Please ship asap! |The note from buyer. |
^^create_time |int |1619611561 |The date and time that the order was created. Unix timestamp. |
^^tracking_number |string |JX12345 |Tracking number. Available after ship package. |
^^cancel_reason |string |Pricing error |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. |
^^rts_sla_time |int |1619611688 |The latest shipping time specified by the platform. Unix timestamp. |
^^paid_time |int |1619611563 |The date and time that the order was paid. Unix timestamp. |
^^fulfillment_type |string |FULFILLMENT_BY_SELLER |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. | ^^seller_note |string |seller note |This field return the note, which seller notes in TikTok Seller Center. | ^^tts_sla_time |int |1619611761 |The latest collection time specified by the platform. Unix timestamp. | ^^cancel_order_sla_time |int |1619621355 |The automatic cancellation time for orders specified by the platform. Unix timestamp. | ^^update_time |int |1619621355 |Time of order status changes. Unix timestamp. | ^^packages |[]object | |List of packages included in this order | ^^^id |string |1152321127278713123 |Package ID | ^^delivery_type |string |HOME_DELIVERY |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 locationCOLLECTION_POINT: a PUDO location | ^^is_sample_order |bool |false |Use this field to determine whether the order is a sample order. | ^^warehouse_id |string |6955005333819123123 |seller warehouse ID. | ^^split_or_combine_tag |string |COMBINED |Indicate whether the order is combined or split.COMBINEDSPLITThis field will be used in future fulfillment apis. | ^^has_updated_recipient_address |bool |false |Whether the recipient address has been updated.false: no updatetrue: updated | ^^cpf |string |3213-31231412 |CPF (invoice number), used to issue an invoice. Exclusive for the Brazil market. | ^^delivery_option_id |string |7091146663229654785 |Order delivery option ID. | ^^delivery_sla_time |int |1678389618 |Order should arrive by this date to be considered on-time and to avoid late delivery penalties. | ^^payment_method_name |string |CCDC |Payment method name, only for display | ^^payment_card_type |string |Debit |Code to distinguish different payment method. Only assigned when the payment method is using bank card. Possible values are: Debit, Credit, Prepaid | ^^channel_entity_national_registry_id |string |26.545.167/0001-21 |The national channel entity registration ID of payment institution/creditor. In Brazil, it is the CNPJ of payment instituion. | ^^payment_method_code |string |pm_pi_ccdc_visa_c_d |Payment method code identifying current transaction. It will contains payment method and card brand if it is card transaction. | ^^payment_auth_code |string |AUTH123457 |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. | ^^shipping_due_time |int |1678389618 |If the order hasn't updated its status toAWAITING_COLLECTIONbefore this time, the order will be automatically canceled by TikTok Shop. | ^^line_items |[]object | |Line item info list. | ^^^id |string |577086512123755123 |Line item ID. | ^^^sku_id |string |2729382476852921560 |SKU ID. | ^^^combined_listing_skus |[]object | |For a virtual bundle SKU, returns an array of related product SKUs that compose the virtual bundle SKU. | ^^^^sku_id |string |2729382476852921123 |The originalsku_idrelated to the virtual bundle SKU. | ^^^^sku_count |int |1 |The quantity of original SKU that compose the virtual bundle SKU. | ^^^^product_id |string |1729582718312380456 |The originalproduct_idrelated to the virtual bundle SKU. | ^^^^seller_sku |string |yellow-24-XL |The originalseller_sku(which is defined by sellers) related to the virtual bundle SKU. | ^^^product_id |string |1729582718312380123 |Product ID. | ^^^product_name |string |Women's Winter Crochet Clothes |Product name. | ^^^sku_name |string |Iphone |The name of the SKU, combined by product SKU attribute like size or color. For example, "Black, 26." | ^^^sku_image |string |https://p16-oec-va.itexeitg.com/tos-maliva-d-o5syd03w52-us/46123e87d14f40b69b839 |SKU image. | ^^^original_price |string |0.01 |Item original price, please refer to the currency ofpayment_info. | ^^^sale_price |string |0.01 |Item sale price, please refer to the currency ofpayment_info. | ^^^pfand_fee |string |1.5 |Deposit fee that is applied to certain products, typically beverage containers such as bottles or cans. Note Only available in Germany market | ^^^platform_discount |string |0 |Platform discount amount, please refer to the currency ofpayment_info. | ^^^display_status |string |TO_SHIP |-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. | ^^^cancel_user |string |BUYER |The initiator of a cancellation request:BUYERSELLEROPERATORSYSTEM| ^^^sku_type |string |PRE_ORDER |[Deprecated: This field is deprecated and will be removed in a future API version. Useorder_typeinstead.] The order line type: Possible values based on region: All regionsNORMAL: 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. USPRE_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. | ^^^seller_sku |string |red_iphone_256 |The seller stock keeping unit (SKU) of the item. | ^^^shipping_provider_id |string |6617675021119438849 |The shipping provider ID of the item. | ^^^seller_discount |string |0 |Seller discount amount. Please refer to the currency ofpayment_info. | ^^^currency |string |IDR |Currency for payment. | ^^^package_id |string |1153132168123859123 |An order can contain one or more packages based on how the seller chooses to ship. Each package has a uniquepackage_id(and also atracking_id, which is used to track the progress of the package as it is shipped). For local sellers in the US and UK markets, thepackage_idandpackage_statusproperty will not be returned before the package is shipped | ^^^rts_time |int |1678389618 |The time seller shipped line order (call Ship Order endpoint successfully). Unix timestamp. | ^^^item_tax |[]object | |Item tax detail. | ^^^^tax_type |string |SALES_TAX |Tax type.SALES_TAX(US market sales tax) Currently only sales tax is available. | ^^^^tax_amount |string |21.2 |Tax amount. | ^^^^tax_rate |string |0.35 |Tax rate. | ^^^package_status |string |TO_FULFILL |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. | ^^^shipping_provider_name |string |TT Virtual express |The shipping provider name of the item. | ^^^is_gift |bool |false |Indicates whether the current order line is a gift. | ^^^cancel_reason |string |Discount not as expected |Item cancellation reason. | ^^^small_order_fee |string |5000 |Small order fee for TH. | ^^^retail_delivery_fee |string |1.28 |RDF (retail delivery fee). Available only in the US market. | ^^^tracking_number |string |JX12345 |Tracking number. Available after package has been shipped. | ^^^buyer_service_fee |string |1000 |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. | ^^^handling_duration_days |string |7 |[Deprecated: This field is deprecated and will be removed in a future API version. Usehandling_durationinstead.] 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 forsku_typeisMADE_TO_ORDER. | ^^^is_dangerous_good |bool |true |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 betweensku_idandpackage_idto determine how to follow platform rules. | ^^^needs_prescription |bool |true |A flag to indicate whether the included product requires a prescription. | ^^^gift_retail_price |string |20 |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 | ^^^is_unboxing_item |bool |false |Iftrue, 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. | ^^^unboxing_sku_code |string |14531134 |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. | ^^^unboxing_case_list |[]object | |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. | ^^^^unbox_sku |string |14531134 |Unboxed sku code associated with the actual unboxed item. | ^^^^unbox_sku_type |string |GIFT |Indicates if the unboxed sku is a gift item Enumerations: NORMAL or GIFT | ^^^sub_item_info |[]object | |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. | ^^^^id |string |577086512123755123 |Line item id of the sub_item. This unique identifier can be used when performing split/line-level fulfillment events. | ^^^^sku_id |string |2729382476852921560 |SKU ID. | ^^^^display_status |string |UNPAID |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. | ^^^^product_name |string |Women's Winter Crochet Clothes |Product name. | ^^^^seller_sku |string |red_iphone_256 |The seller stock keeping unit (SKU) of the item. | ^^^^sku_image |string |https://p16-oec-va.itexeitg.com/tos-maliva-d-o5syd03w52-us/46123e87d14f40b69b839 |SKU image. | ^^^^sku_name |string |Iphone |The name of the SKU, combined by product SKU attribute like size or color. e.g. "Black, 26" | ^^^^product_id |string |1729582718312380123 |Product ID. | ^^^^sale_price |string |0.01 |Item sale price. Please refer to the currency ofpayment_info. | ^^^^platform_discount |string |0 |Platform discount amount. Please refer to the currency ofpayment_info. | ^^^^seller_discount |string |0 |Seller discount amount. Please refer to the currency ofpayment_info. | ^^^^cancel_reason |string |Discount not as expected |The cancellation reason. Please visit our list of cancel reasons for more information. | ^^^^original_price |string |0.01 |Item original price. Please refer to the currency ofpayment_info. | ^^^^rts_time |int |1678389618 |The time sellers shipped the order (called Ship Package API successfully). Unix timestamp. | ^^^^package_status |string |TO_FULFILL |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. | ^^^^currency |string |USD |Currency for payment. | ^^^^shipping_provider_name |string |TT Virtual express |The shipping provider name. | ^^^^cancel_user |string |BUYER |Cancellation request initiator. Available values:BUYERSELLEROPERATORSYSTEM| ^^^^shipping_provider_id |string |6617675021119438849 |The shipping provider ID of the item. | ^^^^item_tax |[]object | |Item tax detail. | ^^^^^tax_type |string |SALES_TAX |Tax type. Available values:SALES_TAX(US market sales tax)
Note: Currently only sales tax is available. |
^^^^^tax_amount |string |21.2 |Tax amount. |
^^^^^tax_rate |string |0.35 |Tax rate. |
^^^^tracking_number |string |JX12345 |Tracking number. Available after package has been shipped. |
^^^^package_id |string |1153132168123859123 |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. |
^^^^retail_delivery_fee |string |1.28 |Retail delivery fee (RDF).
Note: Only available in the US market. |
^^^^is_dangerous_good |bool |false |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. |
^^^^warehouse_id |string |6955005333819123123 |Seller warehouse ID. |
^^^distance_shipping_fee |string |1000 |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. |
^^^distance_fee |string |2000 |Total distance fee for Horizon+ Program. Only applicable for ID market |
^^^shipping_vat_amount |string |3.5 |Shipping vat amount
Available in EU market |
^^^shipping_vat_rate |string |0.25 |Shipping vat rate
Available in EU market |
^^^is_pod_customized |bool |false |Identifies if this SKU contains print on demand customization |
^^^pod_info_id |string |789123812334 |ID of the print on demand customization details. This ID can be used to query for the exact details of the customization |
^^^room_id |string |7652884452049160991 |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. |
^^^product_listing_type |string |TEMPORARY_LISTING |This describes the product listing type of the SKU.
Possible values:
TEMPORARY_LISTING| ^^shipping_type |string |TIKTOK |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. | ^^buyer_email |string |v2b2V5@chat.seller.tiktok.com |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. | ^^delivery_time |int |1678389618 |The timestamp of the order's status update toDELIVERED. | ^^need_upload_invoice |string |NEED_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 | ^^is_cod |bool |false |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. | ^^request_cancel_time |int |1678389618 |Buyer request cancel time. | ^^delivery_option_required_delivery_time |int |1678389618 |Order should be delivered before this time. | ^^delivery_option_name |string |Express shipping |Delivery option name. For display purposes only. | ^^is_buyer_request_cancel |bool |false |True when the buyer has a pending cancellation request | ^^delivery_due_time |int |1678389618 |If the order hasn't updated its status toDELIVEREDbefore this time, the order will be automatically canceled by TikTok Shop. | ^^collection_time |int |1678389618 |The timestamp of the order's status update toIN_TRANSIT. | ^^is_on_hold_order |bool |false |Indicates whether the order experienced or will be experiencedON_HOLDstatus. | ^^cancel_time |int |1678389618 |The timestamp of the order's status update toCANCELLED. | ^^is_replacement_order |bool |false |When true, this is a replacement order. | ^^replaced_order_id |string |576461416728782174 |The order ID for the order that is being replaced. Returned only ifis_replacement_order=true| ^^collection_due_time |int |1678389618 |If the order hasn't updated its status toIN_TRANSITbefore this time, the order will be automatically canceled by TikTok Shop | ^^pick_up_cut_off_time |int |1678389618 |To avoid LDR, you must ensure the package is picked up by this time. Only applicable in Southeast Asia regions. | ^^fast_dispatch_sla_time |int |1678389618 |The latest collection time to gain incentives of NDD (Next Day Delivery) project. Unix timestamp Only available in Thailand and Philippines. | ^^commerce_platform |string |TIKTOK_SHOP |The platform where the order was placed. Possible values: - TIKTOK_SHOP
- TOKOPEDIA Note: Available only in the Indonesia market. | ^^order_type |string |ZERO_LOTTERY |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. USPRE_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. | ^^release_date |int |1619611762 |The date on which order handling starts and the status of the order changes to AWAITING_SHIPMENT. Applicable only if theorder_typeisPRE_ORDER. | ^^handling_duration |object | |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 theorder_typeisMADE_TO_ORDERorBACK_ORDER. | ^^^days |string |7 |The number of days. | ^^^type |string |BUSINESS_DAY |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| ^^auto_combine_group_id |string |12345677 |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. | ^^cpf_name |string |John Smith |Name belonging to the CPF number for the Brazil market. | ^^is_exchange_order |bool |false |When TRUE, this is an exchange order. Note: Only available in US and UK. | ^^exchange_source_order_id |string |576461413038785752 |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. | ^^is_subscription_order |bool |true |Subscription orders are recurring orders set up by customers. If TRUE, this order is generated from a subscription order | ^^is_refundable_sample |bool |false |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. | ^^authentication_required |bool |false |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. | ^^consultation_id |string |123241 |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. | ^^fast_delivery_program |string |3_DAY_DELIVERY |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_DELIVERY3_DAY_POTENTIAL_SHIPPING3_DAY_POTENTIAL_TRANSITNot returned if order did not meet fast delivery program requirements. Note: Applicable only for the US market. | ^^buyer_nickname |string |user213123 |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. | ^^buyer_avatar |string |https://p16-oec-va.itexeitg.com/tos-maliva-d-o5syd03w52-us/46123e87d14f40b69b839 |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. | ^^order_rights |[]int |[1] |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 | ^^fulfillment_priority_level |int |100 |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 | ^^recommended_shipping_time |int |1619611561 |Recommended time to ship based on the each LSP service type (only available in SEA) | ^^instore_pickup_sla_time |int |1784090976 |The latest buyer pickup time for instore pickup method specified by the platform. Currently applicable for SEA market. Unix timestamp. |
§8 Response Sample
{"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\n","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}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§9 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 10002014 | Failed to get orders, If multiple retry have failed, please contact the platform for assistance |
| 10002015 | Failed to get orders, If multiple retry have failed, please contact the platform for assistance |
| 10006402 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 10037002 | Failed to get orders, If multiple retry have failed, please contact the platform for assistance |
| 10037003 | Failed to get orders, If multiple retry have failed, please contact the platform for assistance |
| 10037004 | Failed to get orders, If multiple retry have failed, please contact the platform for assistance |
| 21008111 | The order or package does not belong to the current seller. |
