Skip to navigation
RESTAdminContentMarketingGift Certificates

Get Gift Certificate

Returns a single Gift Certificate.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Marketingmodifystore_v2_marketing
Marketingread-onlystore_v2_marketing_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

idintegerRequired
ID of the gift certificate.
store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Response

OK
amountstring
Value of the gift certificate.
from_emailstring
Email of the customer who purchased the gift certificate.
from_namestring
Name of the customer who purchased the gift certificate.
to_emailstring
Email of the recipient.
to_namestring
Name of the recipient.
balancestringOptional
Remaining value of the gift certificate. If not set, will default to the amount.
codestringOptional<=255 characters

A unique string that a customer enters to redeem the gift certificate. Gift certificate codes are limited to 20 characters. The API accepts values up to 255 characters without returning an error, but it saves only the first 20 characters and discards the rest. The response returns the saved, truncated code.

If you don't set this field, BigCommerce generates a code automatically.

currency_codestringOptional

A currency code, following the ISO 4217 standard. The currency has to exist in the store first.

Gift Certificates can only be used if the transactional currency of the cart is the same as the one defined in the gift certificate. If this value is not provided, the gift certificate is created using the store's default transactional currency.

customer_idintegerOptional
The ID of the customer placing the order.
expiry_datestringOptional
Date on which the gift certificate is set to expire. Date displays in the Unix timestamp format.
idintegerOptional

The ID of the gift certificate. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.

messagestringOptional

Text that will be sent to the recipient, such as “Congratulations.”

order_idintegerOptional
The ID of the order.
purchase_datestringOptional

Date the gift certificate was purchased. If not assigned, this will be set to today’s date. Date displays in the Unix timestamp format.

statusenumOptional
Allowed values:
templateenumOptional
The email theme to use in the message sent to the recipient.