CartGiftCertificates

Returns and manages the gift certificate line items in a cart. Gift certificates cannot be updated after being added; delete and re-add the item instead.

Table Specific Information

Select

CartGiftCertificates returns the gift certificate line items in a cart. A value for CartId is required, since BigCommerce does not offer an endpoint to list gift certificate items across all carts.

SELECT * FROM CartGiftCertificates WHERE CartId = '82676093-e069-4d1d-93a2-96c1d3169dfc'

Insert

To add a gift certificate to a cart, specify at least the CartId, Theme, Quantity, Name, Amount, SenderName, SenderEmail, RecipientName, and RecipientEmail.

INSERT INTO CartGiftCertificates (CartId, Amount, SenderName, SenderEmail, RecipientName, RecipientEmail, Theme, Quantity, Name, Taxable) VALUES ('ad98ca69-8817-4cbf-aca7-2fb01237c42c',50.00, 'Jane Sender', '[email protected]', 'John Recipient', '[email protected]', 'Boy', 2, 'test', 'false')

Update

Gift certificates cannot be updated once added. To change a gift certificate, delete it and insert a new one instead.

Delete

DELETE FROM CartGiftCertificates WHERE CartId = '82676093-e069-4d1d-93a2-96c1d3169dfc' AND Id = '66e3fa1e-49ff-483b-8302-1830dcf5c33e'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier of the gift certificate line item.
CartId [KEY]	String	False	The Id of the cart this item belongs to.
Theme	String	False	The email theme used for the gift certificate notification. The allowed values are Birthday, Boy, Celebration, Christmas, General, Girl.
Amount	Decimal	False	The value of the gift certificate. Must be between 1.00 and 1,000.00.
Quantity	Integer	False	The Quantity of the gift certificate.
Name	String	False	The Name of the gift certificate.
Taxable	Boolean	False	Whether the gift certificate is taxable.
SenderName	String	False	The name of the gift certificate's sender.
SenderEmail	String	False	The email address of the gift certificate's sender.
RecipientName	String	False	The name of the gift certificate's recipient.
RecipientEmail	String	False	The email address of the gift certificate's recipient.
Message	String	False	A message to the recipient. Maximum of 200 characters.