Skip to content

Latest commit

 

History

History
434 lines (292 loc) · 14.7 KB

GiftCertificateApi.md

File metadata and controls

434 lines (292 loc) · 14.7 KB
Raw

UltraCartRestApiV2.GiftCertificateApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method HTTP request Description
addGiftCertificateLedgerEntry POST /gift_certificate/gift_certificates/{gift_certificate_oid}/ledger_entry Add a gift certificate ledger entry
createGiftCertificate POST /gift_certificate/gift_certificates Create a gift certificate
deleteGiftCertificate DELETE /gift_certificate/gift_certificates/{gift_certificate_oid} Delete a gift certificate
getGiftCertificateByCode POST /gift_certificate/gift_certificates/by_code/{code} Retrieve gift certificate by code
getGiftCertificateByOid POST /gift_certificate/gift_certificates/{gift_certificate_oid} Retrieve gift certificate by oid
getGiftCertificatesByEmail POST /gift_certificate/gift_certificates/by_email/{email} Retrieve gift certificate by email
getGiftCertificatesByQuery POST /gift_certificate/gift_certificates/query Retrieve gift certificates by query
updateGiftCertificate PUT /gift_certificate/gift_certificates/{gift_certificate_oid} Update a gift certificate

addGiftCertificateLedgerEntry

GiftCertificateResponse addGiftCertificateLedgerEntry(gift_certificate_oid, gift_certificate_ledger_entry)

Add a gift certificate ledger entry

Adds a ledger entry for this gift certificate.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.GiftCertificateApi();


var gift_certificate_oid = 56; // Number | 

var gift_certificate_ledger_entry = new UltraCartRestApiV2.GiftCertificateLedgerEntry(); // GiftCertificateLedgerEntry | Gift certificate ledger entry


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.addGiftCertificateLedgerEntry(gift_certificate_oid, gift_certificate_ledger_entry, callback);

Parameters

Name Type Description Notes
gift_certificate_oid Number
gift_certificate_ledger_entry GiftCertificateLedgerEntry Gift certificate ledger entry

Return type

GiftCertificateResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createGiftCertificate

GiftCertificateResponse createGiftCertificate(gift_certificate_create_request)

Create a gift certificate

Creates a gift certificate for this merchant account.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.GiftCertificateApi();


var gift_certificate_create_request = new UltraCartRestApiV2.GiftCertificateCreateRequest(); // GiftCertificateCreateRequest | Gift certificate create request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createGiftCertificate(gift_certificate_create_request, callback);

Parameters

Name Type Description Notes
gift_certificate_create_request GiftCertificateCreateRequest Gift certificate create request

Return type

GiftCertificateResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteGiftCertificate

deleteGiftCertificate(gift_certificate_oid)

Delete a gift certificate

Deletes a gift certificate for this merchant account.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.GiftCertificateApi();


var gift_certificate_oid = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteGiftCertificate(gift_certificate_oid, callback);

Parameters

Name Type Description Notes
gift_certificate_oid Number

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getGiftCertificateByCode

GiftCertificateResponse getGiftCertificateByCode(code)

Retrieve gift certificate by code

Retrieves a gift certificate from the account based on the code (the value the customer enters at checkout time).

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.GiftCertificateApi();


var code = "code_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getGiftCertificateByCode(code, callback);

Parameters

Name Type Description Notes
code String

Return type

GiftCertificateResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getGiftCertificateByOid

GiftCertificateResponse getGiftCertificateByOid(gift_certificate_oid)

Retrieve gift certificate by oid

Retrieves a gift certificate from the account based on the internal primary key.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.GiftCertificateApi();


var gift_certificate_oid = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getGiftCertificateByOid(gift_certificate_oid, callback);

Parameters

Name Type Description Notes
gift_certificate_oid Number

Return type

GiftCertificateResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getGiftCertificatesByEmail

GiftCertificatesResponse getGiftCertificatesByEmail(email)

Retrieve gift certificate by email

Retrieves all gift certificates from the account based on customer email.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.GiftCertificateApi();


var email = "email_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getGiftCertificatesByEmail(email, callback);

Parameters

Name Type Description Notes
email String

Return type

GiftCertificatesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getGiftCertificatesByQuery

GiftCertificatesResponse getGiftCertificatesByQuery(gift_certificate_query, opts)

Retrieve gift certificates by query

Retrieves gift certificates from the account. If no parameters are specified, all gift certificates will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.GiftCertificateApi();


var gift_certificate_query = new UltraCartRestApiV2.GiftCertificateQuery(); // GiftCertificateQuery | Gift certificates query

var opts = { 
  '_limit': 100, // Number | The maximum number of records to return on this one API call. (Max 200)
  '_offset': 0, // Number | Pagination of the record set.  Offset is a zero based index.
  '_since': "_since_example", // String | Fetch customers that have been created/modified since this date/time.
  '_sort': "_sort_example", // String | The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
  '_expand': "_expand_example" // String | The object expansion to perform on the result.  See documentation for examples
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getGiftCertificatesByQuery(gift_certificate_query, opts, callback);

Parameters

Name Type Description Notes
gift_certificate_query GiftCertificateQuery Gift certificates query
_limit Number The maximum number of records to return on this one API call. (Max 200) [optional] [default to 100]
_offset Number Pagination of the record set. Offset is a zero based index. [optional] [default to 0]
_since String Fetch customers that have been created/modified since this date/time. [optional]
_sort String The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. [optional]
_expand String The object expansion to perform on the result. See documentation for examples [optional]

Return type

GiftCertificatesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateGiftCertificate

GiftCertificateResponse updateGiftCertificate(gift_certificate_oid, gift_certificate)

Update a gift certificate

Update a gift certificate for this merchant account.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.GiftCertificateApi();


var gift_certificate_oid = 56; // Number | 

var gift_certificate = new UltraCartRestApiV2.GiftCertificate(); // GiftCertificate | Gift certificate


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateGiftCertificate(gift_certificate_oid, gift_certificate, callback);

Parameters

Name Type Description Notes
gift_certificate_oid Number
gift_certificate GiftCertificate Gift certificate

Return type

GiftCertificateResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json