Product Catalog API
Share your product catalog to enable services that requires up to date product information. The product catalog is required for services like product recommendations and product analytics.
Add this source
Log into your engage account
Go to Data Platform > Integrations and select the Product Catalog API
Follow the instructions to get started
Use this source
Once activated, you may start to send products to us. The endpoint accept single products or batches of maximum 250 products at a time. Check the API Reference for specifics and code examples in most languages.
Product Catalog API
POST
https://api-dot-solutionsone-211314.ew.r.appspot.com/v1/products/catalog
Upload your product catalog to engage. Note that only base products are supported at the moment, no need to add variants. Send one product per call. Sending two identical product_ids will overwrite the product.
Query Parameters
Name | Type | Description |
---|---|---|
average_rating | number | 3.0 |
categories | string | "Category A, Category B" |
currency | string | "USD" |
description | string | "A product description" |
image | string | URL to a main product image |
image2 | string | URL to a secondary product image |
link | string | URL to product page |
name | string | The product name / title |
on_sale | boolean | True / False |
product_id | integer | 100078 |
price | number | 79.99 |
rating_count | number | 7 |
sku | string | "ME3452" |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | "Bearer eyJhbGciOiJIUzI1NiIssdzNCw..." Log in to retrieve your user token. |
Only base products are required to be uploaded as part of the product catalog. Product variants are currently not supported.
Example call
Data formats
Dates & Time
Format | Example |
YYYY-MM-DD HH:MM:SS+HH:MM | 2020-01-01 04:23:01+04:00 |
YYYY-MM-DD HH:MM:SS.ffffff | 2020-01-01 04:23:01.000384 |
YYYY-MM-DD HH:MM:SS | 2020-01-01 04:23:01 |
YYYY-MM-DDTHH:MM:SS+HH:MM | 2020-01-01T04:23:01+04:00 |
YYYY-MM-DDTHH:MM:SS.ffffff | 2020-01-01T04:23:01.000384 |
YYYY-MM-DDTHH:MM:SS | 2020-01-01T04:23:01 |
Generic format supported
Last updated