The Catalog API allows you to insert and update product information, providing an alternative to harvesting product-related fields and attributes while ensuring that product field updates are reflected quickly and reliably.
The available Catalog APIs
The Catalog API includes two separate APIs with different required parameters:
- Ingest API inserts new products into the Product Catalog.
- Update API updates existing products in the Product Catalog.
Thanks to the 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, and in_stock for the Ingest API, and item_id and locale for the Update API. For example, if you want to update the price information of an existing product, you do not need to use the Ingest API endpoint, as you must send a request that includes all required fields, along with the new price. Instead, you can use the Update API endpoint.
Limitations
The limitations listed below apply to all endpoints in the 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 match those on the Web, Mobile App, or XML, as the parameter value serves 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 128 characters.
- 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 up to 512 characters in length.
- item_id field in the record can be as large as 128 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.
- 60 API calls can be made in a minute.
- Throttling due to rate and item limits results in API responses with a 429 status code.
The default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider One team — we can adjust it to fit your needs.