Onboarding API

Creation of catalog via API

How does it work?

Catalog loading via API consists of sending a catalog using endpoints. This load and/or update can be done uniquely or with few updates and massively (Single & Bulk).

Pre-requirements

• Is required to have enabled the catalog service in the target environment (staging, production)
• Is required to get the api-key in order to call the catalog API, this info can be requested via support or with your account manager for each environment.

Considerations

• SKU: is a mandatory field in all cases
• Update: To update product fields, the SKU is always needed
• Creation: For the case of creating new products, insert mode is enabled (upsert mode set to true). It must also include:
  • storeReference and categoryReference of the category or subcategory to which it belongs
    • These two references must have been previously created (see Annex3)
  • Price and Stock of the SKU
    
    

Massive catalog load (bulk: create or update multiple products)

Pre-requirements

• Is required to have enabled the batch module, this can be requested via support ticket (live client) or with your account manager in the target environment

• Frequency: It will always depend on the number of products to be loaded or updated

  • If it is an amount >10,000 → Only once a day
  • If they are amounts <10,000 or between 1,000 and 2,000 → It can be done whenever you want

Note: We recommend that bulk catalog updates be made during off-peak hours (low flow times), at night or early morning.

Single catalog load (single: create or update a few products)

• Frequency: Multiple times a day
• Number of SKUs per request: <1,000

Configuration

To successfully integrate your product catalog with our system, please follow the steps outlined below:

1. Prepare Your Data
   Ensure your product data is structured according to the required Format X, as defined in our API documentation. This format outlines the necessary fields and structure for successful ingestion.
2. Submit Your Catalog via API
   Using your preferred HTTP client (such as cURL, Postman, or libraries like Requests in Python), send a POST request to the relevant API endpoint identified during your setup. You can refer to example requests provided in the API documentation for guidance.
3. Monitor the Response
   Once your request is submitted:
   1. A 2xx status code indicates that your data was successfully received.
   2. A 4xx error typically points to missing or incorrectly formatted data. Double-check that all required fields are included and correctly structured.
   3. A 5xx error may suggest an issue on our end or a conflict (e.g., trying to update a product that already exists). Please verify the product data and try again or contact support if the issue persists.
4. Test in the Staging Environment
   Before going live, we recommend testing your catalog upload in our staging environment. Begin with a small batch of at least 10 SKUs to ensure everything is working as expected. Once validated, you can proceed with uploading your full catalog in staging.
5. Move to Production
   After successful testing and validation in staging, you can replicate the same process in the production environment to complete the integration.

To consult the available API's plase follow:

Catalog APIs