Help Center

Written by Joanna Kaczmarek

JSON

Use API and customize Where To Buy widget (plugin). Downloading offers for the product.


The integration method below allows you to download data and create your own Where To Buy tool.


Calling URL:

https://api.100shoppers.com/{BB-ID}/buybox.json?{par}={value}


where:

  • {BB-ID} - widget ID 
  • {par} - parameters describing the product and configuration

Please, select {BB-ID} from your 100shoppers account


Requires parameters:

  • number - is your product GTIN number
  • sku - is your unique producer's product ID
  • name - is your product's name
  • category - is the category path of your product

Optional parameters:

  • price - is an optional product suggested retail price
  • description - is an optional product short description
  • image - is an optional product image URL
  • data-bb-alt - the ID of the container with your alternative content that will be displayed if the listings are not available in the plugin, e.g.
  • abpar1 , abpar2 , abpar3 - abpar parameters - additional abpar parameters passed along with the transaction.


Examples:

https://api.100shoppers.com/1/buybox.json?number=8590669282227


Returned data:

{
  "status":true,
  "data":{
    "https:\/\/buybox.click\/bbclick_903_23107592":{
      "id":"23107592",
      "price":"228.00",
      "name":"euro.com.pl",
      "icon":"https:\/\/buybox.click\/uploads\/campaign\/6e8c8c57854fe01ea5d6c379a0d255610fdd2ba0.png",
      "logo":"https:\/\/buybox.click\/uploads\/campaign\/fc07cd2aa6cdeb9f2c3022c87e2fb2138e5b9a19.png",
      "type":null,
      "typeId":null,
      "typeName":"",
      "shopId":"152"
      
    },
      "https:\/\/go.buybox.click\/bbclick_903_23444116":{
        "id":"23444116",
        "price":"228.00",
        "name":"mediaexpert.pl",
        "icon":"https:\/\/buybox.click\/uploads\/campaign\/105e4bc27e08cdc6e7491708c72af2fa76bfbb49.png",
        "logo":"https:\/\/buybox.click\/uploads\/campaign\/e67ead91b125d698c9af03dfbcdc3a7b7bda81ff.png",
        "type":null,
        "typeId":null,
        "typeName":"",
        "shopId":"139"
      },
      "https:\/\/go.buybox.click\/bbclick_903_46853379":{
        "id":"46853379",
        "price":"228.00",
        "name":"Neonet.pl",
      "icon":"https:\/\/buybox.click\/uploads\/campaign\/f84884d584ffeccf90812acda7e54e0126c32909.jpeg",
        "logo":"https:\/\/buybox.click\/uploads\/campaign\/9338bf621e1a819b04b3fd648355651343090b81.png",
        "type":null,
        "typeId":null,
        "typeName":"",
        "shopId":"204"}},
        "spaceId":3,
        "trackingUrl":"https:\/\/utrack.buybox.click\/bb4publisher.js",
        "useCSS":true,
        "useTabs":false,
        "defaultTab":0,
        "rowCount":3
  
}


Note!

  • product URL address - there are two parameters should be given in the URL address, where:

bb_op - this is the position on which the offer is displayed

bb_oc  - the number of displayed offers

An example for an API request with the parameters specified in the URL: https://go.buybox.click/bbclick_16342_183167581?bb_op=1&bb_oc=6

  • price - the price of the product
  • name - the name of the shop
  • type - format (if applicable, e.g. book, ebook, audiobook)
  • icon - URL address of the shop icon
  • logo - URL address of the shop's logotype


Other implementation options:

Categories: