Product prices

    Get a product's prices

    Request

    • Method: GET
    • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

      Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

    • Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.
      • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
    • Path: /webresources/api/v3/sites/current/products/[product_ID]/prices
      • Alternatively, use siteID instead of 'current'
    • Authorization header: This should contain the authorization token. Here is how to obtain the token.

    Response

    An array of the first 10 prices; each object has the following properties:

    • productId - product's ID (numeric)
    • siteId - current siteID (numeric)
    • countryCode - country code the priduct applies for (string)
    • taxCodeId - tax code ID associated (numeric)
    • wTaxCodeId - wholesaler tax code(numeric)
    • retailPrice - retail price (numeric)
    • salePrice - sale price (numeric)
    • wholesalerPrice - wholesaler price (numeric)
    • salePrice2 - sale price2 (numeric)
    • salePrice3 - sale price3 (numeric)
    • quantity2 - quantity threshold 2 (numeric)
    • quantity3 - quantity threshold 3(numeric)
    • wSalePrice - wholesaler sale price (numeric)
    • wSalePrice2 - wholesaler sale price 2 (numeric)
    • wSalePrice3 - wholesaler sale price 3 (numeric)
    • wQuantity2 - wholesaler quantity threshold 2 (numeric)
    • wQuantity3 - wholesaler quantity threshold 3 (numeric)

    You can output additional fields to those listed above as default, see the API v3 Discovery APP for additional details.

    Accepts and returns JSON as Content-Type.


    Sample request

    var access_token = BCAPI.Helper.Site.getAccessToken();
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/products/3909340/prices",
        type: "GET",
        connection: "keep-alive",    
        contentType: "application/json",
        headers: {
            "Authorization": $.cookie('access_token')
        }
    });
    request.done(function (msg) {
        console.log(msg);
    })
    request.fail(function (jqXHR) {
        console.log("Request failed.");
        console.log("Error code: " + jqXHR.status);
        console.log("Error text: " + jqXHR.statusText);
        console.log("Response text: " + jqXHR.responseText);
    })

    Sample response

    {
      "items": [
        {
          "productId": 3909340,
          "siteId": 246884,
          "countryCode": "AD",
          "taxCodeId": -1,
          "wTaxCodeId": -1,
          "retailPrice": 25,
          "salePrice": 25,
          "salePrice2": null,
          "salePrice3": null,
          "quantity2": null,
          "quantity3": null,
          "wholesalerPrice": 2.00,
          "wSalePrice": 0,
          "wSalePrice2": null,
          "wSalePrice3": null,
          "wQuantity2": null,
          "wQuantity3": null
        },
        {
          "productId": 3909340,
          "siteId": 246884,
          "countryCode": "AE",
          "taxCodeId": -1,
          "wTaxCodeId": -1,
          "retailPrice": 25,
          "salePrice": 25,
          "salePrice2": null,
          "salePrice3": null,
          "quantity2": null,
          "quantity3": null,
          "wSalePrice": 0,
          "wSalePrice2": null,
          "wSalePrice3": null,
          "wQuantity2": null,
          "wQuantity3": null
        }
      ]
      "totalItemsCount": 2,
      "skip": 0,
      "limit": 10
    }