Product Catalog
- 08 May 2024
- 2 Minutes to read
Product Catalog
- Updated on 08 May 2024
- 2 Minutes to read
Article Summary
Share feedback
Thanks for sharing your feedback!
Catalog API provides you with inserting and updating your product information. It is a different approach to harvesting product-related fields and attributes. This API enables you to overcome the latency on product-related field updates.
Three separate APIs are available that allow you to insert or update a product catalog. Each of these APIs receives different required parameters.
- Ingest API allows to insert new products into the Product Catalog.
- Update API allows to update existing products in the Product Catalog.
- Stock Update API allows to update the stock information of existing products in the Product Catalog.
Your title goes here
While the stock update API is available for all customers, the ingest and update APIs are only available for customers who have Catalog API integration. Reach out to Insider team for further details.
Your title goes here
Thanks to Catalog API, you can both ingest and update product information. However, you need to provide the required fields, which are item_id, locale, name, url, image_url, category, price, original_price, in_stock for Ingest API, and item_id and locale for Update API. For example, if you want to update the price information of an existing product, you do not need to use Ingest API endpoint since you need to send a request including all required fields along with the price. Instead, you can use Update API endpoint.
Limitations
The limitations listed below are for the whole endpoints in Catalog API.
- All functions must be executed with a simple HTTPS POST request.
- Only new data can be sent via this API. No data can be retrieved.
- Partner name and Partner token should be added to the request header. The value of the X-PARTNER-NAME header should be lowercase.
- item_id and locale should be the same as that on Web, Mobile App, or XML as the parameter value acts as an identifier.
- The attributes that will be sent in the HTTPS POST request through the API should be defined on InOne > Components > Product Catalog Management > Product Attributes.
- item_id can be as large as 32 bytes.
- The entire request must not exceed 5 MB.
- Each record in the request must not exceed 512 KB.
- Each string field in the record can be as large as 512 characters.
- item_id field in the record can be as large as 32 characters.
- locale field in the record can be as large as 64 characters.
- description field in the record can be as large as 1024 characters.
- category field in the record can be as large as 1024 characters.
- A maximum of 10.000 products can be processed in a single request.
- Partner-based item limit is 100.000 per minute.
- 300 API calls can be made in 5 minutes. This is a combined limit for all endpoints of Catalog API. For example, if you make 200 API requests to the Ingest endpoint within 5-minute periods, you can make 400 API requests to the Stock update endpoint during that period.
- Throttling due to rate and item limits results in API responses with 429 status code.