ultracart.GiftCertificateApi

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

Method	HTTP request	Description
add_gift_certificate_ledger_entry	POST /gift_certificate/gift_certificates/{gift_certificate_oid}/ledger_entry	Add a gift certificate ledger entry
create_gift_certificate	POST /gift_certificate/gift_certificates	Create a gift certificate
delete_gift_certificate	DELETE /gift_certificate/gift_certificates/{gift_certificate_oid}	Delete a gift certificate
get_gift_certificate_by_code	POST /gift_certificate/gift_certificates/by_code/{code}	Retrieve gift certificate by code
get_gift_certificate_by_oid	POST /gift_certificate/gift_certificates/{gift_certificate_oid}	Retrieve gift certificate by oid
get_gift_certificates_by_email	POST /gift_certificate/gift_certificates/by_email/{email}	Retrieve gift certificate by email
get_gift_certificates_by_query	POST /gift_certificate/gift_certificates/query	Retrieve gift certificates by query
update_gift_certificate	PUT /gift_certificate/gift_certificates/{gift_certificate_oid}	Update a gift certificate

add_gift_certificate_ledger_entry

GiftCertificateResponse add_gift_certificate_ledger_entry(gift_certificate_oid, gift_certificate_ledger_entry)

Add a gift certificate ledger entry

Adds a ledger entry for this gift certificate.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.GiftCertificateApi.fromApiKey(simple_key, False, True)

gift_certificate_oid = 56 # int | 
gift_certificate_ledger_entry = ultracart.GiftCertificateLedgerEntry() # GiftCertificateLedgerEntry | Gift certificate ledger entry

try:
    # Add a gift certificate ledger entry
    api_response = api_instance.add_gift_certificate_ledger_entry(gift_certificate_oid, gift_certificate_ledger_entry)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GiftCertificateApi->add_gift_certificate_ledger_entry: %s\n" % e)

Parameters

Name	Type	Description	Notes
gift_certificate_oid	int
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

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

create_gift_certificate

GiftCertificateResponse create_gift_certificate(gift_certificate_create_request)

Create a gift certificate

Creates a gift certificate for this merchant account.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.GiftCertificateApi.fromApiKey(simple_key, False, True)

gift_certificate_create_request = ultracart.GiftCertificateCreateRequest() # GiftCertificateCreateRequest | Gift certificate create request

try:
    # Create a gift certificate
    api_response = api_instance.create_gift_certificate(gift_certificate_create_request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GiftCertificateApi->create_gift_certificate: %s\n" % e)

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

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

delete_gift_certificate

delete_gift_certificate(gift_certificate_oid)

Delete a gift certificate

Deletes a gift certificate for this merchant account.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.GiftCertificateApi.fromApiKey(simple_key, False, True)

gift_certificate_oid = 56 # int | 

try:
    # Delete a gift certificate
    api_instance.delete_gift_certificate(gift_certificate_oid)
except ApiException as e:
    print("Exception when calling GiftCertificateApi->delete_gift_certificate: %s\n" % e)

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]

get_gift_certificate_by_code

GiftCertificateResponse get_gift_certificate_by_code(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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.GiftCertificateApi.fromApiKey(simple_key, False, True)

code = 'code_example' # str | 

try:
    # Retrieve gift certificate by code
    api_response = api_instance.get_gift_certificate_by_code(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GiftCertificateApi->get_gift_certificate_by_code: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str

Return type

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]

get_gift_certificate_by_oid

GiftCertificateResponse get_gift_certificate_by_oid(gift_certificate_oid)

Retrieve gift certificate by oid

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

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.GiftCertificateApi.fromApiKey(simple_key, False, True)

gift_certificate_oid = 56 # int | 

try:
    # Retrieve gift certificate by oid
    api_response = api_instance.get_gift_certificate_by_oid(gift_certificate_oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GiftCertificateApi->get_gift_certificate_by_oid: %s\n" % e)

Parameters

Name	Type	Description	Notes
gift_certificate_oid	int

Return type

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]

get_gift_certificates_by_email

GiftCertificatesResponse get_gift_certificates_by_email(email)

Retrieve gift certificate by email

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

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.GiftCertificateApi.fromApiKey(simple_key, False, True)

email = 'email_example' # str | 

try:
    # Retrieve gift certificate by email
    api_response = api_instance.get_gift_certificates_by_email(email)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GiftCertificateApi->get_gift_certificates_by_email: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str

Return type

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]

get_gift_certificates_by_query

GiftCertificatesResponse get_gift_certificates_by_query(gift_certificate_query, limit=limit, offset=offset, since=since, sort=sort, expand=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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.GiftCertificateApi.fromApiKey(simple_key, False, True)

gift_certificate_query = ultracart.GiftCertificateQuery() # GiftCertificateQuery | Gift certificates query
limit = 100 # int | The maximum number of records to return on this one API call. (Max 200) (optional) (default to 100)
offset = 0 # int | Pagination of the record set.  Offset is a zero based index. (optional) (default to 0)
since = 'since_example' # str | Fetch customers that have been created/modified since this date/time. (optional)
sort = 'sort_example' # str | The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. (optional)
expand = 'expand_example' # str | The object expansion to perform on the result.  See documentation for examples (optional)

try:
    # Retrieve gift certificates by query
    api_response = api_instance.get_gift_certificates_by_query(gift_certificate_query, limit=limit, offset=offset, since=since, sort=sort, expand=expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GiftCertificateApi->get_gift_certificates_by_query: %s\n" % e)

Parameters

Name	Type	Description	Notes
gift_certificate_query	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	str	Fetch customers that have been created/modified since this date/time.	[optional]
sort	str	The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]
expand	str	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

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

update_gift_certificate

GiftCertificateResponse update_gift_certificate(gift_certificate_oid, gift_certificate)

Update a gift certificate

Update a gift certificate for this merchant account.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.GiftCertificateApi.fromApiKey(simple_key, False, True)

gift_certificate_oid = 56 # int | 
gift_certificate = ultracart.GiftCertificate() # GiftCertificate | Gift certificate

try:
    # Update a gift certificate
    api_response = api_instance.update_gift_certificate(gift_certificate_oid, gift_certificate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GiftCertificateApi->update_gift_certificate: %s\n" % e)

Parameters

Name	Type	Description	Notes
gift_certificate_oid	int
gift_certificate	GiftCertificate	Gift certificate

Return type

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.GiftCertificateApi

add_gift_certificate_ledger_entry

Example

Parameters

Return type

Authorization

HTTP request headers

create_gift_certificate

Example

Parameters

Return type

Authorization

HTTP request headers

delete_gift_certificate

Example

Parameters

Return type

Authorization

HTTP request headers

get_gift_certificate_by_code

Example

Parameters

Return type

Authorization

HTTP request headers

get_gift_certificate_by_oid

Example

Parameters

Return type

Authorization

HTTP request headers

get_gift_certificates_by_email

Example

Parameters

Return type

Authorization

HTTP request headers

get_gift_certificates_by_query

Example

Parameters

Return type

Authorization

HTTP request headers

update_gift_certificate

Example

Parameters

Return type

Authorization

HTTP request headers