For customers who intend to send their product information and images to ZOOMlibrary using the ZOOMatalog Product Library API. ZOOMlibrary is connected to ZOOMstudio, allowing the product information to flow into the Supplier ZOOMstudio.
To feed ZOOMstudio with your products you need to send a POST request to:
Using a client like Postman or by code, in the request body will be all of the products for the supplier, the supplier can send all products in one request but we strongly recommend using different requests in batches of 100 products or less.
This request works as an update, if the product exists it will update the old information with the one in the request and if the product does not exist it will add it to the database.
I will explain the format of the product data using an example, all the technical information is in this link https://doc-site.zoomcatalog.com/docs/specs/product, but I will do a complete example of just 1 product.
In the request to the API you need to add the product information in the body of the request in a form of a List in a JSON format, in the example below I will show a complete example of a product with all the fields.
Every field has a short explanation on what is the info and how we use it.
[{
"style_id": "OH45X",//This is the product unique Identifier
"product_name": "Polo Shirt",// Name of product
"description": "A simple but very attractive shirt",// You can add some HTML code to make this description more graphic, like add Bullet points, lists or simply add more style to the text
"product_brand": "Nike",//Product brand
"product_category": "Apparel",// Very usefull for filtering products in the search
"export": false,//Product status for export, a simple yes or no
"is_closeout": false,// Indicates if is a clearance product
"is_sale": true,// Indicates if is a sale product, you can deactivate a product if you put this field in false
"is_new": true,// Indicates if the product is new
"variations": [{ // The variation is a list with all SKU's for that specific product, if the product has colors or sizes, each variation is unique and needs to be in this list
"part_id": "OH45X-BXL",// part_id is the same as saying SKU, most of the suppliers use the same product_id and add the color and sizing in the identifier
"part_description": "Blue variation in XL size",
"price_variance": 23.5,// Price variance can be one of 2 options, this one is the simple option, is just a plain price
"price_variance": {// This second option is more complex, so you can add more pricing options like a pricing table
"part_id": "OH45X-BXL",// You need to specify the SKU again
"name": "min-qty-10",// This is the name of this specific pricing condition, like min-qty
"value": "20.3",// The price with the condition mentioned before
"code": "C",//Discount price code by quantity.
"currency": "USD",// Currency for price. ISO 4217 format.
"price_type": "List",// Type of price. One of: Customer, List, Net, the most common is List
"config_type": "Blank" //Blank or Decorated the most common is Blank
},
"price_code": "C",//Discount price code by quantity.
"attribute_color": "Blue",// This is the color name
"attribute_color_hex": "00FFAA",//This is the color in hex in order to show the exact color for this variance in the studio
"attribute_size": "XL",//Size of the variation.
"swatch_color_hex": "00FFAA",// You can show this color as a swatch
"swatch_color_image": "<https://someurl.com/image.png>",// Or you can show a specific swatch using a image in case the color is complex (multiple colors, color + pattern)
"primary_material": "100% Cotton",// Material the product/variation is made.
"is_closeout": false //Indicates the variation is clearance.
}],
"media": [{// This is a list of all the images for the product and his SKU's
"part_id": "OH45X-BXL",// SKU specific for this image
"url": "<https://someurl.com/image.png>",// This URL need to be public in order to be visible in the studio
"is_default": true,// This is the image that will represent the product, this field should be used wisely
"media_type": "Front",//The type of media.
"file_size": 1000.32,// The size of the image in bytes
"width": 1024,// Width in pixels
"height": 1024,// Height in pixels
"dpi": 300,//Image quality in dots per inch
"color": "Blue",// Main color of the media
"description": "Front image"//Short description of media
}]
}]
Click in "original" to see the image bigger