API Documentation

API Documentation

  • Common Usecases
  • Advanced Usecases
  • ZOOMstudio + ZOOMlibrary

›Specifications

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

product/variations

Context

All requests to the beta-library.zoomcatalog.com/product-api endpoint must contain a request body conforming to the object shape described in the product spec. The object described below is part of the aforementioned spec.

Key-Value Pairs in a Variations Object

FieldDescriptionType - LengthRequired
part_idPart id or SKU.String - 64Yes
part_descriptionSmall part description.String - 256No
price_varianceFor pricing use the price_variance object.ArrayYes
attribute_colorColor of the variationString - 64Yes
attribute_color_hexHexadecimal color code of the variation.String - 10No
attribute_sizeSize of the variation.String - 64Yes
swatch_color_hexHexadecimal color code of the swatch.String - 10No
swatch_color_imageSwatch image url of the variation.String - 256No
primary_materialMaterial the product/variation is made.String - 64No
is_closeoutIndicates the variation is clearance.BooleanNo
← productproduct/variations/price_variance →
  • Context
  • Key-Value Pairs in a Variations Object
ZOOMcatalog
Copyright © 2019 ZOOMcatalog