stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fbt/202607/mcf_outbound_orders
#§2 Method: [POST]
#§3 Function Description
For orders created on other sales channels that require fulfillment via FBT, this API enables you to create corresponding orders (hereinafter referred to as MCF Orders). Once MCF Orders are successfully created, they will be automatically submitted to the FBT system for fulfillment.
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| external_order_id | string | Y | shopify202208291503530001100220033 | The corresponding order ID in your OMS. |
| goods | []object | Y | The item IDs and quantities included in the order, where the items must be those managed in the FBT system. | |
| ^id | string | Y | 1234567 | Identifier for goods generated by Fulfilled by TikTok system |
| ^quantity | int | Y | 1 | The total number of items, i.e. the sum of the quantity of all goods, must not exceed 50. |
| consignee | object | Y | The consignee contact info | |
| ^name | string | Y | username | The consignee name |
| ^phone_number | string | Y | (+1)1211223910 | The phone number of consignee |
| string | Y | username@example.com | The email of consignee | |
| ^address | object | Y | The consignee address must be a valid address; if the address verification fails, no order will be created. | |
| ^^country_code | string | Y | US | Consignee address country code in two-character ISO 3166-1 alpha-2 format. |
| ^^state_or_region | string | Y | Alabama | Consignee address state or region |
| ^^district_or_county | string | N | Baldwin | Consignee address district or county |
| ^^city | string | Y | Bay Minette | Consignee address city |
| ^^address_line_1 | string | Y | Apt. 302, 5th Ave | The detail address line 1 |
| ^^address_line_2 | string | N | San Jose | The detail address line 2 |
| ^^postal_code | string | N | 30518 | The postal code |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fbt/202607/mcf_outbound_orders?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"external_order_id":"shopify202208291503530001100220033","goods":[{"id":"1234567","quantity":1}],"consignee":{"name":"username","phone_number":"(+1)1211223910","email":"username@example.com","address":{"country_code":"US","state_or_region":"Alabama","district_or_county":"Baldwin","city":"Bay Minette","address_line_1":"Apt. 302, 5th Ave","address_line_2":"San Jose","postal_code":"30518"}}}
§8 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 | |
| ^mcf_order | object | Created order information | |
| ^^external_order_id | string | shopify202208291503530001100220033 | The corresponding order ID in your OMS. |
| ^^mcf_order_id | string | 7136104329798256386 | A unique ID that identifies different MCF orders |
| ^^create_time | int | 1661756811 | The time when the mcf order is created |
§9 Response Sample
{"code":0,"data":{"mcf_order":{"external_order_id":"shopify202208291503530001100220033","mcf_order_id":"7136104329798256386","create_time":1661756811}},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 177001001 | Missing parameters or parameters have incorrect format |
| 177001002 | Item data does not exist in the FBT system. You must provide valid item IDs; otherwise, the FBT system cannot fulfill the order. |
| 177001003 | The address information has failed verification. Please check the validity of the address, Please make sure your address is accurate, check address via USPS ZIP Lookup Tool. |
| 177001004 | Insufficient inventory; unable to fulfill the order. Please replenish the inventory or arrange delivery via alternative methods. |
| 177001006 | The merchant has no permission to create external orders; please check your permissions or contact the platform. |
| 177001007 | The external_order_number has been associated with an active MCF Order. The FBT system is currently processing the order delivery, and duplicate order creation is not allowed. |
| 177001008 | The order creation rate limit has been exceeded; please reduce the call frequency or try again later. |
| 177001009 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 177001010 | Order information cannot be retrieved via the mcf_order_id you provided; please check if your ID is correct. |
| 177001011 | address is unreachable |
| 177001012 | order has been pushed to fulfillment system, cannot push again |
| 177001013 | no permission,please pay for the FBT billing first |
| 177001014 | the zipcode is wrong |
| 177001015 | new goods have not yet arrived at the warehouse |
| 177001016 | the maximum number of goods per order cannot exceed 99 |