Overview
Catalog integration is the foundation of your e-CROSS integration. It allows you to upload and manage your product catalog, including all Products and SKUs (Stock Keeping Units).Products and SKUs concept
Before integrating your catalog, it’s important to understand the relationship between products and SKUs.Product
A Product is a group of related SKUs that share common attributes. Products represent the logical grouping of variations (by size, color or voltage) that belong together. Example: “USB Charger Type C” is a product that contains multiple SKUs:- USB Charger Type C - 1 meter - Silver
- USB Charger Type C - 2 meters - Silver
- USB Charger Type C - 1 meter - Black
- USB Charger Type C - 2 meters - Black
SKU (Stock Keeping Unit)
A SKU is a specific variation of a product. Each SKU represents a unique sellable item with specific attributes. SKU Characteristics:- Has a unique
skuIdwithin your catalog - Belongs to a
productId(groups related SKUs) - Has specific attributes (size, color, style, etc.)
- Has its own inventory level
- Has its own pricing
Product-SKU relationship
- One product contains multiple SKUs
- All SKUs of a product share the same
productId - Each SKU has unique attributes that differentiate it
- One SKU per product should be marked as
main: true
Per-product integration
Catalog integration happens per product, meaning:- All SKUs of the same product must be sent together in a single API request
- You cannot send SKUs individually - they must be grouped by
productId - The entire product (all its SKUs) is updated as a unit
Main SKU
Themain SKU is the primary variation used by sales channels to display product information in product listing pages. It’s generally the most representative or popular variation of the product.
Creating your catalog
Prepare your data
Organize your products and SKUs. Ensure:
- Each product has a unique
productId - Each SKU has a unique
skuIdwithin your catalog - All SKUs for a product are grouped together
- One SKU per product is marked as
main: true - The mandatory data is present, such as name, description, color, size, dimensions, weight, hscode, images, and so on.
If you have questions or doubts regarding the data to be sent, refer to your e-CROSS representative during the onboarding process.
Send your catalog
Use the Upsert SKUs API to upload your product. Send all SKUs for the product in a single request.
Verify Integration
Use the Get SKU by Product API or List SKUs API to verify the product was integrated correctly and wait for the localization process.
Managing your catalog
Updating existing products
To update a product:- Retrieve the current product state using the Get SKU by Product API
- Modify the SKU data as needed
- Send the complete updated product (all SKUs) using the Upsert SKUs API
Adding new SKUs
To add new SKUs to an existing product:- Retrieve the current product state using the Get SKU by Product API
- Add the new SKU objects to the array
- Send the complete product (existing + new SKUs) using the Upsert SKUs API
Removing SKUs
To remove SKUs from a product:- Retrieve the current product state using the Get SKU by Product API
- Remove the SKU objects you want to delete from the array
- Send the updated product (without the removed SKUs) using the Upsert SKUs API
- Initial upload: Product “ABC” with SKUs: [“SKU1”, “SKU2”, “SKU3”]
- Update upload: Product “ABC” with SKUs: [“SKU1”, “SKU2”]
- Result: SKU3 is deleted from the product
Checking product status
After integrating a product, you can check its localization status and the integration status with sales channels:- Use the Get SKU by Product API to retrieve the product
- Check the
salesChannelStatusfield for each sales channel - Status values include:
READY_FOR_SALES_CHANNEL- Pending integrationSALES_CHANNEL_APPROVED- Successfully integratedSALES_CHANNEL_DENIED- Integration refused (checkstatusMessage)DENIED_REGULATORY- Not allowed due to regulatory rules
