Gift vouchers

    Get gift vouchers

    Gets the list of gift voucher resources available.

    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/giftvouchers
      • Alternatively, use siteID instead of 'current'
    • Authorization header: This should contain the authorization token. Here is how to obtain the token.

    Response

    The details for the specified customer ID in JSON format.

    • code (string)
    • countryCode (string)
    • createDate (dateTime)
    • createdByAdmin (boolean)
    • enabled (boolean)
    • id - the id of the gift voucher (numeric)
    • lastUpdateDate (dateTime)
    • message (string)
    • orderId - the name of the customer Type (numeric)
    • recipiendEmail (string)
    • recipientName (string)
    • remainingBalance - the remaining balance of the gift voucher (numeric)
    • siteId - the id of the site (numeric)
    • totalValue (numeric)

    The response is paginated, you can return only a few of the customer's fields. Take a look at the API V3: sorting and filtering for additional switches you can use.

    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.


    Request:

    GET /webresources/api/v3/sites/current/giftvouchers HTTPS/1.1
    Authorization: 14f87f21c5ea4830a06a6314a8aad82b45bc61dc08f24a0fb55599cea83ca811
    Connection: keep-alive
    Content-Type: application/json
    

    Response:

    {
        "items": [{
            "id": 6695,
            "orderId": -1,
            "siteId": 1383175,
            "countryCode": "US",
            "code": "GV-10",
            "recipientName": "John Doe",
            "recipientEmail": "jdoe@mailinator.com",
            "message": "Thank you for your purchase, here is a token of our appreciation.",
            "totalValue": 10,
            "remainingBalance": 10,
            "createDate": "2017-04-05T16:59:33.283",
            "lastUpdateDate": "2017-04-05T16:59:33.283",
            "createdByAdmin": true,
            "enabled": true
        }],
        "totalItemsCount": 1,
        "skip": 0,
        "limit": 10
    }

    Sample code

    Get the list of gift vouchers

    var access_token = BCAPI.Helper.Site.getAccessToken();
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/giftvouchers",
        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);
    })

    Get the details of a particular gift voucher

    var access_token = BCAPI.Helper.Site.getAccessToken();
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/giftvouchers/77001",
        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);
    })

    Create a new gift voucher resource

    Using this method you can add an gift voucher's resource to your site.

    Request

    • Method: POST
    • Version: v3
    • 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/giftvouchers
      • Alternatively, use siteID instead of 'current'
    • Authorization header: This should contain the authorization token. Here is how to obtain the token.

    Parameters

    • code (string)
    • countryCode (string)
    • createDate (dateTime)
    • createdByAdmin (boolean)
    • enabled (boolean)
    • lastUpdateDate (dateTime)
    • message (string)
    • orderId - the name of the customer Type (numeric)
    • recipiendEmail (string)
    • recipientName (string)
    • totalValue (numeric)

    Response

    Returns an empty body if successful or a detailed error message.

    Accepts and returns JSON as Content-Type.


    Request:

    POST /webresources/api/v3/sites/current/giftvouchers HTTPS/1.1
    Authorization: 14f87f21c5ea4830a06a6314a8aad82b45bc61dc08f24a0fb55599cea83ca811
    Connection: keep-alive
    Content-Type: application/json
    
    
    {
        "label": "Woodworks and others",
        "default": false
    }

    Response:

    
    HTTP/1.1 201 CREATED
    Location: /webresources/api/v3/sites/current/giftvouchers/77002
    Content-Type: application/json; charset=utf-8
    Content-Length: length

    Sample code

    var access_token = BCAPI.Helper.Site.getAccessToken();
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/giftvouchers",
        data:{"orderId":-1,"countryCode":"US","code":"BirthdayGift","recipientName":"John Doe","recipientEmail":"jdoe123456@mailinator.com","message":"Happy birthday John, here is a $10 gift voucher for you!","totalValue":10,"createDate":"2015-02-20T14:51:26.23","lastUpdateDate":"2015-02-20T14:51:26.23","createdByAdmin":true,"enabled":true},
        type: "POST",    
        contentType: "application/json",
        headers: {
             "Authorization": BCAPI.Helper.Site.getAccessToken()
        }
    });
    request.done(function(data) {
        console.log(data);
    })
        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);
    })

    Edit a gift voucher resource

    Using this method you can edit a gift voucher resource

    Request

    • Method: PUT
    • Version: v3
    • 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/giftvouchers/[gift voucher_ID]
      • Alternatively, use siteID instead of 'current'
    • Authorization header: This should contain the authorization token. Here is how to obtain the token.

    Parameters

    • code (string)
    • countryCode (string)
    • createDate (dateTime)
    • createdByAdmin (boolean)
    • enabled (boolean)
    • lastUpdateDate (dateTime)
    • message (string)
    • orderId - the name of the customer Type (numeric)
    • recipiendEmail (string)
    • recipientName (string)
    • totalValue (numeric)

    Response

    Returns an empty body if successful or a detailed error message.

    Accepts and returns JSON as Content-Type.


    Request:

    PUT /webresources/api/v3/sites/current/giftvouchers/28742 HTTPS/1.1
    Authorization: 14f87f21c5ea4830a06a6314a8aad82b45bc61dc08f24a0fb55599cea83ca811
    Connection: keep-alive
    Content-Type: application/json
    
    
    {
      "items": [
        {
          "id": 77001,
          "siteId": 246884,
          "orderId": -1,
          "countryCode": "US",
          "code": "BirthdayGift",
          "recipientName": "John Doe",
          "recipientEmail": "jdoe123456@mailinator.com",
          "message": "Happy birthday John, here is a $10 gift voucher for you!",
          "totalValue": 10,
          "createDate": "2015-02-20T14:51:26.23",
          "lastUpdateDate": "2015-02-20T14:51:26.23",
          "createdByAdmin": true,
          "enabled": true
        }

    Response:

    
    HTTP/1.1 204 NO CONTENT
    Location: /webresources/api/v3/sites/current/giftvouchers/77001
    Content-Type: application/json; charset=utf-8
    Content-Length: length

    Sample code

    var access_token = BCAPI.Helper.Site.getAccessToken();
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/giftvouchers/77001",
        data:{"code":"BirthdayGift"},
        type: "PUT",    
        contentType: "application/json",
        headers: {
             "Authorization": BCAPI.Helper.Site.getAccessToken()
        }
    });
    request.done(function(data) {
        console.log(data);
    })
        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);
    })

    Delete a gift voucher entity

    Delete an gift voucher entity.

    Request

    • Method: DELETE
    • Version: v3
    • 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/giftvouchers/[gift voucher_ID]
      • Alternatively, use siteID instead of 'current'
    • Authorization header: This should contain the authorization token. Here is how to obtain the token.

    Response

    Returns an empty body if successful or a detailed error message.


    Request:

    DELETE /webresources/api/v3/sites/current/giftvouchers/9593213 HTTPS/1.1
    Authorization: 14f87f21c5ea4830a06a6314a8aad82b45bc61dc08f24a0fb55599cea83ca811
    Connection: keep-alive
    Content-Type: application/json
    

    Response:

    
    HTTP/1.1 204 NO CONTENT
    Location: /webresources/api/v3/sites/current/giftvouchers
    Content-Type: application/json; charset=utf-8
    Content-Length: length

    Sample code

    var access_token = BCAPI.Helper.Site.getAccessToken();
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/giftvouchers/77001",
        type: "DELETE",    
        contentType: "application/json",
        headers: {
             "Authorization": BCAPI.Helper.Site.getAccessToken()
        }
    });
    request.done(function(data) {
        console.log(data);
    })
        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);
    })