Gift Card Activation Event
The Gift Card Activation event is sent when a Virtual Gift Card has been activated.
Radial supports two different ways to receive event messages from this API and other event-based APIs.
-
If you use the queue-based implementation with AMQP, each event is sent in its own OrderGiftCardActivation message.
-
If you use the webhooks-based implementation, a set of events is grouped together in an OrderGiftCardActivationList message.
Schemas:
- Order-GiftCardActivation-Event-1.0.xsd
- Checkout-Datatypes-1.0.xsd
- Order-Common-Event-1.0.xsd
- Order-Datatypes-Common-1.0.xsd
- Payment-Datatypes-1.0.xsd
- Payment-Datatypes-CurrencyCode-1.0.xsd
Gift Card Event Types:
- Gift Certificate Purchaser
- Gift Certificate Recipient
XPath: /OrderGiftCardActivation/OrderGiftCardActivations/GiftCertificate/@giftCertificateAction
| Gift Certificate Purchaser |
<OrderGiftCardActivations> |
| Gift Certificate Recipient |
<OrderGiftCardActivations> |
OrderGiftCardActivation Message
For queue-based implementations, a new OrderGiftCardActivation message is generated for each new event.
Queue name: q.Order.GiftCertificate.Purchase.1-0,<StoreCode>.2-0
Single-Event Message Examples
Click any heading below to view the example message.
Example Message: Gift Card Activation Sent to Purchaser
Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderGiftCardActivation xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="00012121232" storeId="TMS_US" locale="en_US" orderDate="2015-08-01T00:35:02+00:00" currency="USD" currencySymbol="$">
<Customer customerId="0001212131112">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
</Customer>
<BillingAddress>
<PersonName>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</PersonName>
<Address>
<Line1>123 Test market st</Line1>
<City>King Of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<PhoneNumber />
<EmailAddress />
</BillingAddress>
<OrderGiftCardActivations>
<GiftCertificate giftCertificateAction="Purchaser" denomination="50.00" giftCertCode="5123455566" giftCertSecondaryCode="" giftCertPin="1202" giftCertFaceIdentifier="9-923423422" to="test" from="User" message="Hello" />
</OrderGiftCardActivations>
</OrderGiftCardActivation>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderGiftCardActivation xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="000123123123" storeId="TMS_US" locale="en_US" orderDate="2015-08-01T00:35:02+00:00" currency="USD" currencySymbol="$">
<Customer customerId="00012121212">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
</Customer>
<BillingAddress>
<PersonName>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</PersonName>
<Address>
<Line1>123 Test market st</Line1>
<City>King Of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<PhoneNumber />
<EmailAddress />
</BillingAddress>
<OrderGiftCardActivations>
<GiftCertificate giftCertificateAction="Recipient" denomination="50.00" giftCertCode="5123123123" giftCertSecondaryCode="" giftCertPin="1234" giftCertFaceIdentifier="9-12412412" to="test" from="User" message="" />
</OrderGiftCardActivations>
</OrderGiftCardActivation>OrderGiftCardActivationList Message
For Webhooks-based implementations, Gift Card Activation events are grouped together in one OrderGiftCardActivationList message.
Event List Message Example
Click the heading below to view the example message.
Example OrderGiftCardActivationList Message
Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderGiftCardActivationList xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<OrderGiftCardActivation customerOrderId="00012121232" storeId="TMS_US" locale="en_US" orderDate="2015-08-01T00:35:02+00:00" currency="USD" currencySymbol="$">
<Customer customerId="0001212131112">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
</Customer>
<BillingAddress>
<PersonName>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</PersonName>
<Address>
<Line1>123 Test market st</Line1>
<City>King Of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<PhoneNumber />
<EmailAddress />
</BillingAddress>
<OrderGiftCardActivations>
<GiftCertificate giftCertificateAction="Purchaser" denomination="50.00" giftCertCode="5123455566" giftCertSecondaryCode="" giftCertPin="1202" giftCertFaceIdentifier="9-923423422" to="test" from="User" message="Hello" />
</OrderGiftCardActivations>
</OrderGiftCardActivation>
<OrderGiftCardActivation customerOrderId="000123123123" storeId="TMS_US" locale="en_US" orderDate="2015-08-01T00:35:02+00:00" currency="USD" currencySymbol="$">
<Customer customerId="00012121212">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
</Customer>
<BillingAddress>
<PersonName>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</PersonName>
<Address>
<Line1>123 Test market st</Line1>
<City>King Of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<PhoneNumber />
<EmailAddress />
</BillingAddress>
<OrderGiftCardActivations>
<GiftCertificate giftCertificateAction="Recipient" denomination="50.00" giftCertCode="5123123123" giftCertSecondaryCode="" giftCertPin="1234" giftCertFaceIdentifier="9-12412412" to="test" from="User" message="" />
</OrderGiftCardActivations>
</OrderGiftCardActivation>
</OrderGiftCardActivationList>