This endpoint is used to query a given set of UPCs to get: Stock availabilities in retailers Up-to-date price information Variations (customers have the ability to create their own variation by grouping products )
Overview
- Stock availabilities in retailers
- Up-to-date price information
- Variations (customers have the ability to create their own variation by grouping products )
API EndPoint
POST: https://cloud.shoppable.com/products
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 |
A unique token that allows access to authorized users to make calls against the Product API. |
|
|
A 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 |
|
upcs (array) |
Unique Product Code number used to identify products from different retailers, Max 20 upcs can be queried at one call |
|
lean (boolean) |
Setting this property to true will add a metadata object property to the response which adds additional data including total merchants, total in stock, and link off data for a UPC. |
{
"upcs": ["00050428648360"],
"lean": false
}
Response
On a successful call, you will receive the following data.
|
Name |
Description |
|
totalMerchants |
Total Merchants the UPC is available at |
|
totalInStock |
Total Number of Merchants the UPC is in stock for |
|
totalOutOfStock |
Total Number of Merchants the UPC is out of stock for |
|
linkOff |
Shows if Product has linkoff Merchants |
|
exists |
Product exists at available merchants |
|
Id (string) |
Unique Shoppable Product Identifier |
|
partNumber |
Unique Shoppable Product Group Identifier |
|
Name |
Name of the Product |
|
Merchant |
Name of Product’s Merchant |
|
MerchantId |
Unique Shoppable Merchant Identifier |
|
Brands |
Name of Product’s Brand |
|
Category |
Category of Product |
|
merchantSku |
A unique product identifier, usually provided by Product manufacturer |
|
UPC |
A unique Product Code number used to identify products from different retailers |
|
Description |
Description of the Product |
|
url |
Product Detail Page link |
|
salePrice |
Sales Price of Product (If Product is on sale) |
|
size |
Size variation of Product |
|
color |
Color variation of Product |
|
status |
Product Availability (In Stock/Out of Stock) |
|
image |
Primary image of Product |
|
images |
Multiple Product Images (If Applicable) |
|
asin |
Amazon Unique Product Identifier |
|
merchantLogo |
Merchant Logo for Product |
|
maxQuantity |
Max number threshold of the Product that can be added to the cart |
|
shippingCharge |
Shipping charge of the Product (If free shipping threshold is not reached) |
|
freeShipping |
Cart total threshold that must be reached to qualify for free shipping |
|
customerServiceUrl |
Customer Service Url for merchant of Product |
|
returnPolicy |
Return Policy Url for merchant of Product |
Variations
|
Id (string) |
Unique Shoppable Product Identifier |
|
partNumber |
Unique Shoppable Product Group Identifier |
|
Name |
Name of the Product |
|
merchant |
Name of Product’s Merchant |
|
merchantId |
Unique Shoppable Merchant Identifier |
|
brands |
Name of Product’s Brand |
|
Category |
Category of Product |
|
merchantSku |
Unique product identifier, usually provided by Product manufacturer |
|
UPC |
Unique Product Code number used to identify products from different retailers |
|
Description |
Description of the Product |
|
url |
Product Detail Page link |
|
salePrice |
Sales Price of Product (If Product is on sale) |
|
size |
Size variation of Product |
|
color |
Color variation of Product |
|
status |
Product Availability (In Stock/Out of Stock) |
|
image |
Primary image of Product |
|
images |
Multiple Product Images (If Applicable) |
|
asin |
Amazon Unique Product Identifier |
|
merchantLogo |
Merchant Logo for Product |
|
maxQuantity |
Max number threshold of the Product that can be added to the cart |
|
shippingCharge |
Shipping charge of the Product (If free shipping threshold is not reached) |
|
freeShipping |
Cart total threshold that must be reached to qualify for free shipping |
|
customerServiceUrl |
Customer Service Url for merchant of Product |
|
returnPolicy |
Return Policy Url for merchant of Product |
|
error |
Error object that returns a value if an error occurred during the |
{
"metaData": {
"totalMerchants": Number,
"totalInStock": Number,
"totalOutOfStock": Number
},
"products": {
"00050428648360": {
"data": [
{
"id": String,
"partNumber": String,
"name": String,
"merchant": String,
"merchantId": String,
"Brands": String,
"category": String,
"merchantSku": String,
"upc": String
"description": String,
"url": String,
"salePrice": Number,
"price": Number,
"size": String,
"color": String,
"status": Number,
"image": String
"images": Array
"asin": "",
"merchantLogo": String,
"maxQuantity": Number,
"shippingCharge": Number,
"freeShipping": Number,
"customerServiceUrl": String,
"returnPolicy": String,
"variations": Array [
{
"Id": String,
"partNumber": String,
"Name": String ,
"merchant": String,
"merchantId": String,
"brands": String,
"category": String,
"merchantSku": String
"upc": String,
"description": String,
"url": String,
"salePrice": Number,
"price": Number,
"size": String,
"color": String,
"status": Number,
"image": String,
"images": Array [
String
],
"asin": String,
"merchantLogo": String,
"maxQuantity": Number,
"shippingCharge": Number,
"freeShipping": Number,
"customerServiceUrl": String,
"returnPolicy": "String
}
]
}
],
"linkOff": boolean,
"totalMerchants": Number,
"totalInStock": Number,
"totalOutOfStock": Number,
"exists": boolean
}
},
"error": boolean
}