API Documentation

API Documentation

  • Common Usecases
  • Advanced Usecases
  • ZOOMstudio + ZOOMlibrary

›beta-library.zoomcatalog.com/

About

  • Introduction
  • Conventions

Guides

    Common Usecases

    • Add ZOOMcatalogs to your website
    • Add customizable catalogs to your website
    • Add customizable flyers to your website

    Advanced Usecases

    • Add Linked ZOOMcatalogs AND customizable catalogs to your website on one page

    ZOOMstudio + ZOOMlibrary

    • Autologin for ZOOMstudio
    • Use ZOOMlibrary to Connect Your Product Data to ZOOMstudio

Endpoints

    api.zoomcatalog.com/

    • auth/authorize
    • auth/autologin
    • auth/register
    • catalogs/
    • catalogs/all
    • categories/
    • categories/all
    • categories/catalogs
    • custom/catalogs/
    • custom/catalogs/personalized
    • flyers/
    • flyers/personalized

    beta-library.zoomcatalog.com/

    • product-api

Resources

  • access_token
  • autologin_uri
  • catalogs_with_personalize
  • catalogs_without_personalize
  • category_descriptors
  • category_details
  • category_catalogs
  • custom_catalogs_with_actions
  • custom_catalogs_without_actions
  • Errors
  • flyers_with_actions
  • id
  • image
  • sample
  • subcompany
  • user_token
  • ZOOMcatalog_Client_ID
  • ZOOMcatalog_Client_Secret

Specifications

  • product
  • product/variations
  • product/variations/price_variance
  • product/media

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

RequiredNameValue
YesContent-Type"application/json"
YesAuthorization<access_token>

Parameters

RequiredNameValueLocation
Yesproductsarray of productsRequest 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

CodeDescriptionLikely Cause
400Wrong format in HTTP body, MUST be a valid and well-form JSON stringThe POST body cannot be parsed into valid JSON
400Following arguments are required: [List of required arguments]One or more required parameters is missing
400The token is corruptedMalformed access token
500Description will varyError on the API Server

Notes

This endpoint will accept up to a maximum of 200 products per request.

← flyers/personalizedaccess_token →
  • Intended Use
  • Return Types
  • Permitted HTTP Request Methods
  • HTTP Request Headers
  • Parameters
  • Request Body Example
  • Errors
  • Notes
ZOOMcatalog
Copyright © 2019 ZOOMcatalog