Enrich Orders Data

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

Enrich orders data with additional details such as shipping costs and custom expenses. Use this endpoint to upload extra information for a specific order.

Body Params

custom_expenses

number

Additional custom expenses associated with the order, in the currency of the order enriched. Must be non-negative.

custom_gross_profit

number

Custom Gross Profit for the order, in the currency of the order being enriched. Must be non-negative.

custom_gross_sales

number

Custom Gross Sales for the order, in the currency of the order being enriched. Must be non-negative.

custom_net_revenue

number

Custom Net Revenue for the order, in the currency of the order being enriched. Must be non-negative.

custom_number

number

A custom numeric value for the order, can be used for specialized calculations, references, or reporting.

custom_status

string

A custom status label for the order, useful for filtering on statuses not captured by the built-in status field.

custom_string

string

A free-form text field for storing additional metadata, internal notes, or other custom data relevant to this order.

ignore_order

boolean

Defaults to false

If true, the order is flagged to be ignored in standard reporting (e.g., to exclude test data or partial orders).

order_id

string

required

The unique identifier for the order being enriched.

orders_quantity

number

The quantity of orders to count for this single order_id. Must be 0 or 1.

platform

string

The sales platform where the order being enriched was processed. Required for secondary sales platforms (e.g. Amazon), optional for main sales platform (e.g. Shopify).

shipping_costs

number

Shipping costs paid by the seller for the order, in the currency of the order being enriched. Must be non-negative.

shop

string

required

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

total_items_quantity

number

The total number of items in the order. Must be non-negative.

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.triplewhale.com/api/v2/data-in/orders-enrichment \
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 enrichment successfully received.

400Bad Request

429Too Many Requests

500Internal Server Error