The Catalogue Upload endpoint allows grocery and retail partners to create and update a catalogue of items and associated data. Sites can reference this catalogue (by provided id) in subsequent update listings calls
As processing large amounts of catalogue data can be resource-intensive, there are a few steps necessary for catalogue upload.
Steps:
- Correctly setup webhooks for the Catalogue API in the Developer Portal
- Call Catalogue Upload URL. Successful requests will receive an upload url and an upload id, which is used for tracking the entire catalogue upload lifecycle
- Upload catalogue data to the upload url provided in the response. When upload is complete catalogue processing will begin
- When processing is complete, or a problem occurred, webhook notifications will be sent, containing the upload id
Rate Limit
This endpoint is rate limited at 10 requests per minute per brand.
Entity Limits
Brands should not have more than 10 active catalogues (catalogues with listed sites) any point in time.
Catalogue ID
Catalogue IDs should be reused over subsequent catalogue uploads, and can likely be set once and never changed. This will reduce processing time and ensure listings and availability data is maintained over uploads.
Updates
Updates to catalogue items that already exist