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_with_personalize

NameResource TypeDescriptionReturned By
catalogs_with_personalizearrayA collection of catalog_with_personalize resources/catalogs/all/
catalog_with_personalizeobjectSee Below

Key-Value Pairs In a catalog_with_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
personalizeautologin_uriA link to a personalizable version of the catalog
creatednumberA Unix Timestamp
expirationnumberA Unix Timestamp
imagesimageThe cover of the catalog
subcompanysubcompanyThe subcompany the catalog belongs to, if applicable
← autologin_uricatalogs_without_personalize →
  • Key-Value Pairs In a catalog_with_personalize Resource
ZOOMcatalog
Copyright © 2019 ZOOMcatalog