This API endpoint is used to query the entire Shoppable catalog where text keywords result in a list of products.
Shoppable v5 Catalog Call
Overview
This endpoint is used to query the entire Shoppable product catalog against the given keywords. Users have the ability to
- filter results by brand and merchant.
- Paginate the response
- Get product details like description, images, color, and size information.
API EndPoint
POST: https://cloud.shoppable.com/catalog
Authentication
Authentication is done with two headers in the request header. Both the bearer token and x-shoppable-secret will be provided to you by your Customer Success Manager at Shoppable.
Request Headers
"Authorization": “Bearer <Bearer token that will be provided by shoppable>”,
"x-shoppable-secret": “<Shoppable Secret will be provided by shoppable>”
"Content-Type": "application/json"
Request Header authorization parameters when generating your request along with context
|
Name |
Description |
|
Authorization |
Unique token that allows access to authorized users to make calls against the Catalog API. |
|
|
Unique identifier string that together with the authorization bearer, validates the bearer token |
Request Body
Requests must be in application/json format and must contain the following variables.
|
Name |
Description |
|
pageSize (int) |
How many products should be fetched at once |
|
page (int) |
The current page for paginating. |
|
query (string) |
The term or upc to find products (include trailing space for more results) |
|
brands (string[]) |
Array of brands to filter the search results |
|
retailers (string[]) |
Array of merchantIds to filter the search results |
|
deepPaging(boolean) |
To indicate whether to deep paging during query. Set to false for |
{
"pageSize": 5,
"page": 1,
"query": "Night Dress",
"brands": ["Oliver Gal"],
"retailers": [],
"deepPaging": false
}
Response
On a successful call you will receive the following data.
|
Name |
Description |
|
totalCount (int) |
Total possible results |
|
pageCount (int) |
Total number of pages |
|
products (Product[]) |
Array of products returned from the API |
|
brands (string[]) |
Array of all brands listed for the products |
|
merchants (string[]) |
Array of all merchantId for the products |
|
error (boolean) |
Indicates if there is any error for api call |
Product
|
id (string) |
Identifier for the product |
|
merchantId (string)
|
merchant Identifier that is source to product information |
|
partNumber (string) |
Part Number for the product (combination of merchantId and sku |
|
merchantSku (string)
|
SKU defined by merchant |
|
upc (string)
|
UPC for the product |
|
name (string)
|
Product name |
|
brand (string)
|
Brand name |
|
category (string)
|
Category defined for the product |
|
description (string)
|
Product description |
|
url (string)
|
PDP link for the product on merchant website |
|
salePrice (decimal)
|
Same as price, here for backward compatibility |
|
price (decimal)
|
Product price in the merchant website |
|
size (string)
|
Product size if available |
|
color (string)
|
Product color if available |
|
status (int)
|
Stock Status, 1 - in stock, 2 - out of stock |
|
image (string)
|
default product image |
|
images (string[])
|
list of available images for the product |
|
attributes (string[])
|
All attributes including color and size |
|
variations (Product[])
|
Product variations if available at the merchant inventory. |
{
"totalCount": 12,
"pageCount": 3,
"products": [
{
"id": "62a0b5285ce2f83f392eac04-00660078971710",
"merchantId": "62a0b5285ce2f83f392eac04",
"sourceId": "744920",
"partNumber": "62a0b5285ce2f83f392eac04-30765651",
"merchantSku": "30765651",
"upc": "00660078971710",
"name": "Oliver Gal Fashion and Glam Wall Art Canvas Prints 'Night Dresses' Dress - Black, Gold",
"brand": "Oliver Gal",
"category": "Home & Garden > Decor > Artwork",
"description": "Night Dresses, is a skillfully made Glam art piece by real artists. With an overarching Black color, this fine art print by The Oliver Gal Artist Co. is the perfect finishing touch to your home decor theme. Features: This art piece has a vertical orientation Fashion design with a Dress theme to bring you the perfect wall art Sustainable and forest friendly Professionally hand stretched in a 1.5 inch-thick sustainable wood frame Arrives ready to hang with pre-installed hooks for easy hanging. Nail and hanger also included Printed using ultra-premium and fade resistant inks to guarantee high definition and vivid colors Available in several size options Proudly made in the USA",
"url": "https://www.kqzyfj.com/click-5430457-13516709?url=https%3A%2F%2Fwww.overstock.com%2FHome-Garden%2FGallery-Wrapped-Canvas%2F29436%2Fsubcat.html%3Ffeaturedproduct%3D30765651%26featuredoption%3D55446562",
"salePrice": 95.31,
"price": 95.31,
"size": "30 x 20",
"color": "Black",
"status": 1,
"images": [
"https://ak1.ostkcdn.com/images/products/30765651/Oliver-Gal-Fashion-and-Glam-Wall-Art-Canvas-Prints-Night-Dresses-Dress-Black-Gold-a00aaab8-7322-4551-a786-3e45afcf8ec2.jpg"
],
"attributes": [
"Black",
"30 x 20"
],
"variations": [],
"image": "https://ak1.ostkcdn.com/images/products/30765651/Oliver-Gal-Fashion-and-Glam-Wall-Art-Canvas-Prints-Night-Dresses-Dress-Black-Gold-a00aaab8-7322-4551-a786-3e45afcf8ec2.jpg"
},
{
"id": "62a0b5285ce2f83f392eac04-00654975155977",
"merchantId": "62a0b5285ce2f83f392eac04",
"sourceId": "744920",
"partNumber": "62a0b5285ce2f83f392eac04-30765571",
"merchantSku": "30765571",
"upc": "00654975155977",
"name": "Oliver Gal Fashion and Glam Wall Art Canvas Prints 'Night Gala Dress' Dress - Black, Gold",
"brand": "Oliver Gal",
"category": "Home & Garden > Decor > Artwork",
"description": "Night Gala Dress, is a skillfully made Glam art piece by real artists. With an overarching Black color, this fine art print by The Oliver Gal Artist Co. is the perfect finishing touch to your home decor theme. Features: This art piece has a horizontal orientation Fashion design with a Dress theme to bring you the perfect wall art Sustainable and forest friendly Professionally hand stretched in a 1.5 inch-thick sustainable wood frame Arrives ready to hang with pre-installed hooks for easy hanging. Nail and hanger also included Printed using ultra-premium and fade resistant inks to guarantee high definition and vivid colors Available in several size options Proudly made in the USA",
"url": "https://www.tkqlhce.com/click-5430457-13516709?url=https%3A%2F%2Fwww.overstock.com%2FHome-Garden%2FGallery-Wrapped-Canvas%2F29436%2Fsubcat.html%3Ffeaturedproduct%3D30765571%26featuredoption%3D55446030",
"salePrice": 101.99,
"price": 101.99,
"size": "20 x 30",
"color": "Black",
"status": 1,
"images": [
"https://ak1.ostkcdn.com/images/products/30765571/Oliver-Gal-Fashion-and-Glam-Wall-Art-Canvas-Prints-Night-Gala-Dress-Dress-Black-Gold-ae74a8d6-5c06-43a0-b04a-dd952e8189eb.jpg"
],
"attributes": [
"Black",
"20 x 30"
],
"variations": [],
"image": "https://ak1.ostkcdn.com/images/products/30765571/Oliver-Gal-Fashion-and-Glam-Wall-Art-Canvas-Prints-Night-Gala-Dress-Dress-Black-Gold-ae74a8d6-5c06-43a0-b04a-dd952e8189eb.jpg"
},
{
"id": "62a0b5285ce2f83f392eac04-00011704823406",
"merchantId": "62a0b5285ce2f83f392eac04",
"sourceId": "744920",
"partNumber": "62a0b5285ce2f83f392eac04-31287679",
"merchantSku": "31287679",
"upc": "00011704823406",
"name": "Oliver Gal 'Night For Stars Elegance' Fashion and Glam Framed Wall Art Prints Dress - Black, White",
"brand": "Oliver Gal",
"category": "Home & Garden > Decor > Artwork",
"description": "Night For Stars Elegance, is a skillfully made Glam art piece by real artists. With an overarching Black color, this fine art framed print by The Oliver Gal Artist Co. is the perfect finishing touch to your home decor theme. Features: This art piece has a square orientation Fashion design with a Dress theme to bring you the perfect wall art Sustainable and forest friendly Professionally hand framed in a premium flat frame behind Plexiglas , for a classic and sleek flat profile Arrives ready to hang with pre-installed hooks for easy hanging. Nail and hanger also included Printed using ultra-premium and fade resistant inks to guarantee high definition and vivid colors Available in several size options and frame colors Proudly made in the USA",
"url": "https://www.anrdoezrs.net/click-5430457-13516709?url=https%3A%2F%2Fwww.overstock.com%2FHome-Garden%2FFramed-Prints%2F29434%2Fsubcat.html%3Ffeaturedproduct%3D31287679%26featuredoption%3D57284178",
"salePrice": 121.49,
"price": 121.49,
"size": "20 x 20",
"color": "Black",
"status": 1,
"images": [
"https://ak1.ostkcdn.com/images/products/is/images/direct/ec0c34950e1a088ccbb7aa76f32635fa37b32d02/Oliver-Gal-%27Night-For-Stars-Elegance%27-Fashion-and-Glam-Framed-Wall-Art-Prints-Dress---Black%2C-White.jpg"
],
"attributes": [
"Black",
"20 x 20"
],
"variations": [],
"image": "https://ak1.ostkcdn.com/images/products/is/images/direct/ec0c34950e1a088ccbb7aa76f32635fa37b32d02/Oliver-Gal-%27Night-For-Stars-Elegance%27-Fashion-and-Glam-Framed-Wall-Art-Prints-Dress---Black%2C-White.jpg"
},
{
"id": "62a0b5285ce2f83f392eac04-00011704753864",
"merchantId": "62a0b5285ce2f83f392eac04",
"sourceId": "744920",
"partNumber": "62a0b5285ce2f83f392eac04-31287679",
"merchantSku": "31287679",
"upc": "00011704753864",
"name": "Oliver Gal 'Night For Stars Elegance' Fashion and Glam Framed Wall Art Prints Dress - Black, White",
"brand": "Oliver Gal",
"category": "Home & Garden > Decor > Artwork",
"description": "Night For Stars Elegance, is a skillfully made Glam art piece by real artists. With an overarching Black color, this fine art framed print by The Oliver Gal Artist Co. is the perfect finishing touch to your home decor theme. Features: This art piece has a square orientation Fashion design with a Dress theme to bring you the perfect wall art Sustainable and forest friendly Professionally hand framed in a premium flat frame behind Plexiglas , for a classic and sleek flat profile Arrives ready to hang with pre-installed hooks for easy hanging. Nail and hanger also included Printed using ultra-premium and fade resistant inks to guarantee high definition and vivid colors Available in several size options and frame colors Proudly made in the USA",
"url": "https://www.dpbolvw.net/click-5430457-13516709?url=https%3A%2F%2Fwww.overstock.com%2FHome-Garden%2FFramed-Prints%2F29434%2Fsubcat.html%3Ffeaturedproduct%3D31287679%26featuredoption%3D57284190",
"salePrice": 121.49,
"price": 121.49,
"size": "20 x 20",
"color": "Black,White",
"status": 1,
"images": [
"https://ak1.ostkcdn.com/images/products/is/images/direct/0b2c50370e126cc487f0ca25bc3d20964fd7619a/Oliver-Gal-%27Night-For-Stars-Elegance%27-Fashion-and-Glam-Framed-Wall-Art-Prints-Dress---Black%2C-White.jpg"
],
"attributes": [
"Black,White",
"20 x 20"
],
"variations": [],
"image": "https://ak1.ostkcdn.com/images/products/is/images/direct/0b2c50370e126cc487f0ca25bc3d20964fd7619a/Oliver-Gal-%27Night-For-Stars-Elegance%27-Fashion-and-Glam-Framed-Wall-Art-Prints-Dress---Black%2C-White.jpg"
},
{
"id": "62a0b5285ce2f83f392eac04-00011704609161",
"merchantId": "62a0b5285ce2f83f392eac04",
"sourceId": "125630",
"partNumber": "62a0b5285ce2f83f392eac04-30896750",
"merchantSku": "30896750",
"upc": "00011704609161",
"name": "Oliver Gal Fashion and Glam Wall Art Framed Canvas Prints 'Night For Stars Elegance' Dress - Black, White",
"brand": "Oliver Gal",
"category": "Home & Garden > Decor > Artwork",
"description": "Night For Stars Elegance, is a skillfully made Glam art piece by real artists. With an overarching Black color, this fine art framed canvas print by The Oliver Gal Artist Co. is the perfect finishing touch to your home decor theme. Features: This art piece has a square orientation Fashion design with a Dress theme to bring you the perfect wall art Sustainable and forest friendly Professionally hand stretched, gallery wrapped canvas art with floater frame Arrives ready to hang with pre-installed hooks for easy hanging. Nail and hanger also included Printed using ultra-premium and fade resistant inks to guarantee high definition and vivid colors Available in several size options and frame colors Proudly made in the USA",
"url": "https://www.kqzyfj.com/click-5430457-15373586?url=https%3A%2F%2Fwww.bedbathandbeyond.ca%2FHome-Garden%2FOliver-Gal-Fashion-and-Glam-Wall-Art-Framed-Canvas-Prints-Night-For-Stars-Elegance-Dress-Black-White%2F30896750%2Fproduct.html%3Foption%3D55793806",
"salePrice": 221.75,
"price": 221.75,
"size": "20 x 20",
"color": "Black",
"status": 1,
"images": [
"https://ak1.ostkcdn.com/images/products/is/images/direct/2d76434b9ec5b1165b4938dc1469f35796aebc9f/Oliver-Gal-Fashion-and-Glam-Wall-Art-Framed-Canvas-Prints-%27Night-For-Stars-Elegance%27-Dress---Black%2C-White.jpg"
],
"attributes": [
"Black",
"20 x 20"
],
"variations": [],
"image": "https://ak1.ostkcdn.com/images/products/is/images/direct/2d76434b9ec5b1165b4938dc1469f35796aebc9f/Oliver-Gal-Fashion-and-Glam-Wall-Art-Framed-Canvas-Prints-%27Night-For-Stars-Elegance%27-Dress---Black%2C-White.jpg"
}
],
"brands": [
"Oliver Gal"
],
"merchants": [
"62a0b5285ce2f83f392eac04"
],
"error": false
}