Sign in

v1

latestOpenAPI 3.1.02026-08-04170116.0 KB
Data In

Create Product Record

Ingest product data into Triple Whale. This endpoint allows users to upload detailed product information, including variants, tags, collections, and images.

post/data-in/products

Request body

shopstring required

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

platformstring

The platform where the product originated. To apply product-based COGS and handling fees to orders, this value must exactly match the platform value sent in the matching order records.

platform_account_idstring

The account ID associated with the platform. To apply product-based COGS and handling fees to orders, this value must exactly match the platform_account_id value sent in the matching order records.

product_idstring required

The unique identifier for the product. To use Product Analytics, matching line_items.product_id values must also be sent via the /orders endpoint.

product_titlestring required

The name or title of the product.

vendorstring

The vendor of the product.

product_statusstring

The status of the product in the connected sales platform (e.g., active, draft, archived).

product_tagsstring[]

Tags associated with the product, set in the main sales platform (e.g. Upsell, Order Credits, discount_eligible).

product_typestring

The type or category of the product.

collectionsstring[]

Collections the product belongs to.

created_atstring date-time

The time at which the product record was created. Must be provided in ISO 8601 format, with explicit timezone information (Z or +/-HH:mm offset). Offsets are supported (e.g., 2024-11-29T12:00:00+02:00). Defaults to the current time.

updated_atstring date-time

The time at which the product record was last updated. Must be provided in ISO 8601 format, with explicit timezone information (Z or +/-HH:mm offset). Offsets are supported (e.g., 2024-11-29T12:00:00+02:00). Defaults to the current time.

Example request

{
  "shop": "madisonbraids.myshopify.com",
  "platform": "magento",
  "platform_account_id": "shop_account_123",
  "product_id": "prod-123",
  "product_title": "Triple Whale T-Shirt",
  "vendor": "Triple Whale",
  "product_status": "active",
  "product_tags": [
    "discount_eligible",
    "Upsell"
  ],
  "product_type": "Clothing",
  "collections": [
    "Summer Collection",
    "T-Shirts"
  ],
  "images": [
    {
      "image_id": "img-001",
      "image_src": "https://example.com/image.jpg"
    }
  ],
  "variants": [
    {
      "variant_id": "variant-123",
      "variant_title": "Blue / Medium",
      "variant_price": 19.99,
      "sku": "SKU12345",
      "variant_cost": 8.5,
      "handling_fee": 5.5,
      "inventory_quantity": 74,
      "image_src": "https://example.com/variant-image.jpg",
      "compare_at_price": 29.99
    }
  ],
  "created_at": "2022-06-15T19:26:30.000Z",
  "updated_at": "2024-11-29T10:00:00Z"
}

Response

Product record successfully received.

successboolean
messagestring

Example response

{
  "success": true,
  "message": "product received"
}