Catalogs and excluded shipping options

    List the shipping options marked to exclude catalog

    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/catalogs/[catalog_ID]/excludedShippingOptions
      • 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 discount codes; each object has the following properties:

    • id - the id of the shipping option (integer)
    • siteId - the id of the site (integer)
    • "description" - the shipping option's description (string)
    • "price" - (integer)
    • "type" - the type of shipping option (integer)
      • 1 - User defined
      • 2 - Australia Post
      • 3 - FedEx
      • 4 - USPS
      • 5 - Free shipping
      • 6 - DHL
      • 7 - UPS
    • "packageType" - (integer)
    • "taxCodeId" - (integer)
    • "countryCode" - (string)
    • "state" - (string)
    • "postcode" - (string)
    • "productMinWeight" - (integer)
    • "productMinVolume" - (integer)
    • "productMinHeight" - (integer)
    • "productMinDepth" - (integer)
    • "productMaxWeight" - (integer)
    • "productMaxVolume" - (integer)
    • "productMaxHeight" - (integer)
    • "productMaxDepth" - (integer)
    • "totalOrderPriceMin" - (integer)
    • "totalOrderPriceMax" - (integer)
    • "handlingBaseCharge" - (integer)
    • "handlingPerItemCharge" - (integer)
    • "freeThreshold" - (integer)
    • "limitDeliveryTo" - (string)
    • "userAccountNumber" - (string)
    • "userAccountId" - (string)
    • "userAccountKey" - (string)
    • "userAccountPassword" - (string)
    • "upsAccountType" - (integer)
    • "upsPackageType" - (integer)
    • "upsConfirmationType" - (integer)

    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/catalogs/25481/excludedShippingOptions",
        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": [
        {
          "optionId": 304222,
          "catalogueId": 25481,
          "siteId": 246884,
          "shippingOption": {
            "id": 304222,
            "siteId": 246884,
            "description": "Air",
            "price": 0,
            "type": 2,
            "packageType": 3,
            "taxCodeId": 0,
            "countryCode": "US",
            "state": "  ",
            "postcode": "123",
            "productMinWeight": -1,
            "productMinVolume": -1,
            "productMinHeight": -1,
            "productMinDepth": -1,
            "productMaxWeight": -1,
            "productMaxVolume": -1,
            "productMaxHeight": -1,
            "productMaxDepth": -1,
            "totalOrderPriceMin": -1,
            "totalOrderPriceMax": -1,
            "handlingBaseCharge": 0,
            "handlingPerItemCharge": 0,
            "freeThreshold": 0,
            "limitDeliveryTo": null,
            "userAccountNumber": null,
            "userAccountId": null,
            "userAccountKey": null,
            "userAccountPassword": null,
            "upsAccountType": 0,
            "upsPackageType": 0,
            "upsConfirmationType": 0
          }
        }
      ],
      "totalItemsCount": 1,
      "skip": 0,
      "limit": 10
    }