v1

latestOpenAPI 3.1.02026-08-04170116.0 KB

Data In

Enrich Orders Data

Use this endpoint to enrich existing orders—such as adding shipping costs or custom tags. Note: Supported for data from platforms with a native Triple Whale integration (e.g., Shopify, BigCommerce, WooCommerce). Not supported for Custom Sales Platforms—to update these, resend the full order via the Orders endpoint.

post/data-in/orders-enrichment

Request body

custom_expensesnumber

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

custom_gross_profitnumber

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

custom_gross_salesnumber

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

custom_net_revenuenumber

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

custom_numbernumber

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

custom_statusstring

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

custom_stringstring

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

ignore_orderboolean

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

order_idstring required

The unique identifier for the order being enriched.

orders_quantitynumber

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

platformstring

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_costsnumber

Shipping costs paid by the seller for the order, in the currency of the order being enriched. Must be non-negative. To apply this value to your data, ensure Default Shipping Costs is selected in Cost Settings > Shipping.

shopstring required

The exact Shop URL (e.g., 'example.myshopify.com'). Must match the Shop URL value shown in Settings → Store. The API key owner must also have access to the shop, otherwise the request will return 403.

total_items_quantitynumber

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

Example request

{
  "custom_expenses": 25,
  "custom_gross_profit": 400,
  "custom_gross_sales": 2000,
  "custom_net_revenue": 1200,
  "custom_number": 3.14,
  "custom_status": "unfulfilled",
  "custom_string": "AlphaBetaTest",
  "order_id": "order_12345",
  "orders_quantity": 1,
  "platform": "amazon",
  "shipping_costs": 15,
  "shop": "madisonbraids.myshopify.com",
  "total_items_quantity": 10
}

Response

Order enrichment successfully received.

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Order enrichment received"
}