APN Products

  • API URL : https://api.shop.com:8443



The APN Products Service functions are dependant on a productID value. This service will return Product Search results if a productID IS NOT SUBMITTED. Further information on this is provided in the Search Resource section. If a productID value is present and is a valid product ID, the service will return Product Details. Further information on this is provided in the Detail Resource section.
 
Search Resource
This resource allows a user to search shop.com products by any combination of search term, category, brand, seller, and price range. The search will return a list of matching products. The id element of any of these product objects can be passed in as productID input of the Detail resource. Each product also has a hypermedia link that will get the detail for that product. In addition, a search will also return a list of categories, brands, sellers, and price ranges. These represent options for narrowing a search. You can pass the IDs of these objects into the categoryId, brandId, sellerId, and priceRangeId of the Search resource inputs to search within them.
 
Inputs:
NameDescriptionType
publisherIDThe Publisher’s Affiliate IDQuery Param
localeLocale to retrieve categories for. Locale format is ISO 689-1 language code and ISO 3166-1 alpha-2 country code, separated by an underscore (e.g. en_US).Query Param
termWord or phrase to search for (Optional)Query Param
categoryIdID of the category to search within (Optional)Query Param
brandIdID of the brand to search within (Optional)Query Param
sellerIdID of the seller to filter by (Optional)Query Param
priceRangeIdID of the price range to filter by(Optional)Query Param
perPageNumber of results to return in a singlecall (Optional: defaults to 15)Query Param
startThe index of where to start, in thelist of all matching products, when returning [perPage] number of products.Typically should be set to a multiple of your perPage value. (Optional:defaults to 0)Query Param
 
Outputs:
NameDescriptionType
numberOfProductsThe total number of matching productsfound. Only [perPage] are returned in this responseNumber
productsThe list of products matching thesearch (see Product table)Array of Objects
categoriesList of categories that are availablefor narrowing search (see Category table)Array of Objects
brandsList of categories that are availablefor narrowing search (see Brand table)Array of Objects
sellersList of categories that are availablefor narrowing search (see Seller table)Array of Objects
priceRangesList of categories that are availablefor narrowing search (see PriceRange table)Array of Objects
 
Product Object:
NameDescriptionType
nameThe name of the productString
minimumPriceThe minimum price of this productString
maximumPriceThe maximum price of this productString
brandThe brand of this productString
idThe shop.com id of this productNumber
referralUrlThe link to this product’s shop.compage, with the necessary information to credit the publisher.String
linksA list of hypermedia links.Array of Objects
 
Category Object:
NameDescriptionType
nameThe name of this categoryString
productCountThe number of products in this categorythat match your searchNumber
idThe id of this categoryString
linksA list of hypermedia links.Array of Objects
 
Brand Object:
NameDescriptionType
nameThe name of this brandString
productCountThe number of products in this brandthat match your searchNumber
idThe id of this brandString
linksA list of hypermedia links.Array of Objects
 
Seller Object:
NameDescriptionType
nameThe name of this sellerString
productCountThe number of products in this sellerthat match your searchNumber
idThe id of this sellerString
linksA list of hypermedia links.Array of Objects
 
PriceRange Object:
NameDescriptionType
nameThe name of this price range:String
productCountThe number of products in this pricerange that match your searchNumber
idThe id of this price rangeString
linksA list of hypermedia links.Array of Objects
 
 
Detail Resource
This resource allows a user to get the product detail based on the productID provided.
 
Inputs:
NameDescriptionType
productIDThe id that identifies product (productID)String
publisherIDThe id that identifies Affiliate publisher and finds the portalQuery Param
localeLocale to retrieve categories for. Locale format is ISO 689-1 language code and ISO 3166-1 alpha-2 country code, separated by an underscore (e.g. en_US).Query Param
 
Outputs:
NameDescriptionType
nameThe name of this productString
maximumPriceThe maximum price for this productString
minimumPriceThe minimum price for this productString
idThe id of this productNumber
brandThe brand of this productString
shortDescriptionA short  description of this productString
descriptionA description of this productString
cashBackCash Back return for this productNumber
distributorCashBackDistributor’s cash back for thisproductNumber
ciPointsCustomer incentive for this productNumber
bvBV value for this productNumber
ibvIBV value for this productNumber
freeShippingIf this product has free shippingBoolean
catalogNameCatalog name for this productString
catologDescriptionCatalog description for this productString
calalogLogoImageFileNameCatalog Logo Image URL for thisproductString
imageURLImage URL link for thisproductString
referralUrlReferral URL for this productString
autoShipIf this product has auto shipBoolean
onSaleIf this product is  on saleBoolean
disclaimerDisclaimerString
categoryCategory description of this productObject
reviewDataReview information of this productObject
linksA list of hypermedia linksArray of Objects
 
Category Object:
NameDescriptionType
IdId of the categoryNumber
nameName of the categoryString
 
ReviewData Object:
NameDescriptionType
countCount of the  reviewsString
ratingRatingNumber
 
Links Array:
NameDescriptionType
relThe name of the linkString
hrefReferral linkString
typeType of the mediaString