Gift Certificates
Get a Gift Certificate
GET https://api.bigcommerce.com/stores/{store_hash}/v2/gift_certificates/{id}Request
Returns a single Gift Certificate.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- id in path - integerrequired
ID of the gift certificate.
example
Response
Body
application/json
example
Update a Gift Certificate
PUT https://api.bigcommerce.com/stores/{store_hash}/v2/gift_certificates/{id}Request
Updates a Gift Certificate.
Read Only Fields
- id
- order_id
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- id in path - integerrequired
ID of the gift certificate.
Body
application/json
example
Response
Body
application/json
example
Delete a Gift Certificate
DELETE https://api.bigcommerce.com/stores/{store_hash}/v2/gift_certificates/{id}Request
Deletes a Gift Certificate.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- id in path - integerrequired
ID of the gift certificate.
example
Response
Get All Gift Certificates
GET https://api.bigcommerce.com/stores/{store_hash}/v2/gift_certificatesRequest
Returns a list of Gift Certificates. Optional filter parameters can be passed in.
Default sorting is by gift-certificate id, from lowest to highest.
The maximum limit is 250. If a limit isn’t provided, up to 50 gift_certificates are returned by default.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- min_id in query - integer
- max_id in query - integer
- code in query - string
- order_id in query - integer
- to_name in query - string
- to_email in query - string
- from_name in query - string
- from_email in query - string
- page in query - number
- limit in query - number
example
Response
Body
array | application/json
example
Create a Gift Certificate
POST https://api.bigcommerce.com/stores/{store_hash}/v2/gift_certificatesRequest
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.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
application/json
example
Response
Body
application/json
example
Delete All Gift Certificates
DELETE https://api.bigcommerce.com/stores/{store_hash}/v2/gift_certificatesRequest
By default, it deletes all Gift Certificates.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
object | application/json
example
Did you find what you were looking for?