API Documentation

API Documentation

  • Common Usecases
  • Advanced Usecases
  • ZOOMstudio + ZOOMlibrary

›Resources

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

catalogs_without_personalize

NameResource TypeDescriptionReturned By
catalogs_without_personalizearrayA collection of catalog_without_personalize resources/catalogs/, /catalogs/all/
catalog_without_personalizeobjectSee Below

Key-Value Pairs In a catalog_without_personalize Resource

KeyResource TypeDescription
ididA unique identifier for the catalog
titlestringTitle of the catalog
versionstringA space-separated ISO 3166-1 Alpha-2 code
urlstringA link to the catalog
creatednumberA Unix Timestamp
expirationnumberA Unix Timestamp
imagesimageThe cover of the catalog
subcompanysubcompanyThe subcompany the catalog belongs to, if applicable

Errors

CodeDescriptionLikely Cause
400The token is corruptedMalformed user or access token
400The provided access token does not contain the scope requiredAn access_token was used where a user_token should be used, or the user associated with the user_token does not have permission to access the resource
401The token has expiredThe access or user token is too old
404Invalid CLIENT_ID, please contact the administratorThe provided resource id is malformed or invalid
← catalogs_with_personalizecategory_descriptors →
  • Key-Value Pairs In a catalog_without_personalize Resource
  • Errors
ZOOMcatalog
Copyright © 2019 ZOOMcatalog