Skip to main content

Submit API Orders with a Sales Channel (e.g. TikTok)

How to tag API orders with the sales channel they came from, such as TikTok, Shopify or Etsy

A
Written by Admin

When you sell on several storefronts, you can tell Turbine where each order came from by adding a sales channel to the order. The sales channel is stored on the order, printed on the packing slip, shown to our fulfillment team, and returned when you check order status.


Step 1: Add sales_channel to Your Order Request

Add the sales_channel field at the top level of the order JSON you send to POST /api/v3/orders. It goes alongside purchase_order and ship_to, not inside an item.

POST https://{your-turbine-url}/api/v3/orders
Authorization: Token token=YOUR_API_KEY
Content-Type: application/json

{
"type": "order",
"account_id": 1,
"account_zip": "92704",
"purchase_order": "TT-100045",
"sales_channel": "TikTok",
"ship_to": {
"first_name": "John",
"last_name": "Doe",
"address": "123 Main St",
"city": "Los Angeles",
"state": "CA",
"zip_code": "90001",
"country": "US",
"email": "[email protected]"
},
"items": [
{
"sku": "2000_WHITE_L",
"quantity": 1,
"designs": [
{
"design_id": 12345
}
]
}
]
}

The field is also in the request example in the API documentation:


Step 2: Choose Your Channel Names

sales_channel is free text and is optional. A few tips:

  • Use the same spelling every time. "TikTok", "Tiktok" and "TikTok Shop" are saved as three different values.

  • Keep it short. The value is printed on the packing slip, so a short name like TikTok, Shopify, Etsy or Amazon works best.

  • Leave it out if you don't need it. Orders without a sales channel are processed normally.

Field

Where it goes

Example

Required

sales_channel

Order JSON (top level)

TikTok

No

X-Account-Identifier

Request header

tiktok-shop-7741

No


Step 3 (Optional): Identify the Specific Store

If you run more than one store on the same channel (for example, two TikTok shops), you can also send the X-Account-Identifier request header with your own ID for that store. Turbine saves it as the order's sales_channel_id.

POST https://{your-turbine-url}/api/v3/orders
Authorization: Token token=YOUR_API_KEY
X-Account-Identifier: tiktok-shop-7741
Content-Type: application/json

Step 4: Confirm the Sales Channel Was Saved

Look up the order with GET /api/v3/orders/{order_id}. The response includes the values you sent:

{
"id": 6724120,
"purchase_order": "TT-100045",
"sales_channel": "TikTok",
"sales_channel_id": "tiktok-shop-7741",
...
}

If you didn't send a sales channel, these fields are returned as null.


Submitting by CSV Instead?

If you import orders by CSV instead of the API, add a Sales Channel column and enter the channel name on each order row. See Import Orders via CSV for the full template.


Need Help?

For the full list of order fields, see the API documentation at turbine-app.240tech.com/developers. If your sales channel isn't showing up on your orders, contact your account representative or reach out to our support team.

Did this answer your question?