Create Order Record

post https://api.triplewhale.com/api/v2/data-in/orders

Ingest order data into Triple Whale. This endpoint allows users to upload detailed order information, including customer details, line items, transaction totals, discounts, refunds, and shipping details.

Body Params

shop

string

required

The domain of the shop (e.g., 'example.myshop.com').

order_id

string

required

The unique identifier for the order.

order_revenue

number

required

The total revenue after adjustments such as discounts, shipping, fees, and taxes. Must be non-negative.

platform

string

Defaults to custom_msp_platform

The sales platform where the order originated.

platform_account_id

string

Defaults to custom_msp_account

The account ID associated with the platform.

created_at

date-time

required

The date and time the order was created. Must be in ISO 8601 format.

currency

string

required

The currency of the transaction (e.g., 'USD').

customer

object

required

Details of the customer who placed the order. The id field is required. Additionally, at least one of email or phone must be provided.

custom_expenses

number

Custom expenses associated with the order, must be non-negative.

discount_codes

array of objects

Discount codes applied to the order.

discount_codes

line_items

array of objects

Details of the products in the order.

line_items

name

string

The name of the order. Maps to order_name in the Orders table. Defaults to order_id.

refunds

array of objects

Details of refunds applied to the order.

refunds

shipping_address

object

Shipping address details.

shipping_lines

array of objects

Details of the shipping lines for the order.

shipping_lines

shipping_costs

number

Shipping costs paid by the seller. Must be non-negative.

subscription_id

string

The unique identifier for the subscription associated with the order.

tags

taxes_included

boolean

Defaults to false

Indicates if taxes are included in the total price of the order.

tax_lines

array of objects

Defaults to

Tax details applied to the order.

tax_lines

total_discounts

number

The total discounts applied to the order. Must be non-negative.

total_tax

number

The total tax applied to the order. Must be non-negative. Maps to taxes in the Orders table.

status

string

The current status of the order (e.g., "completed", "pending"). Maps to fulfillment_status in the Orders table.

updated_at

date-time

The date and time the order was last updated. Defaults to the current timestamp in ISO 8601 format.

void

boolean

Defaults to false

Indicates whether the order is voided. If true, the order will be filtered out of all queries.

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.triplewhale.com/api/v2/data-in/orders \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Order record successfully received.

400Bad Request

429Too Many Requests

500Internal Server Error