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/catalogs/all

Intended Use

If your ZOOMcatalogs and ZOOMcustom Catalogs have not been linked, we reccommend using the /catalogs/ endpoint. For more information about having your catalogs linked, please contact your ZOOMcatalog account representative.

Retrieve a list of all ZOOMcatalogs associated with your account. If your catalogs are linked, the resources will include links to the customizable versions of the catalogs. If your catalogs are linked and you pass the for_username parameter or a user_token, the links to customizable catalogs will be autologin_uris.

Return Types

catalogs_with_personalize
catalogs_without_personalize
error

Permitted HTTP Request Methods

GET

HTTP Request Headers

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

Parameters

RequiredNameDescriptionLocation
Nofor_username<string>- unique identifier representing a user in your applicationQuery String
NoversionISO 3166-1 alpha-2 country code in lowercase(E.g. us or ca)Query String
NolangISO 639-1 language code in lowercase(E.g. us-en or ca-fr)Query String
Nois_pricedtrue returns priced catalogs, false returns non-priced, null (default) returns all.Query String

Notes

Sending a <user_token> in the Authorization header will produce the same result as sending an <access_token> in conjunction with the for_username parameter. Sending a request with an <access_token> without the for_username parameter is equivalent to issuing a request to /catalogs/.

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