API Documentation

API Documentation

  • Common Usecases
  • Advanced Usecases
  • ZOOMstudio + ZOOMlibrary

›api.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://api.zoomcatalog.com/flyers/

Intended Use

Retrieve a list of all flyers associated with your account.

Return Types

flyers_without_actions
error

Permitted HTTP Request Methods

GET

HTTP Request Headers

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

Parameters

RequiredNameValueLocation
Nofor_username<string>- unique identifier representing a user in your applicationQuery String
Noid<string>- id of a catalogQuery String
Notitle<string>- title of a catalogQuery String

Notes

If the for_username parameter is present, the personalize link in each flyer will be an autologin_uri. The id and title parameters will be used to filter the list of flyers.

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
← custom/catalogs/personalizedflyers/personalized →
  • Intended Use
  • Return Types
  • Permitted HTTP Request Methods
  • HTTP Request Headers
  • Parameters
  • Notes
  • Errors
ZOOMcatalog
Copyright © 2019 ZOOMcatalog