{ "info": { "_postman_id": "5d2e2de1-c0b0-49de-8662-309fc5e203c6", "name": "Triple Whale API Keys Data In API", "description": "Triple Whale API documentation, providing endpoints for managing user authentication, API key validation, and uploading data such as ads and metrics.\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:19:25.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "lastUpdatedBy": "35240", "uid": "35240-5d2e2de1-c0b0-49de-8662-309fc5e203c6" }, "item": [ { "name": "data-in", "item": [ { "name": "ads", "item": [ { "name": "Create Ad Record", "id": "f6662a2c-7ea4-4776-968c-3426caa1a4c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"channel\": \"\",\n \"event_date\": \"\",\n \"currency\": \"\",\n \"channel_account_id\": \"CUSTOM_CHANNEL\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"ACTIVE\"\n },\n \"adset\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PAUSED\"\n },\n \"ad\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PAUSED\",\n \"thumbnail\": \"\"\n },\n \"metrics\": {\n \"clicks\": 0,\n \"conversions\": 0,\n \"conversion_value\": 0,\n \"impressions\": 0,\n \"spend\": 0,\n \"visits\": 0\n },\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/ads", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "ads" ] }, "description": "Ingest ad data into Triple Whale. This endpoint allows users to upload detailed ad information, including campaign, adset, ad details, and performance metrics.\n" }, "response": [ { "id": "c9797715-a070-4979-a491-87992b9c35c6", "name": "Ad record successfully received.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"channel\": \"\",\n \"event_date\": \"\",\n \"currency\": \"\",\n \"channel_account_id\": \"CUSTOM_CHANNEL\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"ACTIVE\"\n },\n \"adset\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PAUSED\"\n },\n \"ad\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PAUSED\",\n \"thumbnail\": \"\"\n },\n \"metrics\": {\n \"clicks\": 0,\n \"conversions\": 0,\n \"conversion_value\": 0,\n \"impressions\": 0,\n \"spend\": 0,\n \"visits\": 0\n },\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/ads", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "ads" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-c9797715-a070-4979-a491-87992b9c35c6" }, { "id": "a3fbbd75-1eba-432f-b4c0-6b7ab10db6a3", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"channel\": \"\",\n \"event_date\": \"\",\n \"currency\": \"\",\n \"channel_account_id\": \"CUSTOM_CHANNEL\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"ACTIVE\"\n },\n \"adset\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PAUSED\"\n },\n \"ad\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PAUSED\",\n \"thumbnail\": \"\"\n },\n \"metrics\": {\n \"clicks\": 0,\n \"conversions\": 0,\n \"conversion_value\": 0,\n \"impressions\": 0,\n \"spend\": 0,\n \"visits\": 0\n },\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/ads", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "ads" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-a3fbbd75-1eba-432f-b4c0-6b7ab10db6a3" }, { "id": "e148b4d6-0cf4-422b-8882-68cd6584d503", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"channel\": \"\",\n \"event_date\": \"\",\n \"currency\": \"\",\n \"channel_account_id\": \"CUSTOM_CHANNEL\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"ACTIVE\"\n },\n \"adset\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PAUSED\"\n },\n \"ad\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PAUSED\",\n \"thumbnail\": \"\"\n },\n \"metrics\": {\n \"clicks\": 0,\n \"conversions\": 0,\n \"conversion_value\": 0,\n \"impressions\": 0,\n \"spend\": 0,\n \"visits\": 0\n },\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/ads", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "ads" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds until the user can make another request.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-e148b4d6-0cf4-422b-8882-68cd6584d503" }, { "id": "665890cb-436c-4e71-b624-333f276bf776", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"channel\": \"\",\n \"event_date\": \"\",\n \"currency\": \"\",\n \"channel_account_id\": \"CUSTOM_CHANNEL\",\n \"campaign\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"ACTIVE\"\n },\n \"adset\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PAUSED\"\n },\n \"ad\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PAUSED\",\n \"thumbnail\": \"\"\n },\n \"metrics\": {\n \"clicks\": 0,\n \"conversions\": 0,\n \"conversion_value\": 0,\n \"impressions\": 0,\n \"spend\": 0,\n \"visits\": 0\n },\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/ads", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "ads" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-665890cb-436c-4e71-b624-333f276bf776" } ], "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-f6662a2c-7ea4-4776-968c-3426caa1a4c0" } ], "id": "62068631-a10c-4e0b-981f-330429e49905", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-62068631-a10c-4e0b-981f-330429e49905" }, { "name": "orders", "item": [ { "name": "Create Order Record", "id": "8588a60a-c746-400a-82fe-dcdd778e24de", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"order_revenue\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"custom_expenses\": \"\",\n \"discount_codes\": [\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"fixed_amount\"\n },\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"fixed_amount\"\n }\n ],\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n }\n ],\n \"name\": \"\",\n \"payment_gateway_names\": [\n \"\",\n \"\"\n ],\n \"refunds\": [\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n },\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n }\n ],\n \"shipping_address\": {\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"zip\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"province_code\": \"\"\n },\n \"shipping_lines\": [\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n },\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n }\n ],\n \"shipping_price\": \"\",\n \"shipping_costs\": \"\",\n \"source_name\": \"\",\n \"subscription_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"taxes_included\": false,\n \"total_discounts\": \"\",\n \"taxes\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"void\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/orders", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "orders" ] }, "description": "Ingest order data into Triple Whale for Custom Sales Platforms. This endpoint allows users to upload detailed order information, including customer details, product information, transaction totals, discounts, refunds, and shipping details.\n" }, "response": [ { "id": "b21772ac-6ec5-4afd-8d59-d0c8a6a148ad", "name": "Order record successfully received.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"order_revenue\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"custom_expenses\": \"\",\n \"discount_codes\": [\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"fixed_amount\"\n },\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"fixed_amount\"\n }\n ],\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n }\n ],\n \"name\": \"\",\n \"payment_gateway_names\": [\n \"\",\n \"\"\n ],\n \"refunds\": [\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n },\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n }\n ],\n \"shipping_address\": {\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"zip\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"province_code\": \"\"\n },\n \"shipping_lines\": [\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n },\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n }\n ],\n \"shipping_price\": \"\",\n \"shipping_costs\": \"\",\n \"source_name\": \"\",\n \"subscription_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"taxes_included\": false,\n \"total_discounts\": \"\",\n \"taxes\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"void\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/orders", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-b21772ac-6ec5-4afd-8d59-d0c8a6a148ad" }, { "id": "200b1d5e-6d54-4ffd-9628-e241b5bdbf6c", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"order_revenue\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"custom_expenses\": \"\",\n \"discount_codes\": [\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"fixed_amount\"\n },\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"fixed_amount\"\n }\n ],\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n }\n ],\n \"name\": \"\",\n \"payment_gateway_names\": [\n \"\",\n \"\"\n ],\n \"refunds\": [\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n },\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n }\n ],\n \"shipping_address\": {\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"zip\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"province_code\": \"\"\n },\n \"shipping_lines\": [\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n },\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n }\n ],\n \"shipping_price\": \"\",\n \"shipping_costs\": \"\",\n \"source_name\": \"\",\n \"subscription_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"taxes_included\": false,\n \"total_discounts\": \"\",\n \"taxes\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"void\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/orders", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "orders" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-200b1d5e-6d54-4ffd-9628-e241b5bdbf6c" }, { "id": "453e45c9-962f-4d17-8370-93b973468235", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"order_revenue\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"custom_expenses\": \"\",\n \"discount_codes\": [\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"fixed_amount\"\n },\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"fixed_amount\"\n }\n ],\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n }\n ],\n \"name\": \"\",\n \"payment_gateway_names\": [\n \"\",\n \"\"\n ],\n \"refunds\": [\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n },\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n }\n ],\n \"shipping_address\": {\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"zip\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"province_code\": \"\"\n },\n \"shipping_lines\": [\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n },\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n }\n ],\n \"shipping_price\": \"\",\n \"shipping_costs\": \"\",\n \"source_name\": \"\",\n \"subscription_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"taxes_included\": false,\n \"total_discounts\": \"\",\n \"taxes\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"void\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/orders", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "orders" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds until the user can make another request.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-453e45c9-962f-4d17-8370-93b973468235" }, { "id": "8eef7ff1-1100-4e87-8dc1-ac945b11ac29", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"order_revenue\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"custom_expenses\": \"\",\n \"discount_codes\": [\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"fixed_amount\"\n },\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"fixed_amount\"\n }\n ],\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n }\n ],\n \"name\": \"\",\n \"payment_gateway_names\": [\n \"\",\n \"\"\n ],\n \"refunds\": [\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n },\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n }\n ],\n \"shipping_address\": {\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"zip\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"province_code\": \"\"\n },\n \"shipping_lines\": [\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n },\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n }\n ],\n \"shipping_price\": \"\",\n \"shipping_costs\": \"\",\n \"source_name\": \"\",\n \"subscription_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"taxes_included\": false,\n \"total_discounts\": \"\",\n \"taxes\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"void\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/orders", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "orders" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-8eef7ff1-1100-4e87-8dc1-ac945b11ac29" } ], "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-8588a60a-c746-400a-82fe-dcdd778e24de" } ], "id": "9ec673a4-0502-458d-8a31-4003d8d78d54", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-9ec673a4-0502-458d-8a31-4003d8d78d54" }, { "name": "bulk-orders", "item": [ { "name": "Bulk Create Order Records", "id": "00c716e0-70fa-42e7-844f-0e45c4f02c47", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"orders\": [\n {\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"order_revenue\": \"\",\n \"shop\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"custom_expenses\": \"\",\n \"discount_codes\": [\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n },\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n }\n ],\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n }\n ],\n \"name\": \"\",\n \"payment_gateway_names\": [\n \"\",\n \"\"\n ],\n \"refunds\": [\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n },\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n }\n ],\n \"shipping_address\": {\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"zip\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"province_code\": \"\"\n },\n \"shipping_lines\": [\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n },\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n }\n ],\n \"shipping_price\": \"\",\n \"shipping_costs\": \"\",\n \"source_name\": \"\",\n \"subscription_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"taxes_included\": false,\n \"total_discounts\": \"\",\n \"taxes\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"void\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/bulk-orders", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "bulk-orders" ] }, "description": "Ingest multiple order records into Triple Whale for Custom Sales Platforms. This endpoint allows users to upload batches of order information, including customer details, product information, transaction totals, discounts, refunds, and shipping details.\n" }, "response": [ { "id": "791828c7-51fa-4351-b449-c8bd8a161945", "name": "Order records successfully received.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"orders\": [\n {\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"order_revenue\": \"\",\n \"shop\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"custom_expenses\": \"\",\n \"discount_codes\": [\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n },\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n }\n ],\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n }\n ],\n \"name\": \"\",\n \"payment_gateway_names\": [\n \"\",\n \"\"\n ],\n \"refunds\": [\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n },\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n }\n ],\n \"shipping_address\": {\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"zip\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"province_code\": \"\"\n },\n \"shipping_lines\": [\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n },\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n }\n ],\n \"shipping_price\": \"\",\n \"shipping_costs\": \"\",\n \"source_name\": \"\",\n \"subscription_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"taxes_included\": false,\n \"total_discounts\": \"\",\n \"taxes\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"void\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/bulk-orders", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "bulk-orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-791828c7-51fa-4351-b449-c8bd8a161945" }, { "id": "4d0c68a8-4e3d-4128-870a-2b364d6d9424", "name": "Bad Request. Returned if one or more orders fail validation. Valid orders in the same request are still processed even when this response is returned.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"orders\": [\n {\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"order_revenue\": \"\",\n \"shop\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"custom_expenses\": \"\",\n \"discount_codes\": [\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n },\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n }\n ],\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n }\n ],\n \"name\": \"\",\n \"payment_gateway_names\": [\n \"\",\n \"\"\n ],\n \"refunds\": [\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n },\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n }\n ],\n \"shipping_address\": {\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"zip\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"province_code\": \"\"\n },\n \"shipping_lines\": [\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n },\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n }\n ],\n \"shipping_price\": \"\",\n \"shipping_costs\": \"\",\n \"source_name\": \"\",\n \"subscription_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"taxes_included\": false,\n \"total_discounts\": \"\",\n \"taxes\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"void\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/bulk-orders", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "bulk-orders" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"order_id\": \"\",\n \"error\": \"\"\n },\n {\n \"order_id\": \"\",\n \"error\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-4d0c68a8-4e3d-4128-870a-2b364d6d9424" }, { "id": "4ee45e0d-6373-436c-b315-0cc3c47dadfa", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"orders\": [\n {\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"order_revenue\": \"\",\n \"shop\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"custom_expenses\": \"\",\n \"discount_codes\": [\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n },\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n }\n ],\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n }\n ],\n \"name\": \"\",\n \"payment_gateway_names\": [\n \"\",\n \"\"\n ],\n \"refunds\": [\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n },\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n }\n ],\n \"shipping_address\": {\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"zip\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"province_code\": \"\"\n },\n \"shipping_lines\": [\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n },\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n }\n ],\n \"shipping_price\": \"\",\n \"shipping_costs\": \"\",\n \"source_name\": \"\",\n \"subscription_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"taxes_included\": false,\n \"total_discounts\": \"\",\n \"taxes\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"void\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/bulk-orders", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "bulk-orders" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds until the user can make another request.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-4ee45e0d-6373-436c-b315-0cc3c47dadfa" }, { "id": "b8875c0c-6a8a-4468-b4d6-dcc8d6f109dc", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"orders\": [\n {\n \"order_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"order_revenue\": \"\",\n \"shop\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"custom_expenses\": \"\",\n \"discount_codes\": [\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n },\n {\n \"code\": \"\",\n \"amount\": \"\",\n \"type\": \"percentage\"\n }\n ],\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"product_id\": \"\",\n \"name\": \"\",\n \"product_name\": \"\",\n \"variant_name\": \"\",\n \"sku\": \"\"\n }\n ],\n \"name\": \"\",\n \"payment_gateway_names\": [\n \"\",\n \"\"\n ],\n \"refunds\": [\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n },\n {\n \"refund_id\": \"\",\n \"refunded_at\": \"\",\n \"total_refund\": \"\",\n \"line_items\": [\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"variant_id\": \"\",\n \"line_item_id\": \"\",\n \"product_id\": \"\",\n \"currency\": \"\",\n \"total_discount\": \"\"\n }\n ],\n \"total_tax_refund\": \"\",\n \"total_shipping_refund\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"void\": false\n }\n ],\n \"shipping_address\": {\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"zip\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"province_code\": \"\"\n },\n \"shipping_lines\": [\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n },\n {\n \"shipping_discounted_price\": \"\",\n \"shipping_price\": \"\",\n \"source\": \"\",\n \"title\": \"\"\n }\n ],\n \"shipping_price\": \"\",\n \"shipping_costs\": \"\",\n \"source_name\": \"\",\n \"subscription_id\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"taxes_included\": false,\n \"total_discounts\": \"\",\n \"taxes\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\",\n \"void\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/bulk-orders", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "bulk-orders" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-b8875c0c-6a8a-4468-b4d6-dcc8d6f109dc" } ], "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-00c716e0-70fa-42e7-844f-0e45c4f02c47" } ], "id": "3b6605eb-6275-47c1-a207-b8b76510be5d", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-3b6605eb-6275-47c1-a207-b8b76510be5d" }, { "name": "subscriptions", "item": [ { "name": "Create Subscription Record", "id": "f933463d-d465-471b-a2d0-bafcfae95364", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"subscription_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"subscription_items\": [\n {\n \"subscription_item_id\": \"\",\n \"created_at\": \"\",\n \"status\": \"expired\",\n \"interval\": \"year\",\n \"interval_count\": \"\",\n \"price\": \"\",\n \"quantity\": \"\",\n \"canceled_at\": \"\",\n \"ended_at\": \"\",\n \"product_id\": \"\",\n \"variant_id\": \"\",\n \"discount\": {}\n }\n ],\n \"platform\": \"custom_subscription_platform\",\n \"platform_account_id\": \"custom_platform_account\",\n \"canceled_at\": \"\",\n \"ended_at\": \"\",\n \"cancellation_reason\": \"\",\n \"cancellation_comments\": \"\",\n \"metadata\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "subscriptions" ] }, "description": "Ingest subscription data into Triple Whale. This endpoint allows users to upload detailed subscription information, including customer details, items, status, and metadata.\n" }, "response": [ { "id": "1ae66e27-081d-4178-85a6-8cbc21808a82", "name": "Subscription record successfully received.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"subscription_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"subscription_items\": [\n {\n \"subscription_item_id\": \"\",\n \"created_at\": \"\",\n \"status\": \"expired\",\n \"interval\": \"year\",\n \"interval_count\": \"\",\n \"price\": \"\",\n \"quantity\": \"\",\n \"canceled_at\": \"\",\n \"ended_at\": \"\",\n \"product_id\": \"\",\n \"variant_id\": \"\",\n \"discount\": {}\n }\n ],\n \"platform\": \"custom_subscription_platform\",\n \"platform_account_id\": \"custom_platform_account\",\n \"canceled_at\": \"\",\n \"ended_at\": \"\",\n \"cancellation_reason\": \"\",\n \"cancellation_comments\": \"\",\n \"metadata\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-1ae66e27-081d-4178-85a6-8cbc21808a82" }, { "id": "2968debd-40e6-47dd-b0c8-a08d3fd9c0e9", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"subscription_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"subscription_items\": [\n {\n \"subscription_item_id\": \"\",\n \"created_at\": \"\",\n \"status\": \"expired\",\n \"interval\": \"year\",\n \"interval_count\": \"\",\n \"price\": \"\",\n \"quantity\": \"\",\n \"canceled_at\": \"\",\n \"ended_at\": \"\",\n \"product_id\": \"\",\n \"variant_id\": \"\",\n \"discount\": {}\n }\n ],\n \"platform\": \"custom_subscription_platform\",\n \"platform_account_id\": \"custom_platform_account\",\n \"canceled_at\": \"\",\n \"ended_at\": \"\",\n \"cancellation_reason\": \"\",\n \"cancellation_comments\": \"\",\n \"metadata\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "subscriptions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-2968debd-40e6-47dd-b0c8-a08d3fd9c0e9" }, { "id": "b7e6529d-9eab-48f8-8f23-853bd4edcc41", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"subscription_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"subscription_items\": [\n {\n \"subscription_item_id\": \"\",\n \"created_at\": \"\",\n \"status\": \"expired\",\n \"interval\": \"year\",\n \"interval_count\": \"\",\n \"price\": \"\",\n \"quantity\": \"\",\n \"canceled_at\": \"\",\n \"ended_at\": \"\",\n \"product_id\": \"\",\n \"variant_id\": \"\",\n \"discount\": {}\n }\n ],\n \"platform\": \"custom_subscription_platform\",\n \"platform_account_id\": \"custom_platform_account\",\n \"canceled_at\": \"\",\n \"ended_at\": \"\",\n \"cancellation_reason\": \"\",\n \"cancellation_comments\": \"\",\n \"metadata\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "subscriptions" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds until the user can make another request.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-b7e6529d-9eab-48f8-8f23-853bd4edcc41" }, { "id": "a30ef273-2782-4ba1-9e8a-b4b573790cc4", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"subscription_id\": \"\",\n \"created_at\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"customer\": {\n \"id\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"subscription_items\": [\n {\n \"subscription_item_id\": \"\",\n \"created_at\": \"\",\n \"status\": \"expired\",\n \"interval\": \"year\",\n \"interval_count\": \"\",\n \"price\": \"\",\n \"quantity\": \"\",\n \"canceled_at\": \"\",\n \"ended_at\": \"\",\n \"product_id\": \"\",\n \"variant_id\": \"\",\n \"discount\": {}\n }\n ],\n \"platform\": \"custom_subscription_platform\",\n \"platform_account_id\": \"custom_platform_account\",\n \"canceled_at\": \"\",\n \"ended_at\": \"\",\n \"cancellation_reason\": \"\",\n \"cancellation_comments\": \"\",\n \"metadata\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "subscriptions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-a30ef273-2782-4ba1-9e8a-b4b573790cc4" } ], "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-f933463d-d465-471b-a2d0-bafcfae95364" } ], "id": "18bc636c-0cf4-4509-b9e4-f0547f36df89", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-18bc636c-0cf4-4509-b9e4-f0547f36df89" }, { "name": "products", "item": [ { "name": "Create Product Record", "id": "83462749-1abf-4955-a70f-6d2897f6531f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"product_id\": \"\",\n \"product_title\": \"\",\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"variant_title\": \"\",\n \"variant_price\": \"\",\n \"sku\": \"\",\n \"variant_cost\": \"\",\n \"handling_fee\": \"\",\n \"inventory_quantity\": \"\",\n \"image_src\": \"\",\n \"compare_at_price\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"variant_title\": \"\",\n \"variant_price\": \"\",\n \"sku\": \"\",\n \"variant_cost\": \"\",\n \"handling_fee\": \"\",\n \"inventory_quantity\": \"\",\n \"image_src\": \"\",\n \"compare_at_price\": \"\"\n }\n ],\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"vendor\": \"\",\n \"product_status\": \"active\",\n \"product_tags\": [\n \"\",\n \"\"\n ],\n \"product_type\": \"\",\n \"collections\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/products", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "products" ] }, "description": "Ingest product data into Triple Whale. This endpoint allows users to upload detailed product information, including variants, tags, collections, and images.\n" }, "response": [ { "id": "2eb9227f-a1ea-4209-845e-d38ba5ab5ea4", "name": "Product record successfully received.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"product_id\": \"\",\n \"product_title\": \"\",\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"variant_title\": \"\",\n \"variant_price\": \"\",\n \"sku\": \"\",\n \"variant_cost\": \"\",\n \"handling_fee\": \"\",\n \"inventory_quantity\": \"\",\n \"image_src\": \"\",\n \"compare_at_price\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"variant_title\": \"\",\n \"variant_price\": \"\",\n \"sku\": \"\",\n \"variant_cost\": \"\",\n \"handling_fee\": \"\",\n \"inventory_quantity\": \"\",\n \"image_src\": \"\",\n \"compare_at_price\": \"\"\n }\n ],\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"vendor\": \"\",\n \"product_status\": \"active\",\n \"product_tags\": [\n \"\",\n \"\"\n ],\n \"product_type\": \"\",\n \"collections\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/products", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "products" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-2eb9227f-a1ea-4209-845e-d38ba5ab5ea4" }, { "id": "c2e98af0-1911-4926-8857-be92f6011582", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"product_id\": \"\",\n \"product_title\": \"\",\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"variant_title\": \"\",\n \"variant_price\": \"\",\n \"sku\": \"\",\n \"variant_cost\": \"\",\n \"handling_fee\": \"\",\n \"inventory_quantity\": \"\",\n \"image_src\": \"\",\n \"compare_at_price\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"variant_title\": \"\",\n \"variant_price\": \"\",\n \"sku\": \"\",\n \"variant_cost\": \"\",\n \"handling_fee\": \"\",\n \"inventory_quantity\": \"\",\n \"image_src\": \"\",\n \"compare_at_price\": \"\"\n }\n ],\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"vendor\": \"\",\n \"product_status\": \"active\",\n \"product_tags\": [\n \"\",\n \"\"\n ],\n \"product_type\": \"\",\n \"collections\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/products", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "products" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-c2e98af0-1911-4926-8857-be92f6011582" }, { "id": "0d6e4fa1-146a-406f-9653-4437b32ea32f", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"product_id\": \"\",\n \"product_title\": \"\",\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"variant_title\": \"\",\n \"variant_price\": \"\",\n \"sku\": \"\",\n \"variant_cost\": \"\",\n \"handling_fee\": \"\",\n \"inventory_quantity\": \"\",\n \"image_src\": \"\",\n \"compare_at_price\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"variant_title\": \"\",\n \"variant_price\": \"\",\n \"sku\": \"\",\n \"variant_cost\": \"\",\n \"handling_fee\": \"\",\n \"inventory_quantity\": \"\",\n \"image_src\": \"\",\n \"compare_at_price\": \"\"\n }\n ],\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"vendor\": \"\",\n \"product_status\": \"active\",\n \"product_tags\": [\n \"\",\n \"\"\n ],\n \"product_type\": \"\",\n \"collections\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/products", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "products" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds until the user can make another request.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-0d6e4fa1-146a-406f-9653-4437b32ea32f" }, { "id": "62cd83bb-7fed-432f-b405-bb9f6c38ecb9", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"product_id\": \"\",\n \"product_title\": \"\",\n \"variants\": [\n {\n \"variant_id\": \"\",\n \"variant_title\": \"\",\n \"variant_price\": \"\",\n \"sku\": \"\",\n \"variant_cost\": \"\",\n \"handling_fee\": \"\",\n \"inventory_quantity\": \"\",\n \"image_src\": \"\",\n \"compare_at_price\": \"\"\n },\n {\n \"variant_id\": \"\",\n \"variant_title\": \"\",\n \"variant_price\": \"\",\n \"sku\": \"\",\n \"variant_cost\": \"\",\n \"handling_fee\": \"\",\n \"inventory_quantity\": \"\",\n \"image_src\": \"\",\n \"compare_at_price\": \"\"\n }\n ],\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"vendor\": \"\",\n \"product_status\": \"active\",\n \"product_tags\": [\n \"\",\n \"\"\n ],\n \"product_type\": \"\",\n \"collections\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/products", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "products" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-62cd83bb-7fed-432f-b405-bb9f6c38ecb9" } ], "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-83462749-1abf-4955-a70f-6d2897f6531f" } ], "id": "d519d880-faf2-4039-868b-e894a91df778", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-d519d880-faf2-4039-868b-e894a91df778" }, { "name": "pps", "item": [ { "name": "Create Post-Purchase Survey (PPS) Record", "id": "e5e6f942-4698-4f09-adee-fa308be42838", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"platform\": \"custom_pps_platform\",\n \"platform_account_id\": \"custom_platform_account\",\n \"created_at\": \"\",\n \"total_price\": \"\",\n \"question_id\": \"\",\n \"question_text\": \"\",\n \"response_id\": \"\",\n \"response\": \"\",\n \"include_in_attribution\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/pps", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "pps" ] }, "description": "Ingest PPS data into Triple Whale. This endpoint allows users to upload detailed post-purchase survey information, including order-related data, questions, and responses.\n" }, "response": [ { "id": "6d98c3e1-101e-4f91-979e-3e6dfecf42c2", "name": "PPS record successfully received.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"platform\": \"custom_pps_platform\",\n \"platform_account_id\": \"custom_platform_account\",\n \"created_at\": \"\",\n \"total_price\": \"\",\n \"question_id\": \"\",\n \"question_text\": \"\",\n \"response_id\": \"\",\n \"response\": \"\",\n \"include_in_attribution\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/pps", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "pps" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-6d98c3e1-101e-4f91-979e-3e6dfecf42c2" }, { "id": "c92b9fe3-5495-4b57-88a4-80a45da786ba", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"platform\": \"custom_pps_platform\",\n \"platform_account_id\": \"custom_platform_account\",\n \"created_at\": \"\",\n \"total_price\": \"\",\n \"question_id\": \"\",\n \"question_text\": \"\",\n \"response_id\": \"\",\n \"response\": \"\",\n \"include_in_attribution\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/pps", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "pps" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-c92b9fe3-5495-4b57-88a4-80a45da786ba" }, { "id": "6620a540-b8bd-49d9-b29e-0e815917b1dd", "name": "Order Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"platform\": \"custom_pps_platform\",\n \"platform_account_id\": \"custom_platform_account\",\n \"created_at\": \"\",\n \"total_price\": \"\",\n \"question_id\": \"\",\n \"question_text\": \"\",\n \"response_id\": \"\",\n \"response\": \"\",\n \"include_in_attribution\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/pps", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "pps" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-6620a540-b8bd-49d9-b29e-0e815917b1dd" }, { "id": "98e99a23-1f48-47be-b790-d0722b727aa3", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"platform\": \"custom_pps_platform\",\n \"platform_account_id\": \"custom_platform_account\",\n \"created_at\": \"\",\n \"total_price\": \"\",\n \"question_id\": \"\",\n \"question_text\": \"\",\n \"response_id\": \"\",\n \"response\": \"\",\n \"include_in_attribution\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/pps", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "pps" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds until the user can make another request.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-98e99a23-1f48-47be-b790-d0722b727aa3" }, { "id": "6c3abfe8-a10e-4f3f-9cc3-8f4d60f22c04", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"platform\": \"custom_pps_platform\",\n \"platform_account_id\": \"custom_platform_account\",\n \"created_at\": \"\",\n \"total_price\": \"\",\n \"question_id\": \"\",\n \"question_text\": \"\",\n \"response_id\": \"\",\n \"response\": \"\",\n \"include_in_attribution\": \"\",\n \"source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/pps", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "pps" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-6c3abfe8-a10e-4f3f-9cc3-8f4d60f22c04" } ], "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-e5e6f942-4698-4f09-adee-fa308be42838" } ], "id": "e6ae4e61-d957-4f16-8422-58f4ce116ead", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-e6ae4e61-d957-4f16-8422-58f4ce116ead" }, { "name": "customers", "item": [ { "name": "Create Customer Record", "id": "9057220f-baa0-4f7b-b3de-92e3a62353f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"customer_id\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"amount_spent\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"display_name\": \"\",\n \"email_address\": \"\",\n \"email_marketing_consent_collected_from\": \"\",\n \"email_marketing_consent_opt_in_level\": \"\",\n \"email_marketing_consent_status\": \"\",\n \"email_marketing_consent_updated_at\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_order_id\": \"\",\n \"latitude\": \"\",\n \"locale\": \"\",\n \"longitude\": \"\",\n \"note\": \"\",\n \"number_of_orders\": \"\",\n \"phone\": \"\",\n \"product_subscriber_status\": \"\",\n \"sms_marketing_consent_collected_from\": \"\",\n \"sms_marketing_consent_opt_in_level\": \"\",\n \"sms_marketing_consent_updated_at\": \"\",\n \"state\": \"\",\n \"state_code\": \"\",\n \"status\": \"\",\n \"tax_exempt\": false,\n \"zip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/customers", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "customers" ] }, "description": "Ingest customer data into Triple Whale. This endpoint allows users to upload detailed customer information \u2014 including contact details, address, consent status, and purchase history metadata.\n" }, "response": [ { "id": "0a0d79b7-e024-4eac-b178-6178a3d0c886", "name": "Customer record successfully received.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"customer_id\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"amount_spent\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"display_name\": \"\",\n \"email_address\": \"\",\n \"email_marketing_consent_collected_from\": \"\",\n \"email_marketing_consent_opt_in_level\": \"\",\n \"email_marketing_consent_status\": \"\",\n \"email_marketing_consent_updated_at\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_order_id\": \"\",\n \"latitude\": \"\",\n \"locale\": \"\",\n \"longitude\": \"\",\n \"note\": \"\",\n \"number_of_orders\": \"\",\n \"phone\": \"\",\n \"product_subscriber_status\": \"\",\n \"sms_marketing_consent_collected_from\": \"\",\n \"sms_marketing_consent_opt_in_level\": \"\",\n \"sms_marketing_consent_updated_at\": \"\",\n \"state\": \"\",\n \"state_code\": \"\",\n \"status\": \"\",\n \"tax_exempt\": false,\n \"zip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/customers", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "customers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-0a0d79b7-e024-4eac-b178-6178a3d0c886" }, { "id": "96c7162d-0874-4911-b4ca-5295b82f92c2", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"customer_id\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"amount_spent\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"display_name\": \"\",\n \"email_address\": \"\",\n \"email_marketing_consent_collected_from\": \"\",\n \"email_marketing_consent_opt_in_level\": \"\",\n \"email_marketing_consent_status\": \"\",\n \"email_marketing_consent_updated_at\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_order_id\": \"\",\n \"latitude\": \"\",\n \"locale\": \"\",\n \"longitude\": \"\",\n \"note\": \"\",\n \"number_of_orders\": \"\",\n \"phone\": \"\",\n \"product_subscriber_status\": \"\",\n \"sms_marketing_consent_collected_from\": \"\",\n \"sms_marketing_consent_opt_in_level\": \"\",\n \"sms_marketing_consent_updated_at\": \"\",\n \"state\": \"\",\n \"state_code\": \"\",\n \"status\": \"\",\n \"tax_exempt\": false,\n \"zip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/customers", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "customers" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-96c7162d-0874-4911-b4ca-5295b82f92c2" }, { "id": "542ccfdb-05b9-43b9-9c12-44fe7eb188c7", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"customer_id\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"amount_spent\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"display_name\": \"\",\n \"email_address\": \"\",\n \"email_marketing_consent_collected_from\": \"\",\n \"email_marketing_consent_opt_in_level\": \"\",\n \"email_marketing_consent_status\": \"\",\n \"email_marketing_consent_updated_at\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_order_id\": \"\",\n \"latitude\": \"\",\n \"locale\": \"\",\n \"longitude\": \"\",\n \"note\": \"\",\n \"number_of_orders\": \"\",\n \"phone\": \"\",\n \"product_subscriber_status\": \"\",\n \"sms_marketing_consent_collected_from\": \"\",\n \"sms_marketing_consent_opt_in_level\": \"\",\n \"sms_marketing_consent_updated_at\": \"\",\n \"state\": \"\",\n \"state_code\": \"\",\n \"status\": \"\",\n \"tax_exempt\": false,\n \"zip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/customers", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "customers" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds until the user can make another request.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-542ccfdb-05b9-43b9-9c12-44fe7eb188c7" }, { "id": "f3304e40-0224-4260-ab23-453c9a5c9d76", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"customer_id\": \"\",\n \"platform\": \"custom-msp\",\n \"platform_account_id\": \"custom-msp\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"amount_spent\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"display_name\": \"\",\n \"email_address\": \"\",\n \"email_marketing_consent_collected_from\": \"\",\n \"email_marketing_consent_opt_in_level\": \"\",\n \"email_marketing_consent_status\": \"\",\n \"email_marketing_consent_updated_at\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"last_order_id\": \"\",\n \"latitude\": \"\",\n \"locale\": \"\",\n \"longitude\": \"\",\n \"note\": \"\",\n \"number_of_orders\": \"\",\n \"phone\": \"\",\n \"product_subscriber_status\": \"\",\n \"sms_marketing_consent_collected_from\": \"\",\n \"sms_marketing_consent_opt_in_level\": \"\",\n \"sms_marketing_consent_updated_at\": \"\",\n \"state\": \"\",\n \"state_code\": \"\",\n \"status\": \"\",\n \"tax_exempt\": false,\n \"zip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/customers", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "customers" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-f3304e40-0224-4260-ab23-453c9a5c9d76" } ], "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-9057220f-baa0-4f7b-b3de-92e3a62353f7" } ], "id": "bcca87ee-764e-44b4-98b2-1d8071e74d09", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-bcca87ee-764e-44b4-98b2-1d8071e74d09" }, { "name": "orders-enrichment", "item": [ { "name": "Enrich Orders Data", "id": "764c3a2f-4fc6-4473-a07a-8d0d47e7f522", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"custom_expenses\": \"\",\n \"custom_gross_profit\": \"\",\n \"custom_gross_sales\": \"\",\n \"custom_net_revenue\": \"\",\n \"custom_number\": \"\",\n \"custom_status\": \"\",\n \"custom_string\": \"\",\n \"ignore_order\": false,\n \"orders_quantity\": \"\",\n \"platform\": \"\",\n \"shipping_costs\": \"\",\n \"total_items_quantity\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/orders-enrichment", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "orders-enrichment" ] }, "description": "Use this endpoint to enrich existing orders\u2014such 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\u2014to update these, resend the full order via the [Orders](https://triplewhale.readme.io/reference/create-order-record) endpoint.\n" }, "response": [ { "id": "f0f12658-5759-4b3b-b40f-f72501a0b520", "name": "Order enrichment successfully received.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"custom_expenses\": \"\",\n \"custom_gross_profit\": \"\",\n \"custom_gross_sales\": \"\",\n \"custom_net_revenue\": \"\",\n \"custom_number\": \"\",\n \"custom_status\": \"\",\n \"custom_string\": \"\",\n \"ignore_order\": false,\n \"orders_quantity\": \"\",\n \"platform\": \"\",\n \"shipping_costs\": \"\",\n \"total_items_quantity\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/orders-enrichment", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "orders-enrichment" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-f0f12658-5759-4b3b-b40f-f72501a0b520" }, { "id": "076db827-e9dc-4935-84a3-c99c4a8a8d02", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"custom_expenses\": \"\",\n \"custom_gross_profit\": \"\",\n \"custom_gross_sales\": \"\",\n \"custom_net_revenue\": \"\",\n \"custom_number\": \"\",\n \"custom_status\": \"\",\n \"custom_string\": \"\",\n \"ignore_order\": false,\n \"orders_quantity\": \"\",\n \"platform\": \"\",\n \"shipping_costs\": \"\",\n \"total_items_quantity\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/orders-enrichment", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "orders-enrichment" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-076db827-e9dc-4935-84a3-c99c4a8a8d02" }, { "id": "173b4e19-64b2-4e43-99e1-cf5f41a1fec0", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"custom_expenses\": \"\",\n \"custom_gross_profit\": \"\",\n \"custom_gross_sales\": \"\",\n \"custom_net_revenue\": \"\",\n \"custom_number\": \"\",\n \"custom_status\": \"\",\n \"custom_string\": \"\",\n \"ignore_order\": false,\n \"orders_quantity\": \"\",\n \"platform\": \"\",\n \"shipping_costs\": \"\",\n \"total_items_quantity\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/orders-enrichment", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "orders-enrichment" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds until the user can make another request.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-173b4e19-64b2-4e43-99e1-cf5f41a1fec0" }, { "id": "692506bc-b868-4ec7-9184-37dd979145b8", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"order_id\": \"\",\n \"custom_expenses\": \"\",\n \"custom_gross_profit\": \"\",\n \"custom_gross_sales\": \"\",\n \"custom_net_revenue\": \"\",\n \"custom_number\": \"\",\n \"custom_status\": \"\",\n \"custom_string\": \"\",\n \"ignore_order\": false,\n \"orders_quantity\": \"\",\n \"platform\": \"\",\n \"shipping_costs\": \"\",\n \"total_items_quantity\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/orders-enrichment", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "orders-enrichment" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-692506bc-b868-4ec7-9184-37dd979145b8" } ], "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-764c3a2f-4fc6-4473-a07a-8d0d47e7f522" } ], "id": "b2fd8fb7-4706-456a-85ac-0187b28a40e1", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-b2fd8fb7-4706-456a-85ac-0187b28a40e1" }, { "name": "products-enrichment", "item": [ { "name": "Enrich Products Data", "id": "04b8fe7f-7000-4439-ae3c-f1bf6513b095", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"product_id\": \"\",\n \"variant_cost\": \"\",\n \"variant_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/products-enrichment", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "products-enrichment" ] }, "description": "Use this endpoint to enrich existing products\u2014such as adding cost data from external systems. Supported for data from platforms with a native Triple Whale integration (e.g., Shopify, BigCommerce, WooCommerce). Not supported for Custom Sales Platforms\u2014to update these, resend the full product record via the [Products](https://triplewhale.readme.io/reference/create-product-record) endpoint.\n" }, "response": [ { "id": "d80b257f-146e-4944-b061-fe9df1f8ed20", "name": "Order enrichment successfully received.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"product_id\": \"\",\n \"variant_cost\": \"\",\n \"variant_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/products-enrichment", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "products-enrichment" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-d80b257f-146e-4944-b061-fe9df1f8ed20" }, { "id": "0456db67-2453-4200-a5dc-488a8df31056", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"product_id\": \"\",\n \"variant_cost\": \"\",\n \"variant_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/products-enrichment", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "products-enrichment" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-0456db67-2453-4200-a5dc-488a8df31056" }, { "id": "d1e1a6f4-7f00-43c8-9eb4-51f5cef67554", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"product_id\": \"\",\n \"variant_cost\": \"\",\n \"variant_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/products-enrichment", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "products-enrichment" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds until the user can make another request.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-d1e1a6f4-7f00-43c8-9eb4-51f5cef67554" }, { "id": "fdf4f3f0-26a1-47a0-9199-052ff4e89a13", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"product_id\": \"\",\n \"variant_cost\": \"\",\n \"variant_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/products-enrichment", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "products-enrichment" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-fdf4f3f0-26a1-47a0-9199-052ff4e89a13" } ], "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-04b8fe7f-7000-4439-ae3c-f1bf6513b095" } ], "id": "4166463b-971f-4b1e-8b80-3a125e23f693", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-4166463b-971f-4b1e-8b80-3a125e23f693" }, { "name": "event", "item": [ { "name": "Enrich Pixel With Offline Events", "id": "d6ef66f7-2b7e-4769-b8e4-88b850644e20", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"type\": \"book_demo\",\n \"profileIdentifiers\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"externalId\": \"\"\n },\n \"eventId\": \"\",\n \"timestamp\": \"\",\n \"event_name\": \"\",\n \"source\": \"\",\n \"campaign\": \"\",\n \"ad\": \"\",\n \"adset\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/event", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "event" ] }, "description": "Send offline or server-side Pixel events\u2014such as leads, MQLs, SQLs, opportunities, book-a-demo events, or fully custom events\u2014into Triple Whale. Rate limit is 1,000 events/min. Max payload is 3 KB. When `type = custom`, you can add additional properties of type **Number, Float, String, Boolean, or Date**.\n" }, "response": [ { "id": "47128ab5-8b71-42c1-90b4-c35f71b8e99a", "name": "Pixel event successfully received.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"type\": \"book_demo\",\n \"profileIdentifiers\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"externalId\": \"\"\n },\n \"eventId\": \"\",\n \"timestamp\": \"\",\n \"event_name\": \"\",\n \"source\": \"\",\n \"campaign\": \"\",\n \"ad\": \"\",\n \"adset\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/event", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "event" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-47128ab5-8b71-42c1-90b4-c35f71b8e99a" }, { "id": "2305b7dc-164f-4d09-ac79-91ee9d052269", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"type\": \"book_demo\",\n \"profileIdentifiers\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"externalId\": \"\"\n },\n \"eventId\": \"\",\n \"timestamp\": \"\",\n \"event_name\": \"\",\n \"source\": \"\",\n \"campaign\": \"\",\n \"ad\": \"\",\n \"adset\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/event", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "event" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-2305b7dc-164f-4d09-ac79-91ee9d052269" }, { "id": "0e0fa48a-47a5-49f1-b791-9174c00e2df7", "name": "Payload Too Large", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"type\": \"book_demo\",\n \"profileIdentifiers\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"externalId\": \"\"\n },\n \"eventId\": \"\",\n \"timestamp\": \"\",\n \"event_name\": \"\",\n \"source\": \"\",\n \"campaign\": \"\",\n \"ad\": \"\",\n \"adset\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/event", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "event" ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-0e0fa48a-47a5-49f1-b791-9174c00e2df7" }, { "id": "99943fc0-f4f5-491f-bc59-4367ca0f91a5", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"type\": \"book_demo\",\n \"profileIdentifiers\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"externalId\": \"\"\n },\n \"eventId\": \"\",\n \"timestamp\": \"\",\n \"event_name\": \"\",\n \"source\": \"\",\n \"campaign\": \"\",\n \"ad\": \"\",\n \"adset\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/event", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "event" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds until another request can be made.\n", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-99943fc0-f4f5-491f-bc59-4367ca0f91a5" }, { "id": "b30fb989-7aa9-4d7e-9675-f9226c4b1450", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shop\": \"\",\n \"type\": \"book_demo\",\n \"profileIdentifiers\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"externalId\": \"\"\n },\n \"eventId\": \"\",\n \"timestamp\": \"\",\n \"event_name\": \"\",\n \"source\": \"\",\n \"campaign\": \"\",\n \"ad\": \"\",\n \"adset\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/data-in/event", "host": [ "{{baseUrl}}" ], "path": [ "data-in", "event" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-b30fb989-7aa9-4d7e-9675-f9226c4b1450" } ], "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-d6ef66f7-2b7e-4769-b8e4-88b850644e20" } ], "id": "0d95c361-110f-4893-b599-c30c83fd4cff", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-0d95c361-110f-4893-b599-c30c83fd4cff" } ], "id": "12ff9e57-8ef8-42eb-b016-dca7ac561eae", "createdAt": "2026-07-28T03:19:26.000Z", "updatedAt": "2026-07-28T03:19:26.000Z", "uid": "35240-12ff9e57-8ef8-42eb-b016-dca7ac561eae" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.triplewhale.com/api/v2/" } ] }