{"openapi":"3.0.0","info":{"version":"1.0.0","title":"Pipelines API - Ecommerce Events","description":"# Ecommerce Semantic Events\n\nThis document describes semantic events for ecommerce in the Customer.io Pipelines API.\n\nSemantic events are special payloads for our `track` endpoint based on the `event` name. When you send an ecommerce event with a specific name (like `Product Viewed` or `Order Completed`), Customer.io and downstream integrations recognize it and handle it appropriately.\n\nWith semantic events, you can set up your events and they'll work with any of our destinations that support ecommerce events.\n\n# Server addresses: US and EU\nCustomer.io hosts services in the United States (US) and European Union. Select the appropriate server address for your region.\n\n| Region | Server Address |\n| :-- | :-- |\n| US | https://cdp.customer.io |\n| EU | https://cdp-eu.customer.io |\n\nIf you're in our EU region, you'll need to specify the EU URL when you initialize our server-side libraries.\n\n# Authentication\n\nThe Data Pipelines API uses basic authentication with your API key as the username and a blank password.\n"},"servers":[{"url":"https://cdp.customer.io/v1","description":"The base URL for all Data Pipelines calls in our United States (US) region."},{"url":"https://cdp-eu.customer.io/v1","description":"The base URL for all Data Pipelines calls in our European Union (EU) region."}],"paths":{"/track":{"post":{"operationId":"track_ecommerce_event","summary":"Track Ecommerce Event","description":"Send ecommerce semantic events to track customer shopping behavior, from browsing products to completing orders.\n\nThese semantic events follow standard structures recognized by Customer.io and downstream integrations for ecommerce analytics.\n","security":[{"Basic-Auth":[]}],"parameters":[{"name":"X-Strict-Mode","in":"header","description":"When set to `1`, enables strict validation that returns proper HTTP error codes (400/401) for validation failures. When not set or set to any other value, the API operates in permissive mode, logging errors but returning HTTP 200.\n","required":false,"schema":{"type":"string","enum":["1"]},"example":"1"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/product_list_viewed_event"},{"$ref":"#/components/schemas/product_list_filtered_event"},{"$ref":"#/components/schemas/products_searched_event"},{"$ref":"#/components/schemas/promotion_viewed_event"},{"$ref":"#/components/schemas/promotion_clicked_event"},{"$ref":"#/components/schemas/product_clicked_event"},{"$ref":"#/components/schemas/product_viewed_event"},{"$ref":"#/components/schemas/product_added_event"},{"$ref":"#/components/schemas/product_removed_event"},{"$ref":"#/components/schemas/cart_viewed_event"},{"$ref":"#/components/schemas/checkout_started_event"},{"$ref":"#/components/schemas/checkout_step_viewed_event"},{"$ref":"#/components/schemas/checkout_step_completed_event"},{"$ref":"#/components/schemas/payment_info_entered_event"},{"$ref":"#/components/schemas/order_updated_event"},{"$ref":"#/components/schemas/order_completed_event"},{"$ref":"#/components/schemas/order_refunded_event"},{"$ref":"#/components/schemas/order_cancelled_event"},{"$ref":"#/components/schemas/coupon_entered_event"},{"$ref":"#/components/schemas/coupon_applied_event"},{"$ref":"#/components/schemas/coupon_denied_event"},{"$ref":"#/components/schemas/coupon_removed_event"},{"$ref":"#/components/schemas/product_added_to_wishlist_event"},{"$ref":"#/components/schemas/product_removed_from_wishlist_event"},{"$ref":"#/components/schemas/wishlist_product_added_to_cart_event"},{"$ref":"#/components/schemas/product_shared_event"},{"$ref":"#/components/schemas/cart_shared_event"},{"$ref":"#/components/schemas/product_reviewed_event"}]}}}},"responses":{"200":{"$ref":"#/components/responses/200"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"}}}}},"components":{"schemas":{"product":{"x-scalar-ignore":true,"title":"Product","type":"object","description":"An individual product.","properties":{"product_id":{"type":"string","description":"The product ID.","example":"coolshoes-123"},"sku":{"type":"string","description":"The stock keeping unit (SKU) of the product.","example":"abc-123-xyz"},"category":{"type":"string","description":"The product category.","example":"shoes"},"name":{"type":"string","description":"The name of the product.","example":"Cool Shoes"},"brand":{"type":"string","description":"The brand associated with the product.","example":"A Shoe Brand"},"variant":{"type":"string","description":"The variant of the product, if applicable.","example":"red"},"price":{"type":"number","description":"The price of the product.","example":139.99},"quantity":{"type":"integer","description":"The quantity of the product.","example":1},"coupon":{"type":"string","description":"The coupon code associated with the product.","example":"NEWUSER20"},"position":{"type":"number","description":"The position of the product in the list.","example":3},"url":{"type":"string","description":"The URL of the product page.","example":"https://www.example.com/product/123"},"image_url":{"type":"string","description":"The URL of the product image.","example":"https://www.example.com/product/123.jpg"}}},"filter_item":{"x-scalar-ignore":true,"title":"Filter Item","type":"object","properties":{"type":{"type":"string","description":"The ID of the filter type.","example":"color"},"value":{"type":"string","description":"The ID of the value of the filter.","example":"red"}}},"sort_item":{"x-scalar-ignore":true,"title":"Sort Item","type":"object","properties":{"type":{"type":"string","description":"The ID of the sort type.","example":"price"},"value":{"type":"string","description":"The ID of the selection type, like `ascending` or `descending`.","example":"ascending"}}},"promotion":{"x-scalar-ignore":true,"title":"Promotion","type":"object","description":"Describes a promotional offer.","properties":{"promotion_id":{"type":"string","description":"The ID of the promotion.","example":"promo_123"},"creative":{"type":"string","description":"The creative content ID associated with the promotion.","example":"top_banner_2"},"name":{"type":"string","description":"The name of the promotion.","example":"summer_sale"},"position":{"type":"string","description":"The position of the promotion.","example":"banner_slot_1"}}},"context":{"x-scalar-ignore":true,"title":"Context","type":"object","description":"Additional context about the event, such as device information, IP address, user agent, etc. Most of our libraries collect this automatically.","additionalProperties":true},"integrations":{"x-scalar-ignore":true,"title":"Integrations","type":"object","description":"Control which integrations receive this event. By default, all enabled integrations receive events.","additionalProperties":true,"example":{"All":false,"Mixpanel":true,"Segment":true}},"product_list_viewed_event":{"title":"Product List Viewed Event","oneOf":[{"title":"Known User - Product List Viewed","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product List Viewed"],"description":"The event name. Must be `Product List Viewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the product list viewed.","properties":{"list_id":{"type":"string","description":"The product list a person viewed.","example":"all_shoes"},"category":{"type":"string","description":"The product category a person viewed.","example":"shoes"},"products":{"type":"array","description":"The products displayed in the product list. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Product List Viewed","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product List Viewed"],"description":"The event name. Must be `Product List Viewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the product list viewed.","properties":{"list_id":{"type":"string","description":"The product list a person viewed.","example":"all_shoes"},"category":{"type":"string","description":"The product category a person viewed.","example":"shoes"},"products":{"type":"array","description":"The products displayed in the product list. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"product_list_filtered_event":{"title":"Product List Filtered Event","oneOf":[{"title":"Known User - Product List Filtered","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product List Filtered"],"description":"The event name. Must be `Product List Filtered` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the filtered product list.","properties":{"list_id":{"type":"string","description":"The product list a person filtered.","example":"all_shoes"},"category":{"type":"string","description":"The product category a person viewed.","example":"shoes"},"products":{"type":"array","description":"The products displayed in the product list. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}},"filters":{"type":"array","description":"The filters a person applied to the product list, where each object in the array is a different filter.","items":{"$ref":"#/components/schemas/filter_item"}},"sorts":{"type":"array","description":"The sorts a person applied to the product list, where each object in the array is a different sort.","items":{"$ref":"#/components/schemas/sort_item"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Product List Filtered","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product List Filtered"],"description":"The event name. Must be `Product List Filtered` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the filtered product list.","properties":{"list_id":{"type":"string","description":"The product list a person filtered.","example":"all_shoes"},"category":{"type":"string","description":"The product category a person viewed.","example":"shoes"},"products":{"type":"array","description":"The products displayed in the product list. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}},"filters":{"type":"array","description":"The filters a person applied to the product list, where each object in the array is a different filter.","items":{"$ref":"#/components/schemas/filter_item"}},"sorts":{"type":"array","description":"The sorts a person applied to the product list, where each object in the array is a different sort.","items":{"$ref":"#/components/schemas/sort_item"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"products_searched_event":{"title":"Products Searched Event","oneOf":[{"title":"Known User - Products Searched","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Products Searched"],"description":"The event name. Must be `Products Searched` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the product search.","properties":{"query":{"type":"string","description":"The search query the customer entered.","example":"pepperoni pizza"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Products Searched","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Products Searched"],"description":"The event name. Must be `Products Searched` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the product search.","properties":{"query":{"type":"string","description":"The search query the customer entered.","example":"pepperoni pizza"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"promotion_viewed_event":{"title":"Promotion Viewed Event","oneOf":[{"title":"Known User - Promotion Viewed","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Promotion Viewed"],"description":"The event name. Must be `Promotion Viewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/promotion"},{"type":"object","additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Promotion Viewed","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Promotion Viewed"],"description":"The event name. Must be `Promotion Viewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/promotion"},{"type":"object","additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"promotion_clicked_event":{"title":"Promotion Clicked Event","oneOf":[{"title":"Known User - Promotion Clicked","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Promotion Clicked"],"description":"The event name. Must be `Promotion Clicked` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/promotion"},{"type":"object","additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Promotion Clicked","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Promotion Clicked"],"description":"The event name. Must be `Promotion Clicked` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/promotion"},{"type":"object","additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"product_clicked_event":{"title":"Product Clicked Event","oneOf":[{"title":"Known User - Product Clicked","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Clicked"],"description":"The event name. Must be `Product Clicked` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"value":{"type":"number","description":"The total value of the product, after multiplying by quantity.","example":119.99}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Product Clicked","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Clicked"],"description":"The event name. Must be `Product Clicked` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"value":{"type":"number","description":"The total value of the product, after multiplying by quantity.","example":119.99}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"product_viewed_event":{"title":"Product Viewed Event","oneOf":[{"title":"Known User - Product Viewed","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Viewed"],"description":"The event name. Must be `Product Viewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"value":{"type":"number","description":"The total value of the product, after multiplying by quantity.","example":119.99}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Product Viewed","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Viewed"],"description":"The event name. Must be `Product Viewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"value":{"type":"number","description":"The total value of the product, after multiplying by quantity.","example":119.99}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"product_added_event":{"title":"Product Added Event","oneOf":[{"title":"Known User - Product Added","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Added"],"description":"The event name. Must be `Product Added` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"cart_id":{"type":"string","description":"The cart ID the product was added to.","example":"cool_persons_cart_123"}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Product Added","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Added"],"description":"The event name. Must be `Product Added` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"cart_id":{"type":"string","description":"The cart ID the product was added to.","example":"cool_persons_cart_123"}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"product_removed_event":{"title":"Product Removed Event","oneOf":[{"title":"Known User - Product Removed","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Removed"],"description":"The event name. Must be `Product Removed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"cart_id":{"type":"string","description":"The cart ID the product was removed from.","example":"cool_persons_cart_123"}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Product Removed","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Removed"],"description":"The event name. Must be `Product Removed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"cart_id":{"type":"string","description":"The cart ID the product was removed from.","example":"cool_persons_cart_123"}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"cart_viewed_event":{"title":"Cart Viewed Event","oneOf":[{"title":"Known User - Cart Viewed","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Cart Viewed"],"description":"The event name. Must be `Cart Viewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the cart.","properties":{"cart_id":{"type":"string","description":"The cart ID a person viewed.","example":"cool_persons_cart_123"},"products":{"type":"array","description":"The products in the cart. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Cart Viewed","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Cart Viewed"],"description":"The event name. Must be `Cart Viewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the cart.","properties":{"cart_id":{"type":"string","description":"The cart ID a person viewed.","example":"cool_persons_cart_123"},"products":{"type":"array","description":"The products in the cart. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"checkout_started_event":{"title":"Checkout Started Event","oneOf":[{"title":"Known User - Checkout Started","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Checkout Started"],"description":"The event name. Must be `Checkout Started` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the checkout.","properties":{"order_id":{"type":"string","description":"The cart ID a person viewed.","example":"cool_persons_cart_123"},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"value":{"type":"number","description":"The expected total revenue of the transaction calculated with discounts/coupons.","example":119.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"The products in the cart. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Checkout Started","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Checkout Started"],"description":"The event name. Must be `Checkout Started` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the checkout.","properties":{"order_id":{"type":"string","description":"The cart ID a person viewed.","example":"cool_persons_cart_123"},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"value":{"type":"number","description":"The expected total revenue of the transaction calculated with discounts/coupons.","example":119.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"The products in the cart. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"checkout_step_viewed_event":{"title":"Checkout Step Viewed Event","oneOf":[{"title":"Known User - Checkout Step Viewed","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Checkout Step Viewed"],"description":"The event name. Must be `Checkout Step Viewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the checkout step.","properties":{"checkout_id":{"type":"string","description":"The checkout/transaction ID.","example":"cool_persons_checkout_123"},"step":{"type":"integer","description":"The step number of the checkout process.","example":2},"shipping_method":{"type":"string","description":"The shipping method selected by the user.","example":"ground"},"payment_method":{"type":"string","description":"The payment method selected by the user.","example":"Visa"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Checkout Step Viewed","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Checkout Step Viewed"],"description":"The event name. Must be `Checkout Step Viewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the checkout step.","properties":{"checkout_id":{"type":"string","description":"The checkout/transaction ID.","example":"cool_persons_checkout_123"},"step":{"type":"integer","description":"The step number of the checkout process.","example":2},"shipping_method":{"type":"string","description":"The shipping method selected by the user.","example":"ground"},"payment_method":{"type":"string","description":"The payment method selected by the user.","example":"Visa"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"checkout_step_completed_event":{"title":"Checkout Step Completed Event","oneOf":[{"title":"Known User - Checkout Step Completed","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Checkout Step Completed"],"description":"The event name. Must be `Checkout Step Completed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the completed checkout step.","properties":{"checkout_id":{"type":"string","description":"The checkout/transaction ID.","example":"cool_persons_checkout_123"},"step":{"type":"integer","description":"The step number of the checkout process.","example":2},"shipping_method":{"type":"string","description":"The shipping method selected by the user.","example":"ground"},"payment_method":{"type":"string","description":"The payment method selected by the user.","example":"Visa"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Checkout Step Completed","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Checkout Step Completed"],"description":"The event name. Must be `Checkout Step Completed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the completed checkout step.","properties":{"checkout_id":{"type":"string","description":"The checkout/transaction ID.","example":"cool_persons_checkout_123"},"step":{"type":"integer","description":"The step number of the checkout process.","example":2},"shipping_method":{"type":"string","description":"The shipping method selected by the user.","example":"ground"},"payment_method":{"type":"string","description":"The payment method selected by the user.","example":"Visa"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"payment_info_entered_event":{"title":"Payment Info Entered Event","oneOf":[{"title":"Known User - Payment Info Entered","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Payment Info Entered"],"description":"The event name. Must be `Payment Info Entered` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the payment information.","properties":{"order_id":{"type":"string","description":"The order ID.","example":"order123"},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"The products in the cart. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Payment Info Entered","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Payment Info Entered"],"description":"The event name. Must be `Payment Info Entered` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the payment information.","properties":{"order_id":{"type":"string","description":"The order ID.","example":"order123"},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"The products in the cart. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"order_updated_event":{"title":"Order Updated Event","oneOf":[{"title":"Known User - Order Updated","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Order Updated"],"description":"The event name. Must be `Order Updated` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the updated order.","properties":{"order_id":{"type":"string","description":"The order ID.","example":"order123"},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"The products in the order. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Order Updated","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Order Updated"],"description":"The event name. Must be `Order Updated` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the updated order.","properties":{"order_id":{"type":"string","description":"The order ID.","example":"order123"},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"The products in the order. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"order_completed_event":{"title":"Order Completed Event","oneOf":[{"title":"Known User - Order Completed","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Order Completed"],"description":"The event name. Must be `Order Completed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the completed order.","properties":{"order_id":{"type":"string","description":"The order ID.","example":"order123"},"checkout_id":{"type":"string","description":"The checkout/transaction ID.","example":"checkout123"},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"total":{"type":"number","description":"The total amount of the order.","example":119.99},"subtotal":{"type":"number","description":"The order total after discounts but before taxes and shipping.","example":119.99},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"The products in the order. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Order Completed","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Order Completed"],"description":"The event name. Must be `Order Completed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the completed order.","properties":{"order_id":{"type":"string","description":"The order ID.","example":"order123"},"checkout_id":{"type":"string","description":"The checkout/transaction ID.","example":"checkout123"},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"total":{"type":"number","description":"The total amount of the order.","example":119.99},"subtotal":{"type":"number","description":"The order total after discounts but before taxes and shipping.","example":119.99},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"The products in the order. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"order_refunded_event":{"title":"Order Refunded Event","oneOf":[{"title":"Known User - Order Refunded","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Order Refunded"],"description":"The event name. Must be `Order Refunded` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the refunded order.","properties":{"order_id":{"type":"string","description":"The order ID.","example":"order123"},"checkout_id":{"type":"string","description":"The checkout/transaction ID.","example":"checkout123"},"total":{"type":"number","description":"The total amount refunded.","example":119.99},"subtotal":{"type":"number","description":"The order total after discounts but before taxes and shipping.","example":119.99},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"All items refunded from the previous order_completed event. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Order Refunded","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Order Refunded"],"description":"The event name. Must be `Order Refunded` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the refunded order.","properties":{"order_id":{"type":"string","description":"The order ID.","example":"order123"},"checkout_id":{"type":"string","description":"The checkout/transaction ID.","example":"checkout123"},"total":{"type":"number","description":"The total amount refunded.","example":119.99},"subtotal":{"type":"number","description":"The order total after discounts but before taxes and shipping.","example":119.99},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"All items refunded from the previous order_completed event. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"order_cancelled_event":{"title":"Order Cancelled Event","oneOf":[{"title":"Known User - Order Cancelled","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Order Cancelled"],"description":"The event name. Must be `Order Cancelled` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the cancelled order.","properties":{"order_id":{"type":"string","description":"The cancelled order ID.","example":"order123"},"total":{"type":"number","description":"The total amount of the order.","example":119.99},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"The products in the cancelled order. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Order Cancelled","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Order Cancelled"],"description":"The event name. Must be `Order Cancelled` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the cancelled order.","properties":{"order_id":{"type":"string","description":"The cancelled order ID.","example":"order123"},"total":{"type":"number","description":"The total amount of the order.","example":119.99},"affiliation":{"type":"string","description":"The store or affiliation from the transaction occurred from.","example":"Shopify"},"revenue":{"type":"number","description":"The total revenue of the transaction without discounts, coupons, shipping, and tax.","example":139.99},"shipping":{"type":"number","description":"The total shipping cost of the transaction.","example":5},"tax":{"type":"number","description":"The tax associated with the transaction.","example":10},"discount":{"type":"number","description":"The total discount applied to the transaction.","example":20},"coupon":{"type":"string","description":"The coupon code associated with the transaction.","example":"NEWUSER20"},"currency":{"type":"string","description":"The currency of the transaction.","example":"USD"},"products":{"type":"array","description":"The products in the cancelled order. Each object in the array represents a product.","items":{"$ref":"#/components/schemas/product"}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"coupon_entered_event":{"title":"Coupon Entered Event","oneOf":[{"title":"Known User - Coupon Entered","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Coupon Entered"],"description":"The event name. Must be `Coupon Entered` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the coupon entered.","properties":{"order_id":{"type":"string","description":"The order/transaction the coupon applies to (if applicable).","example":"order123"},"cart_id":{"type":"string","description":"The ID of the cart that the coupon applies to (if applicable).","example":"cool_persons_cart_123"},"coupon_id":{"type":"string","description":"The coupon ID the person entered.","example":"NEWUSER20"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Coupon Entered","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Coupon Entered"],"description":"The event name. Must be `Coupon Entered` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the coupon entered.","properties":{"order_id":{"type":"string","description":"The order/transaction the coupon applies to (if applicable).","example":"order123"},"cart_id":{"type":"string","description":"The ID of the cart that the coupon applies to (if applicable).","example":"cool_persons_cart_123"},"coupon_id":{"type":"string","description":"The coupon ID the person entered.","example":"NEWUSER20"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"coupon_applied_event":{"title":"Coupon Applied Event","oneOf":[{"title":"Known User - Coupon Applied","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Coupon Applied"],"description":"The event name. Must be `Coupon Applied` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the applied coupon.","properties":{"order_id":{"type":"string","description":"The order/transaction the coupon applies to (if applicable).","example":"order123"},"cart_id":{"type":"string","description":"The ID of the cart that the coupon applies to (if applicable).","example":"cool_persons_cart_123"},"coupon_id":{"type":"string","description":"The coupon ID the person entered.","example":"NEWUSER20"},"coupon_name":{"type":"string","description":"The name of the coupon, if applicable.","example":"NEWUSER20"},"discount":{"type":"number","description":"The discount applied through the coupon. This is the amount subtracted from the total in other transaction events.","example":20}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Coupon Applied","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Coupon Applied"],"description":"The event name. Must be `Coupon Applied` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the applied coupon.","properties":{"order_id":{"type":"string","description":"The order/transaction the coupon applies to (if applicable).","example":"order123"},"cart_id":{"type":"string","description":"The ID of the cart that the coupon applies to (if applicable).","example":"cool_persons_cart_123"},"coupon_id":{"type":"string","description":"The coupon ID the person entered.","example":"NEWUSER20"},"coupon_name":{"type":"string","description":"The name of the coupon, if applicable.","example":"NEWUSER20"},"discount":{"type":"number","description":"The discount applied through the coupon. This is the amount subtracted from the total in other transaction events.","example":20}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"coupon_denied_event":{"title":"Coupon Denied Event","oneOf":[{"title":"Known User - Coupon Denied","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Coupon Denied"],"description":"The event name. Must be `Coupon Denied` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the denied coupon.","properties":{"order_id":{"type":"string","description":"The order/transaction the coupon applies to (if applicable).","example":"order123"},"cart_id":{"type":"string","description":"The ID of the cart that the coupon applies to (if applicable).","example":"cool_persons_cart_123"},"coupon_id":{"type":"string","description":"The coupon ID the person entered.","example":"NEWUSER20"},"coupon_name":{"type":"string","description":"The name of the coupon, if applicable.","example":"NEWUSER20"},"reason":{"type":"string","description":"The reason the coupon was denied.","example":"Coupon expired"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Coupon Denied","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Coupon Denied"],"description":"The event name. Must be `Coupon Denied` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the denied coupon.","properties":{"order_id":{"type":"string","description":"The order/transaction the coupon applies to (if applicable).","example":"order123"},"cart_id":{"type":"string","description":"The ID of the cart that the coupon applies to (if applicable).","example":"cool_persons_cart_123"},"coupon_id":{"type":"string","description":"The coupon ID the person entered.","example":"NEWUSER20"},"coupon_name":{"type":"string","description":"The name of the coupon, if applicable.","example":"NEWUSER20"},"reason":{"type":"string","description":"The reason the coupon was denied.","example":"Coupon expired"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"coupon_removed_event":{"title":"Coupon Removed Event","oneOf":[{"title":"Known User - Coupon Removed","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Coupon Removed"],"description":"The event name. Must be `Coupon Removed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the removed coupon.","properties":{"order_id":{"type":"string","description":"The order/transaction the coupon applies to (if applicable).","example":"order123"},"cart_id":{"type":"string","description":"The ID of the cart that the coupon applies to (if applicable).","example":"cool_persons_cart_123"},"coupon_id":{"type":"string","description":"The coupon ID the person entered.","example":"NEWUSER20"},"coupon_name":{"type":"string","description":"The name of the coupon, if applicable.","example":"NEWUSER20"},"discount":{"type":"number","description":"The discount applied through the coupon. This is the amount subtracted from the total in other transaction events.","example":20}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Coupon Removed","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Coupon Removed"],"description":"The event name. Must be `Coupon Removed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the removed coupon.","properties":{"order_id":{"type":"string","description":"The order/transaction the coupon applies to (if applicable).","example":"order123"},"cart_id":{"type":"string","description":"The ID of the cart that the coupon applies to (if applicable).","example":"cool_persons_cart_123"},"coupon_id":{"type":"string","description":"The coupon ID the person entered.","example":"NEWUSER20"},"coupon_name":{"type":"string","description":"The name of the coupon, if applicable.","example":"NEWUSER20"},"discount":{"type":"number","description":"The discount applied through the coupon. This is the amount subtracted from the total in other transaction events.","example":20}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"product_added_to_wishlist_event":{"title":"Product Added to Wishlist Event","oneOf":[{"title":"Known User - Product Added to Wishlist","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Added to Wishlist"],"description":"The event name. Must be `Product Added to Wishlist` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"wishlist_id":{"type":"string","description":"The ID of the wishlist that the product applies to.","example":"cool_persons_wishlist_123"},"wishlist_name":{"type":"string","description":"The name of the wishlist that the product applies to.","example":"Cool Person's Wishlist"}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Product Added to Wishlist","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Added to Wishlist"],"description":"The event name. Must be `Product Added to Wishlist` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"wishlist_id":{"type":"string","description":"The ID of the wishlist that the product applies to.","example":"cool_persons_wishlist_123"},"wishlist_name":{"type":"string","description":"The name of the wishlist that the product applies to.","example":"Cool Person's Wishlist"}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"product_removed_from_wishlist_event":{"title":"Product Removed from Wishlist Event","oneOf":[{"title":"Known User - Product Removed from Wishlist","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Removed from Wishlist"],"description":"The event name. Must be `Product Removed from Wishlist` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"wishlist_id":{"type":"string","description":"The ID of the wishlist that the product applies to.","example":"cool_persons_wishlist_123"},"wishlist_name":{"type":"string","description":"The name of the wishlist that the product applies to.","example":"Cool Person's Wishlist"}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Product Removed from Wishlist","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Removed from Wishlist"],"description":"The event name. Must be `Product Removed from Wishlist` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"wishlist_id":{"type":"string","description":"The ID of the wishlist that the product applies to.","example":"cool_persons_wishlist_123"},"wishlist_name":{"type":"string","description":"The name of the wishlist that the product applies to.","example":"Cool Person's Wishlist"}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"wishlist_product_added_to_cart_event":{"title":"Wishlist Product Added to Cart Event","oneOf":[{"title":"Known User - Wishlist Product Added to Cart","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Wishlist Product Added to Cart"],"description":"The event name. Must be `Wishlist Product Added to Cart` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"wishlist_id":{"type":"string","description":"The ID of the wishlist that the product applies to.","example":"cool_persons_wishlist_123"},"wishlist_name":{"type":"string","description":"The name of the wishlist that the product applies to.","example":"Cool Person's Wishlist"},"cart_id":{"type":"string","description":"The ID of the cart that the product was added to.","example":"cool_persons_cart_123"}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Wishlist Product Added to Cart","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Wishlist Product Added to Cart"],"description":"The event name. Must be `Wishlist Product Added to Cart` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"wishlist_id":{"type":"string","description":"The ID of the wishlist that the product applies to.","example":"cool_persons_wishlist_123"},"wishlist_name":{"type":"string","description":"The name of the wishlist that the product applies to.","example":"Cool Person's Wishlist"},"cart_id":{"type":"string","description":"The ID of the cart that the product was added to.","example":"cool_persons_cart_123"}},"additionalProperties":{"description":"Additional custom properties for the event."}}]},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"product_shared_event":{"title":"Product Shared Event","oneOf":[{"title":"Known User - Product Shared","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Shared"],"description":"The event name. Must be `Product Shared` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the shared product.","properties":{"share_via":{"type":"string","description":"The channel the product was shared through.","example":"email"},"share_message":{"type":"string","description":"The message the customer sent with the share.","example":"Check out these cool shoes!"},"recipient":{"type":"string","description":"The person the product was shared with.","example":"friendOfcool.person@example.com"},"product_id":{"type":"string","description":"The product ID.","example":"coolshoes-123"},"sku":{"type":"string","description":"The stock keeping unit (SKU) of the product.","example":"abc-123-xyz"},"category":{"type":"string","description":"The product category.","example":"shoes"},"name":{"type":"string","description":"The name of the product.","example":"Cool Shoes"},"brand":{"type":"string","description":"The brand associated with the product.","example":"A Shoe Brand"},"variant":{"type":"string","description":"The variant of the product, if applicable.","example":"red"},"price":{"type":"number","description":"The price of the product.","example":139.99},"url":{"type":"string","description":"The URL of the product page.","example":"https://www.example.com/product/123"},"image_url":{"type":"string","description":"The URL of the product image.","example":"https://www.example.com/product/123.jpg"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Product Shared","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Shared"],"description":"The event name. Must be `Product Shared` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the shared product.","properties":{"share_via":{"type":"string","description":"The channel the product was shared through.","example":"email"},"share_message":{"type":"string","description":"The message the customer sent with the share.","example":"Check out these cool shoes!"},"recipient":{"type":"string","description":"The person the product was shared with.","example":"friendOfcool.person@example.com"},"product_id":{"type":"string","description":"The product ID.","example":"coolshoes-123"},"sku":{"type":"string","description":"The stock keeping unit (SKU) of the product.","example":"abc-123-xyz"},"category":{"type":"string","description":"The product category.","example":"shoes"},"name":{"type":"string","description":"The name of the product.","example":"Cool Shoes"},"brand":{"type":"string","description":"The brand associated with the product.","example":"A Shoe Brand"},"variant":{"type":"string","description":"The variant of the product, if applicable.","example":"red"},"price":{"type":"number","description":"The price of the product.","example":139.99},"url":{"type":"string","description":"The URL of the product page.","example":"https://www.example.com/product/123"},"image_url":{"type":"string","description":"The URL of the product image.","example":"https://www.example.com/product/123.jpg"}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"cart_shared_event":{"title":"Cart Shared Event","oneOf":[{"title":"Known User - Cart Shared","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Cart Shared"],"description":"The event name. Must be `Cart Shared` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the shared cart.","properties":{"share_via":{"type":"string","description":"The channel the cart was shared through.","example":"email"},"share_message":{"type":"string","description":"The message the customer sent with the share.","example":"Check out my cart!"},"recipient":{"type":"string","description":"The person the cart was shared with.","example":"friendOfcool.person@example.com"},"cart_id":{"type":"string","description":"The shopping cart ID.","example":"cool_persons_cart_123"},"products":{"type":"array","description":"An array of product IDs contained in the shared cart.","items":{"type":"object","properties":{"product_id":{"type":"string","description":"The product ID.","example":"coolshoes-123"}}}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Cart Shared","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Cart Shared"],"description":"The event name. Must be `Cart Shared` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the shared cart.","properties":{"share_via":{"type":"string","description":"The channel the cart was shared through.","example":"email"},"share_message":{"type":"string","description":"The message the customer sent with the share.","example":"Check out my cart!"},"recipient":{"type":"string","description":"The person the cart was shared with.","example":"friendOfcool.person@example.com"},"cart_id":{"type":"string","description":"The shopping cart ID.","example":"cool_persons_cart_123"},"products":{"type":"array","description":"An array of product IDs contained in the shared cart.","items":{"type":"object","properties":{"product_id":{"type":"string","description":"The product ID.","example":"coolshoes-123"}}}}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]},"product_reviewed_event":{"title":"Product Reviewed Event","oneOf":[{"title":"Known User - Product Reviewed","type":"object","required":["userId","event","type"],"properties":{"userId":{"type":"string","description":"The unique identifier for the user.","example":"user_12345"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Reviewed"],"description":"The event name. Must be `Product Reviewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the product review.","properties":{"product_id":{"type":"string","description":"The product ID.","example":"coolshoes-123"},"review_id":{"type":"string","description":"The ID of the review.","example":"review_123"},"review_body":{"type":"string","description":"The body of the review.","example":"These shoes are great!"},"rating":{"type":"integer","description":"The rating the customer gave the product.","example":5}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}},{"title":"Anonymous User - Product Reviewed","type":"object","required":["anonymousId","event","type"],"properties":{"anonymousId":{"type":"string","description":"The anonymous identifier for the user.","example":"anon_abc123xyz"},"type":{"type":"string","enum":["track"],"description":"The event type. Must be `track` for event calls."},"event":{"type":"string","enum":["Product Reviewed"],"description":"The event name. Must be `Product Reviewed` for this semantic event."},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 timestamp when the event occurred. If not provided, Customer.io records the time when the request is received.","example":"2024-01-15T10:30:00.000Z"},"properties":{"type":"object","description":"Properties describing the product review.","properties":{"product_id":{"type":"string","description":"The product ID.","example":"coolshoes-123"},"review_id":{"type":"string","description":"The ID of the review.","example":"review_123"},"review_body":{"type":"string","description":"The body of the review.","example":"These shoes are great!"},"rating":{"type":"integer","description":"The rating the customer gave the product.","example":5}},"additionalProperties":{"description":"Additional custom properties for the event."}},"context":{"$ref":"#/components/schemas/context"},"integrations":{"$ref":"#/components/schemas/integrations"}}}]}},"securitySchemes":{"Basic-Auth":{"type":"http","scheme":"basic","description":"The Data Pipelines API uses a basic authentication scheme with your API key. Use the API Key as the username and leave the password blank.\n"}},"responses":{"200":{"description":"A successful request returns an empty object response.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid or malformed request.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"errors":{"type":"array","description":"An array of errors.","items":{"type":"string","description":"Error descriptions."}}}}}}}}},"401":{"description":"Unauthorized request. Make sure that you provided the right credentials."}}}}