https://beta-library.zoomcatalog.com/product-api
Intended Use
For customers who have set up ZOOMstudio and intend to display their products in ZOOMstudio through the associated ZOOMlibrary. If you have not set up ZOOMstudio, please contact your ZOOMcatalog account representative.
Return Types
product_success_response error
Permitted HTTP Request Methods
POST
HTTP Request Headers
Required | Name | Value |
---|---|---|
Yes | Content-Type | "application/json" |
Yes | Authorization | <access_token> |
Parameters
Required | Name | Value | Location |
---|---|---|---|
Yes | products | array of products | Request Body |
Request Body Example
[
{
"product": {
"style_id": "P-001",
"product_name": "Product Test",
"description": "Product Test Description",
"product_brand": "Test",
"product_category": "Test",
"export": true,
"is_closeout": false,
"is_sale": false,
"is_new": false,
"variations": [
{
"part_id": "P-001BLK",
"part_description": "Product Test Black",
"price_variance": {
"part_id": "P-001BLK",
"name": "price",
"value": "10",
"code": "",
"currency": "USD"
},
"attribute_color": "BLACK",
"attribute_size": "L",
"primary_material": "Cotton",
"is_closeout": false
}
],
"media": [
{
"part_id": "P-001BLK",
"url": "<IMAGE URL>",
"is_default": true,
"color": "BLACK",
"description": ""
}
]}
}
]
Errors
Code | Description | Likely Cause |
---|---|---|
400 | Wrong format in HTTP body, MUST be a valid and well-form JSON string | The POST body cannot be parsed into valid JSON |
400 | Following arguments are required: [List of required arguments] | One or more required parameters is missing |
400 | The token is corrupted | Malformed access token |
500 | Description will vary | Error on the API Server |
Notes
This endpoint will accept up to a maximum of 200 products per request.