post

/gift_certificates

Creates a Gift Certificate.

Required Fields

  • to_name
  • to_email
  • from_name
  • from_email
  • amount

Read Only Fields

  • id
  • order_id

Notes

When a gift certificate is created through the API, no email notification is triggered to the specified recipient.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

2 Headers

Request Body

1 Example
Schema
object
to_name
string

Name of the recipient.

1 validation + required
to_email
string

Email of the recipient.

1 validation + required
from_name
string

Name of the customer who purchased the gift certificate.

1 validation + required
from_email
string

Email of the customer who purchased the gift certificate.

1 validation + required
amount
string

Value of the gift certificate.

1 validation + required
balance
string

Remaining value of the gift certificate. If not set, will default to the amount.

1 validation
purchase_date
string

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

1 validation
expiry_date
string

Date on which the gift certificate is set to expire.

1 validation
customer_id
integer

The ID of the customer placing the order.

1 validation
template
string

The email theme to use in the message sent to the recipient.

2 validations
message
string

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

1 validation
code
string

A unique string that the customer can input to redeem the gift certificate. If this field is not set, a value will be generated.

1 validation
status
string
2 validations

Responses

1 Example
Schema
object
to_name
string

Name of the recipient.

1 validation + required
to_email
string

Email of the recipient.

1 validation + required
from_name
string

Name of the customer who purchased the gift certificate.

1 validation + required
from_email
string

Email of the customer who purchased the gift certificate.

1 validation + required
amount
string

Value of the gift certificate.

1 validation + required
id
integer

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.

1 validation
customer_id
integer

The ID of the customer placing the order.

1 validation
order_id
integer

The ID of the order.

1 validation
balance
string

Remaining value of the gift certificate. If not set, will default to the amount.

1 validation
purchase_date
string

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

1 validation
expiry_date
string

Date on which the gift certificate is set to expire.

template
string

The email theme to use in the message sent to the recipient.

2 validations
message
string

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

1 validation
code
string

A unique string that the customer can input to redeem the gift certificate. If this field is not set, a value will be generated.

1 validation
status
string
2 validations

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
2 variables not set
store_hash
X-Auth-Token
X-Auth-Client