ultracart\v2\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

\ultracart\v2\models\GiftCertificateResponse addGiftCertificateLedgerEntry($gift_certificate_oid, $gift_certificate_ledger_entry)

Add a gift certificate ledger entry

Adds a ledger entry for this gift certificate.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\GiftCertificateApi::usingApiKey($simple_key);

$gift_certificate_oid = 56; // int | 
$gift_certificate_ledger_entry = new \ultracart\v2\models\GiftCertificateLedgerEntry(); // \ultracart\v2\models\GiftCertificateLedgerEntry | Gift certificate ledger entry

try {
    $result = $apiInstance->addGiftCertificateLedgerEntry($gift_certificate_oid, $gift_certificate_ledger_entry);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GiftCertificateApi->addGiftCertificateLedgerEntry: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
gift_certificate_oid	int
gift_certificate_ledger_entry	\ultracart\v2\models\GiftCertificateLedgerEntry	Gift certificate ledger entry

Return type

\ultracart\v2\models\GiftCertificateResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createGiftCertificate

\ultracart\v2\models\GiftCertificateResponse createGiftCertificate($gift_certificate_create_request)

Create a gift certificate

Creates a gift certificate for this merchant account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\GiftCertificateApi::usingApiKey($simple_key);

$gift_certificate_create_request = new \ultracart\v2\models\GiftCertificateCreateRequest(); // \ultracart\v2\models\GiftCertificateCreateRequest | Gift certificate create request

try {
    $result = $apiInstance->createGiftCertificate($gift_certificate_create_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GiftCertificateApi->createGiftCertificate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
gift_certificate_create_request	\ultracart\v2\models\GiftCertificateCreateRequest	Gift certificate create request

Return type

\ultracart\v2\models\GiftCertificateResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteGiftCertificate

deleteGiftCertificate($gift_certificate_oid)

Delete a gift certificate

Deletes a gift certificate for this merchant account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\GiftCertificateApi::usingApiKey($simple_key);

$gift_certificate_oid = 56; // int | 

try {
    $apiInstance->deleteGiftCertificate($gift_certificate_oid);
} catch (Exception $e) {
    echo 'Exception when calling GiftCertificateApi->deleteGiftCertificate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
gift_certificate_oid	int

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGiftCertificateByCode

\ultracart\v2\models\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

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\GiftCertificateApi::usingApiKey($simple_key);

$code = "code_example"; // string | 

try {
    $result = $apiInstance->getGiftCertificateByCode($code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GiftCertificateApi->getGiftCertificateByCode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
code	string

Return type

\ultracart\v2\models\GiftCertificateResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGiftCertificateByOid

\ultracart\v2\models\GiftCertificateResponse getGiftCertificateByOid($gift_certificate_oid)

Retrieve gift certificate by oid

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\GiftCertificateApi::usingApiKey($simple_key);

$gift_certificate_oid = 56; // int | 

try {
    $result = $apiInstance->getGiftCertificateByOid($gift_certificate_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GiftCertificateApi->getGiftCertificateByOid: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
gift_certificate_oid	int

Return type

\ultracart\v2\models\GiftCertificateResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGiftCertificatesByEmail

\ultracart\v2\models\GiftCertificatesResponse getGiftCertificatesByEmail($email)

Retrieve gift certificate by email

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\GiftCertificateApi::usingApiKey($simple_key);

$email = "email_example"; // string | 

try {
    $result = $apiInstance->getGiftCertificatesByEmail($email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GiftCertificateApi->getGiftCertificatesByEmail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
email	string

Return type

\ultracart\v2\models\GiftCertificatesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGiftCertificatesByQuery

\ultracart\v2\models\GiftCertificatesResponse getGiftCertificatesByQuery($gift_certificate_query, $_limit, $_offset, $_since, $_sort, $_expand)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\GiftCertificateApi::usingApiKey($simple_key);

$gift_certificate_query = new \ultracart\v2\models\GiftCertificateQuery(); // \ultracart\v2\models\GiftCertificateQuery | Gift certificates query
$_limit = 100; // int | The maximum number of records to return on this one API call. (Max 200)
$_offset = 0; // int | 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

try {
    $result = $apiInstance->getGiftCertificatesByQuery($gift_certificate_query, $_limit, $_offset, $_since, $_sort, $_expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GiftCertificateApi->getGiftCertificatesByQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
gift_certificate_query	\ultracart\v2\models\GiftCertificateQuery	Gift certificates query
_limit	int	The maximum number of records to return on this one API call. (Max 200)	[optional] [default to 100]
_offset	int	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

\ultracart\v2\models\GiftCertificatesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateGiftCertificate

\ultracart\v2\models\GiftCertificateResponse updateGiftCertificate($gift_certificate_oid, $gift_certificate)

Update a gift certificate

Update a gift certificate for this merchant account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\GiftCertificateApi::usingApiKey($simple_key);

$gift_certificate_oid = 56; // int | 
$gift_certificate = new \ultracart\v2\models\GiftCertificate(); // \ultracart\v2\models\GiftCertificate | Gift certificate

try {
    $result = $apiInstance->updateGiftCertificate($gift_certificate_oid, $gift_certificate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GiftCertificateApi->updateGiftCertificate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
gift_certificate_oid	int
gift_certificate	\ultracart\v2\models\GiftCertificate	Gift certificate

Return type

\ultracart\v2\models\GiftCertificateResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

GiftCertificateApi.md

Latest commit

History

GiftCertificateApi.md

File metadata and controls

ultracart\v2\GiftCertificateApi

addGiftCertificateLedgerEntry

Example

Parameters

Return type

Authorization

HTTP request headers

createGiftCertificate

Example

Parameters

Return type

Authorization

HTTP request headers

deleteGiftCertificate

Example

Parameters

Return type

Authorization

HTTP request headers

getGiftCertificateByCode

Example

Parameters

Return type

Authorization

HTTP request headers

getGiftCertificateByOid

Example

Parameters

Return type

Authorization

HTTP request headers

getGiftCertificatesByEmail

Example

Parameters

Return type

Authorization

HTTP request headers

getGiftCertificatesByQuery

Example

Parameters

Return type

Authorization

HTTP request headers

updateGiftCertificate

Example

Parameters

Return type

Authorization

HTTP request headers