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/media

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 Media Object

FieldDescriptionType - LengthRequired
part_idPart id or SKU related to the media.String - 64Yes
urlPublic media url.String - 1024Yes
is_defaultIndicate if the media is the default.BooleanYes
media_typeThe type of media.String - 264No
class_typeClassification of the media. (e.g. swatch, black, decorated, etc…).String - 264No
viewPoint of view used in the media ( e.g. front, back, side, top, bottom, etc...).String - 264No
file_sizeFile sizeFloatNo
widthWidth of mediaIntegerNo
heightHeight of mediaIntegerNo
dpiDots per inchIntegerNo
colorMain color of the mediaString - 265No
descriptionShort description of mediaString - 1024No
← product/variations/price_variance
  • Context
  • Key-Value Pairs in a Media Object
ZOOMcatalog
Copyright © 2019 ZOOMcatalog