Create Order Record

📘

When to Use This Endpoint

This endpoint is intended for ingesting custom order data only (Custom Sales Platform). If your store already uses a native Triple Whale integration — such as Shopify, BigCommerce, or WooCommerce — use the Enrich Orders Data endpoint instead to enrich your natively-integrated order records.

📘

How to Update a Custom Order Record

To update a custom order record, resend the order with all of the following fields exactly matching the original:

shop, order_id, refund_id, created_at, refunded_at, platform, platform_account_id

All other fields will be overwritten with the newly sent values.

Body Params
string
required
string
required
string
Defaults to custom-msp
string
Defaults to custom-msp
date-time
required
string
required
customer
object
required
number
boolean | null
discount_codes
array of objects
discount_codes
line_items
array of objects
line_items
string
payment_gateway_names
array of strings
payment_gateway_names
refunds
array of objects
refunds
shipping_address
object
shipping_lines
array of objects
shipping_lines
number
number
string
string
tags
array of strings
tags
boolean
Defaults to false
number
required
number
number
string
date-time
boolean
Defaults to false
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json