Order Cancellation Event
The Order Cancellation event contains items that have been cancelled from an order.
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 OrderCancelled message. These events can be sent in XML or JSON.
-
If you use the webhooks-based implementation, a set of events is grouped together in an OrderCancelledList message. These list events can be sent in XML or JSON.
Queue name: q.Order.Cancellation.<StoreCode>.2-0
XML Schemas:
- Order-Cancel-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
Cancel Reason Codes
- CancelCustomerInitiated
- CancelGeneric
- CreditFailure
- CustomerRequested
- FraudLikely
- InvalidBillingAddress
- ZeroCostReship
- CancelInventoryDiscrepancy
- CancelMXCustomerAbandon
- FTCCancel
- InvalidShippingAddress
- CancelCredit
- LastShipmentCancel
- PromotionError
- CancelDuplicateOrder
- CancelMXOutOfStock
- CancelMXPickDecline
- CancelMXCustomerAbandon
- CancelMXCreditCustomerRefusal
- CancelMXStoreInactivity
- STSProductReceivedDamagedExterior
- STSPackageNotReceived
- STSProductReceivedDamagedInterior
- STSWrongProductReceived
- STSProductNotReceived
XPath: /OrderCancelled/OrderCancelReason
Example: <OrderCancelReason cancelReasonCode="EP">CancelCustomerInitiated</OrderCancelReason>
OrderCancelled Message
For queue-based implementations, a new OrderCancelled message is generated for each new event.
Single-Event Message Examples
Click any heading below to view the example message.
Example Message: CancelCustomerInitiated
Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="325111" storeId="StoreCode" locale="en_US" orderDate="2017-01-10T20:49:23+00:00" currencySymbol="$" currency="USD">
<Customer customerId="18947111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="EP">CancelCustomerInitiated</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Peoria</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>61614</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-sku130003" quantity="1">
<Description>
<Description>Gift Card</Description>
<SKU>1221212</SKU>
<UPC />
<GlobalId>1221212</GlobalId>
<Title>Gift Card</Title>
<Color id="" />
<Size id="" />
<StyleNumber />
<VendorPartNumber />
</Description>
<Pricing>
<Amount>25.00</Amount>
<UnitPrice>25.00</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>25.00</PaymentAmount>
<ExpirationDate>16-09</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="25.00" salesTaxAmount="0.00" giftWrapAmount="0.00" subTotalAmount="25.00" shippingAmount="0.00" dutyAmount="0.00" feesAmount="0.00" discountAmount="6.95" />
</OrderCancelled>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="27656123" storeId="StoreCode" locale="en_US" orderDate="2017-02-04T15:45:32+00:00" currencySymbol="$" currency="USD">
<Customer customerId="525428111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="OTH">CancelGeneric</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Rockford</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>12345</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-1568946" quantity="1">
<Description>
<Description>Nike Revolution 3 10.5-3</Description>
<SKU>123456</SKU>
<UPC>12345693796</UPC>
<GlobalId>1234562</GlobalId>
<Title>Nike Revolution 3 10.5-3</Title>
<Color id="172070">Jade/Vlt/Trg/Wt</Color>
<Size id="50655">13.5M</Size>
<StyleNumber>88026</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>52.00</Amount>
<UnitPrice>52.00</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>PY</PaymentDescription>
<PaymentTenderType>PayPal</PaymentTenderType>
<PaymentMaskedAccount>************YPAL</PaymentMaskedAccount>
<PaymentAmount>62.63</PaymentAmount>
<ExpirationDate>00-02</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="62.63" salesTaxAmount="3.68" giftWrapAmount="0.00" subTotalAmount="52.00" shippingAmount="6.95" dutyAmount="0.00" feesAmount="0.00" discountAmount="0.00" />
</OrderCancelled>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="6791111" storeId="StoreCode" locale="en_US" orderDate="2017-01-31T04:53:17+00:00" currencySymbol="$" currency="USD">
<Customer customerId="37111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="YT">CreditFailure</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Perris</City>
<MainDivision>CA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>92571</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-1556432" quantity="1">
<Description>
<Description>Skechers Sweet Life 12109</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Skechers Sweet Life 12109</Title>
<Color id="170746">Navy/Lt Blue</Color>
<Size id="50515">10M</Size>
<StyleNumber>89318</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>65.08</Amount>
<UnitPrice>69.98</UnitPrice>
</Pricing>
</OrderItem>
<OrderItem webLineId="3" itemId="67-1561048" quantity="1">
<Description>
<Description>Nike Zoom Ascention</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Nike Zoom Ascention</Title>
<Color id="171220">Bk/Wht/Crim 003</Color>
<Size id="50415">7.5M</Size>
<StyleNumber>89419</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>79.02</Amount>
<UnitPrice>84.98</UnitPrice>
</Pricing>
</OrderItem>
<OrderItem webLineId="2" itemId="67-1562887" quantity="1">
<Description>
<Description>Nike Tanjun BR</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Nike Tanjun BR</Title>
<Color id="171415">Blue/White</Color>
<Size id="50475">9M</Size>
<StyleNumber>89597</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>55.78</Amount>
<UnitPrice>59.98</UnitPrice>
</Pricing>
</OrderItem>
<OrderItem webLineId="4" itemId="67-1600921" quantity="1">
<Description>
<Description>Adidas NEO Cloudfoam Race WTR</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Adidas NEO Cloudfoam Race WTR</Title>
<Color id="175121">Onix/Blk/Gold</Color>
<Size id="50495">9.5M</Size>
<StyleNumber>91268</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>65.04</Amount>
<UnitPrice>69.98</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>287.87</PaymentAmount>
<ExpirationDate>20-01</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="287.87" salesTaxAmount="0.00" giftWrapAmount="0.00" subTotalAmount="264.92" shippingAmount="22.95" dutyAmount="0.00" feesAmount="0.00" discountAmount="20.00" />
</OrderCancelled>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="8801111" storeId="StoreCode" locale="en_US" orderDate="2017-02-10T20:11:46+00:00" currencySymbol="$" currency="USD">
<Customer customerId="26971111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="MX1">CustomerRequested</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Belleville</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>62220</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-1608420" quantity="1">
<Description>
<Description>Vans Ward</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Vans Ward</Title>
<Color id="175891">Black/Wht Suede</Color>
<Size id="50635">13M</Size>
<StyleNumber>91632</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>54.99</Amount>
<UnitPrice>54.99</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>MC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>59.40</PaymentAmount>
<ExpirationDate>20-11</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="59.40" salesTaxAmount="4.41" giftWrapAmount="0.00" subTotalAmount="54.99" shippingAmount="0.00" dutyAmount="0.00" feesAmount="0.00" discountAmount="0.00" />
</OrderCancelled>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="2871111" storeId="StoreCode" locale="en_US" orderDate="2017-02-10T19:00:28+00:00" currencySymbol="$" currency="USD">
<Customer customerId="6951111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="XU">FraudLikely</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Hialeah</City>
<MainDivision>FL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>33018</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-1571480" quantity="1">
<Description>
<Description>Nike Air Max Motion LW SE</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Nike Air Max Motion LW SE</Title>
<Color id="172244">Black/Gum/Org</Color>
<Size id="50475">9M</Size>
<StyleNumber>89966</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>85.00</Amount>
<UnitPrice>85.00</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>90.95</PaymentAmount>
<ExpirationDate>19-09</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="90.95" salesTaxAmount="5.95" giftWrapAmount="0.00" subTotalAmount="85.00" shippingAmount="0.00" dutyAmount="0.00" feesAmount="0.00" discountAmount="6.95" />
</OrderCancelled>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="2846111" storeId="StoreCode" locale="en_US" orderDate="2017-02-09T04:02:50+00:00" currencySymbol="$" currency="USD">
<Customer customerId="651111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="FB">InvalidBillingAddress</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Fenton</City>
<MainDivision>MO</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>63026</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-1566168" quantity="1">
<Description>
<Description>Vans Atwood Textile</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Vans Atwood Textile</Title>
<Color id="171747">Rock Gry/Blk/Wh</Color>
<Size id="50475">9M</Size>
<StyleNumber>83094</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>59.99</Amount>
<UnitPrice>59.99</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************0000</PaymentMaskedAccount>
<PaymentAmount>69.77</PaymentAmount>
<ExpirationDate>17-10</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="69.77" salesTaxAmount="2.83" giftWrapAmount="0.00" subTotalAmount="59.99" shippingAmount="6.95" dutyAmount="0.00" feesAmount="0.00" discountAmount="0.00" />
</OrderCancelled>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="4083977111" storeId="StoreCode" locale="en_US" orderDate="2015-02-23T09:56:37+00:00" currencySymbol="$" currency="USD">
<Customer customerId="54321">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="ZCR">ZeroCostReship</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>630 Allendale Rd.</Line1>
<City>King of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<PhoneNumber>2155551212</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="2" itemId="21-2015223002" quantity="1">
<Description>
<Description>GWEN QUEEN BIAB</Description>
<SKU>2015223002</SKU>
<UPC />
<GlobalId>2015223002</GlobalId>
<Title>GWEN QUEEN BIAB</Title>
<Color id="x">Red</Color>
<Size id="b">10</Size>
<StyleNumber />
<VendorPartNumber>415</VendorPartNumber>
</Description>
<Pricing>
<Amount>0.00</Amount>
<UnitPrice>10.00</UnitPrice>
</Pricing>
</OrderItem>
<OrderItem webLineId="1" itemId="21-2015223003" quantity="2">
<Description>
<Description>Men's Leather Riveted Belt</Description>
<SKU>2015223003</SKU>
<UPC />
<GlobalId>2015223003</GlobalId>
<Title>Men's Leather Riveted Belt</Title>
<Color id="x">Red</Color>
<Size id="b">10</Size>
<StyleNumber />
<VendorPartNumber>415</VendorPartNumber>
</Description>
<Pricing>
<Amount>199.98</Amount>
<UnitPrice>99.99</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>AM</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>200.00</PaymentAmount>
<ExpirationDate>16-12</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="199.98" salesTaxAmount="0.00" giftWrapAmount="0.00" subTotalAmount="199.98" shippingAmount="0.00" dutyAmount="0.00" feesAmount="0.00" discountAmount="10.00" />
</OrderCancelled>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="2550711" storeId="StoreCode" locale="en_US" orderDate="2017-01-24T21:37:10+00:00" currencySymbol="$" currency="USD">
<Customer customerId="22751111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="OS">CancelInventoryDiscrepancy</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Streator</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>61364</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-sku130003" quantity="1">
<Description>
<Description>Gift Card</Description>
<SKU>12345666</SKU>
<UPC />
<GlobalId>12345666</GlobalId>
<Title>Gift Card</Title>
<Color id="" />
<Size id="" />
<StyleNumber />
<VendorPartNumber />
</Description>
<Pricing>
<Amount>25.00</Amount>
<UnitPrice>25.00</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>MC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>25.00</PaymentAmount>
<ExpirationDate>21-06</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="25.00" salesTaxAmount="0.00" giftWrapAmount="0.00" subTotalAmount="25.00" shippingAmount="0.00" dutyAmount="0.00" feesAmount="0.00" discountAmount="0.00" />
</OrderCancelled>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="24410111" storeId="StoreCode" locale="en_US" orderDate="2017-01-19T22:18:26+00:00" currencySymbol="$" currency="USD">
<Customer customerId="774081111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="MX7">CancelMXCustomerAbandon</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<Line2>802</Line2>
<City>City Raton</City>
<MainDivision>FL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>11111</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-1352246" quantity="1">
<Description>
<Description>Madison Ave. Chuck 11-7</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Madison Ave. Chuck 11-7</Title>
<Color id="151845">Brown</Color>
<Size id="50395">7M</Size>
<StyleNumber>80204</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>19.98</Amount>
<UnitPrice>19.98</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************0000</PaymentMaskedAccount>
<PaymentAmount>21.18</PaymentAmount>
<ExpirationDate>18-08</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="21.18" salesTaxAmount="1.20" giftWrapAmount="0.00" subTotalAmount="19.98" shippingAmount="0.00" dutyAmount="0.00" feesAmount="0.00" discountAmount="0.00" />
</OrderCancelled>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="27656123" storeId="StoreCode" locale="en_US" orderDate="2017-02-04T15:45:32+00:00" currencySymbol="$" currency="USD">
<Customer customerId="00032525428111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="FC">FTCCancel</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Rockford</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>11111</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-1568946" quantity="1">
<Description>
<Description>Nike Revolution 3 10.5-3</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Nike Revolution 3 10.5-3</Title>
<Color id="172070">Jade/Vlt/Trg/Wt</Color>
<Size id="50655">13.5M</Size>
<StyleNumber>88026</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>52.00</Amount>
<UnitPrice>52.00</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>PY</PaymentDescription>
<PaymentTenderType>PayPal</PaymentTenderType>
<PaymentMaskedAccount>************YPAL</PaymentMaskedAccount>
<PaymentAmount>62.63</PaymentAmount>
<ExpirationDate>00-02</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="62.63" salesTaxAmount="3.68" giftWrapAmount="0.00" subTotalAmount="52.00" shippingAmount="6.95" dutyAmount="0.00" feesAmount="0.00" discountAmount="0.00" />
</OrderCancelled>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="27806111" storeId="StoreCode" locale="en_US" orderDate="2017-02-05T15:30:10+00:00" currencySymbol="$" currency="USD">
<Customer customerId="525641111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="MX0">CancelMXOutOfStock</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Glenshaw</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>12345</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-1515461" quantity="1">
<Description>
<Description>Unr8ed Mavis</Description>
<SKU>42381515</SKU>
<UPC>753332974074</UPC>
<GlobalId>42381515</GlobalId>
<Title>Unr8ed Mavis</Title>
<Color id="166592">Black</Color>
<Size id="50435">8M</Size>
<StyleNumber>87320</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>16.00</Amount>
<UnitPrice>20.00</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>22.95</PaymentAmount>
<ExpirationDate>19-09</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="22.95" salesTaxAmount="0.00" giftWrapAmount="0.00" subTotalAmount="16.00" shippingAmount="6.95" dutyAmount="0.00" feesAmount="0.00" discountAmount="4.00" />
</OrderCancelled>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelled xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="6981116" storeId="StoreCode" locale="en_US" orderDate="2017-02-10T15:21:36+00:00" currencySymbol="$" currency="USD">
<Customer customerId="69611119">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="IPD">CancelMXPickDecline</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Chapel Hill</City>
<MainDivision>TN</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>12345</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="4" itemId="67-1604613" quantity="1">
<Description>
<Description>Skechers Infant Doodle Days 5-12</Description>
<SKU>12345666</SKU>
<UPC>12345666119</UPC>
<GlobalId>12345666</GlobalId>
<Title>Skechers Infant Doodle Days 5-12</Title>
<Color id="175472">Grey/Pink</Color>
<Size id="50515">10M</Size>
<StyleNumber>91420</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>39.51</Amount>
<UnitPrice>44.98</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>158.91</PaymentAmount>
<ExpirationDate>18-03</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="40.60" salesTaxAmount="1.09" giftWrapAmount="0.00" subTotalAmount="39.51" shippingAmount="0.00" dutyAmount="0.00" feesAmount="0.00" discountAmount="5.47" />
</OrderCancelled>OrderCancelledList Message
For Webhooks-based implementations, Order Cancelled events are grouped together in one OrderCancelledList message.
Event List Message Example
Click the heading below to view the example message file.
Example OrderCancelledList message
Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderCancelledList xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<OrderCancelled customerOrderId="325111" storeId="StoreCode" locale="en_US" orderDate="2017-01-10T20:49:23+00:00" currencySymbol="$" currency="USD">
<Customer customerId="18947111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="EP">CancelCustomerInitiated</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Peoria</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>61614</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-sku130003" quantity="1">
<Description>
<Description>Gift Card</Description>
<SKU>1221212</SKU>
<UPC />
<GlobalId>1221212</GlobalId>
<Title>Gift Card</Title>
<Color id="" />
<Size id="" />
<StyleNumber />
<VendorPartNumber />
</Description>
<Pricing>
<Amount>25.00</Amount>
<UnitPrice>25.00</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>25.00</PaymentAmount>
<ExpirationDate>16-09</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="25.00" salesTaxAmount="0.00" giftWrapAmount="0.00" subTotalAmount="25.00" shippingAmount="0.00" dutyAmount="0.00" feesAmount="0.00" discountAmount="6.95" />
</OrderCancelled>
<OrderCancelled customerOrderId="27656123" storeId="StoreCode" locale="en_US" orderDate="2017-02-04T15:45:32+00:00" currencySymbol="$" currency="USD">
<Customer customerId="525428111">
<Name>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</Name>
<EmailAddress>email@domain.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account />
<Program />
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value />
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderCancelReason cancelReasonCode="OTH">CancelGeneric</OrderCancelReason>
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Rockford</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>12345</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<CancelledOrderItems>
<OrderItem webLineId="1" itemId="67-1568946" quantity="1">
<Description>
<Description>Nike Revolution 3 10.5-3</Description>
<SKU>123456</SKU>
<UPC>12345693796</UPC>
<GlobalId>1234562</GlobalId>
<Title>Nike Revolution 3 10.5-3</Title>
<Color id="172070">Jade/Vlt/Trg/Wt</Color>
<Size id="50655">13.5M</Size>
<StyleNumber>88026</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>52.00</Amount>
<UnitPrice>52.00</UnitPrice>
</Pricing>
</OrderItem>
</CancelledOrderItems>
<OrderCancelledPayments>
<Payment>
<PaymentDescription>PY</PaymentDescription>
<PaymentTenderType>PayPal</PaymentTenderType>
<PaymentMaskedAccount>************YPAL</PaymentMaskedAccount>
<PaymentAmount>62.63</PaymentAmount>
<ExpirationDate>00-02</ExpirationDate>
</Payment>
</OrderCancelledPayments>
<OrderSummary totalAmount="62.63" salesTaxAmount="3.68" giftWrapAmount="0.00" subTotalAmount="52.00" shippingAmount="6.95" dutyAmount="0.00" feesAmount="0.00" discountAmount="0.00" />
</OrderCancelled>
</OrderCancelledList>Example: JSON Format
Note: If you want to use the JSON format, contact your Radial representative for the XML to JSON mappings.
Copy
{
"xmlns": "http://api.gsicommerce.com/schema/checkout/1.0",
"customerOrderId": "0002650306075353",
"storeId": "TMSUS",
"locale": "en_US",
"orderDate": "2024-04-17T12:18:39.000Z",
"currencySymbol": "$",
"currency": "USD",
"customer": {
"name": {
"lastName": "Jones",
"firstName": "Indiana"
},
"emailAddress": "TESTFRAUD@radial.com",
"loyaltyPrograms": [
{
"account": null,
"program": null
}
],
"customerId": "null9241673396"
},
"orderCancelReason": {
"value": "CancelInventoryDiscrepancy",
"cancelReasonCode": "ID"
},
"billingAddress": {
"personName": {
"lastName": "Jones",
"firstName": "Indiana"
},
"address": {
"line1": "630 Allendale Road",
"city": "King of Prussia",
"mainDivision": "PA",
"countryCode": "US",
"postalCode": "19406"
},
"phoneNumber": "6102223333",
"emailAddress": "TESTFRAUD@radial.com"
},
"shippingAddress": {
"personName": {
"lastName": "Jones",
"firstName": "Indiana"
},
"address": {
"line1": "630 Allendale Road",
"city": "King of Prussia",
"mainDivision": "PA",
"countryCode": "US",
"postalCode": "19406"
},
"phoneNumber": "6102223333",
"emailAddress": "TESTFRAUD@radial.com"
},
"cancelledOrderItems": [
{
"webLineId": "2",
"itemId": "21-ISPUProd02",
"quantity": "1",
"id": "ID_1002",
"isBundleParent": false,
"description": {
"description": "Black Tennis Shoes",
"sku": "21252052",
"upc": "0360123652011",
"globalId": "21252052",
"title": "Black Tennis Shoes",
"color": {
"content": "Brown",
"id": "700"
},
"size": {
"content": "6-M",
"id": "6-M"
},
"styleNumber": "84529",
"vendorPartNumber": ""
},
"pricing": {
"amount": "114.00",
"unitPrice": "114.00"
},
"shipping": {
"shippedAddress": {
"personName": {
"lastName": "Jones",
"firstName": "Indiana"
},
"address": {
"line1": "630 Allendale Road",
"city": "King of Prussia",
"mainDivision": "PA",
"countryCode": "US",
"postalCode": "19406"
},
"phoneNumber": "6102223333",
"emailAddress": "TESTFRAUD@radial.com"
}
},
"fulfillmentMethod": "SHIP_TO_HOME",
"additionalValues": [
{
"key": "PVAR_DESC_COLOR",
"value": "Brown"
},
{
"key": "requestLineId",
"value": "item_2"
},
{
"key": "CancelReasonCode|",
"value": "ID"
},
{
"key": "CancelReasonText|",
"value": "CancelInventoryDiscrepancy"
}
]
}
],
"orderCancelledPayments": [
{
"paymentDescription": "VC",
"paymentTenderType": "CreditCard",
"paymentMaskedAccount": "***********1111",
"paymentAmount": "114.00",
"expirationDate": "2024-09"
}
],
"orderSummary": {
"totalAmount": "114.00",
"salesTaxAmount": "0.00",
"giftWrapAmount": "0.00",
"subTotalAmount": "114.00",
"shippingAmount": "0.00",
"dutyAmount": "0.00",
"feesAmount": "0.00",
"discountAmount": "0.00"
},
"additionalValues": [
{
"key": "ReferenceTransactionId",
"value": "ref123456789"
},
{
"key": "MAJOR_ORDER_GRP_ATTR",
"value": "shipgroup_1"
},
{
"key": "eventTimestamp",
"value": "2024-04-17T13:22:16.016Z"
}
]
}