Order Confirmation Event
An Order Confirmation event occurs when the Order Management System takes an order through all holds and fraud checks and starts processing the order. At the time of the Order Confirmation event, the order is sent to the warehouse.
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 OrderConfirmed message.
-
If you use the webhooks-based implementation, a set of events is grouped together in an OrderConfirmedList message.
Schemas:
- Order-Confirmed-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
Order Confirm Event Types:
- Regular Order Confirm Event
- ZCR Order Confirmation Event
XPath: /OrderConfirmed/MessageSource
| Regular Order Confirm Event | <MessageSource/> |
| ZCR Order Confirmation Event | <MessageSource>ZCROrderConfirm</MessageSource> |
OrderConfirmed Message
For queue-based implementations, a new OrderConfirmed message is generated for each new event.
Queue name: q.Order.Confirmation.<StoreCode>.2-0
Single-Event Message Examples
Click any heading below to view the example message.
Example Message: Regular Order Confirm Event
Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderConfirmed xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="2696111" storeId="StoreCode" locale="en_US" orderDate="2017-02-01T05:40:22+00:00" currency="USD" currencySymbol="$">
<Customer customerId="252451114">
<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>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderSource>EB2C</OrderSource>
<MessageSource />
<ORSOCode />
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>60608</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<OrderConfirmedOrderItems>
<OrderItem webLineId="1" itemId="67-1539467" quantity="1" isHiddenGift="false" id="KEY-201702010559346205588391" isBundleParent="false">
<Description>
<Description>Paris Blues Marlene 11-5</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Paris Blues Marlene 11-5</Title>
<Color id="169156">White Patent</Color>
<Size id="50295">4.5M</Size>
<StyleNumber>88486</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>26.98</Amount>
<UnitPrice>26.98</UnitPrice>
</Pricing>
<ShippingMethod displayText="Priority Mail">USPS_PRIOR</ShippingMethod>
<EstimatedShipDate>2017-02-01</EstimatedShipDate>
<EDDMessage>
<MessageType>DeliveryDate</MessageType>
<StartDate>2017-02-03T05:59:57+00:00</StartDate>
<EndDate>2017-02-10T05:59:57+00:00</EndDate>
</EDDMessage>
<FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20170208</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
<OrderItem webLineId="2" itemId="67-1539467" quantity="1" isHiddenGift="false" id="KEY-201702010559346205588392" isBundleParent="false">
<Description>
<Description>Paris Blues Marlene 11-5</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Paris Blues Marlene 11-5</Title>
<Color id="169156">White Patent</Color>
<Size id="50295">4.5M</Size>
<StyleNumber>88486</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>26.98</Amount>
<UnitPrice>26.98</UnitPrice>
</Pricing>
<ShippingMethod displayText="Priority Mail">USPS_PRIOR</ShippingMethod>
<EstimatedShipDate>2017-02-01</EstimatedShipDate>
<EDDMessage>
<MessageType>DeliveryDate</MessageType>
<StartDate>2017-02-03T05:59:57+00:00</StartDate>
<EndDate>2017-02-10T05:59:57+00:00</EndDate>
</EDDMessage>
<FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20170208</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
</OrderConfirmedOrderItems>
<ShippedAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>12345</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress />
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderConfirmedPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>64.72</PaymentAmount>
</Payment>
</OrderConfirmedPayments>
<OrderHistoryURL />
<ShopRunnerMessage />
<OrderSummary totalAmount="64.72" salesTaxAmount="3.81" subTotalAmount="53.96" shippingAmount="6.95" dutyAmount="0" feesAmount="0" discountAmount="0.00" />
</OrderConfirmed>Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderConfirmed xmlns="http://api.gsicommerce.com/schema/checkout/1.0" customerOrderId="2696111" storeId="StoreCode" locale="en_US" orderDate="2017-02-01T05:40:22+00:00" currency="USD" currencySymbol="$">
<Customer customerId="52451114">
<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>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderSource>EB2C</OrderSource>
<MessageSource>ZCROrderConfirm</MessageSource>
<ORSOCode />
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>60608</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<OrderConfirmedOrderItems>
<OrderItem webLineId="1" itemId="67-12345666" quantity="1" isHiddenGift="false" id="KEY-201702010559346205588391" isBundleParent="false">
<Description>
<Description>Paris Blues Marlene 11-5</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Paris Blues Marlene 11-5</Title>
<Color id="169156">White Patent</Color>
<Size id="50295">4.5M</Size>
<StyleNumber>88486</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>26.98</Amount>
<UnitPrice>26.98</UnitPrice>
</Pricing>
<ShippingMethod displayText="Priority Mail">USPS_PRIOR</ShippingMethod>
<EstimatedShipDate>2017-02-01</EstimatedShipDate>
<EDDMessage>
<MessageType>DeliveryDate</MessageType>
<StartDate>2017-02-03T05:59:57+00:00</StartDate>
<EndDate>2017-02-10T05:59:57+00:00</EndDate>
</EDDMessage>
<FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20170208</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
<OrderItem webLineId="2" itemId="67-12345666" quantity="1" isHiddenGift="false" id="KEY-201702010559346205588392" isBundleParent="false">
<Description>
<Description>Paris Blues Marlene 11-5</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Paris Blues Marlene 11-5</Title>
<Color id="169156">White Patent</Color>
<Size id="50295">4.5M</Size>
<StyleNumber>88486</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>26.98</Amount>
<UnitPrice>26.98</UnitPrice>
</Pricing>
<ShippingMethod displayText="Priority Mail">USPS_PRIOR</ShippingMethod>
<EstimatedShipDate>2017-02-01</EstimatedShipDate>
<EDDMessage>
<MessageType>DeliveryDate</MessageType>
<StartDate>2017-02-03T05:59:57+00:00</StartDate>
<EndDate>2017-02-10T05:59:57+00:00</EndDate>
</EDDMessage>
<FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20170208</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
</OrderConfirmedOrderItems>
<ShippedAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>12345</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress />
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderConfirmedPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>64.72</PaymentAmount>
</Payment>
</OrderConfirmedPayments>
<OrderHistoryURL />
<ShopRunnerMessage />
<OrderSummary totalAmount="64.72" salesTaxAmount="3.81" subTotalAmount="53.96" shippingAmount="6.95" dutyAmount="0" feesAmount="0" discountAmount="0.00" />
</OrderConfirmed>OrderConfirmedList Message
For Webhooks-based implementations, Order Confirmation events are grouped together in one OrderConfirmedList message.
Event List Message Example
Click the heading below to view the example message.
Example OrderConfirmedList Message
Copy
<?xml version="1.0" encoding="UTF-8"?>
<OrderConfirmedList xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<OrderConfirmed customerOrderId="2696111" storeId="StoreCode" locale="en_US" orderDate="2017-02-01T05:40:22+00:00" currency="USD" currencySymbol="$">
<Customer customerId="252451114">
<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>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderSource>EB2C</OrderSource>
<MessageSource />
<ORSOCode />
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>60608</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<OrderConfirmedOrderItems>
<OrderItem webLineId="1" itemId="67-1539467" quantity="1" isHiddenGift="false" id="KEY-201702010559346205588391" isBundleParent="false">
<Description>
<Description>Paris Blues Marlene 11-5</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Paris Blues Marlene 11-5</Title>
<Color id="169156">White Patent</Color>
<Size id="50295">4.5M</Size>
<StyleNumber>88486</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>26.98</Amount>
<UnitPrice>26.98</UnitPrice>
</Pricing>
<ShippingMethod displayText="Priority Mail">USPS_PRIOR</ShippingMethod>
<EstimatedShipDate>2017-02-01</EstimatedShipDate>
<EDDMessage>
<MessageType>DeliveryDate</MessageType>
<StartDate>2017-02-03T05:59:57+00:00</StartDate>
<EndDate>2017-02-10T05:59:57+00:00</EndDate>
</EDDMessage>
<FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20170208</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
<OrderItem webLineId="2" itemId="67-1539467" quantity="1" isHiddenGift="false" id="KEY-201702010559346205588392" isBundleParent="false">
<Description>
<Description>Paris Blues Marlene 11-5</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Paris Blues Marlene 11-5</Title>
<Color id="169156">White Patent</Color>
<Size id="50295">4.5M</Size>
<StyleNumber>88486</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>26.98</Amount>
<UnitPrice>26.98</UnitPrice>
</Pricing>
<ShippingMethod displayText="Priority Mail">USPS_PRIOR</ShippingMethod>
<EstimatedShipDate>2017-02-01</EstimatedShipDate>
<EDDMessage>
<MessageType>DeliveryDate</MessageType>
<StartDate>2017-02-03T05:59:57+00:00</StartDate>
<EndDate>2017-02-10T05:59:57+00:00</EndDate>
</EDDMessage>
<FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20170208</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
</OrderConfirmedOrderItems>
<ShippedAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>12345</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress />
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderConfirmedPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>64.72</PaymentAmount>
</Payment>
</OrderConfirmedPayments>
<OrderHistoryURL />
<ShopRunnerMessage />
<OrderSummary totalAmount="64.72" salesTaxAmount="3.81" subTotalAmount="53.96" shippingAmount="6.95" dutyAmount="0" feesAmount="0" discountAmount="0.00" />
</OrderConfirmed>
<OrderConfirmed customerOrderId="2696111" storeId="StoreCode" locale="en_US" orderDate="2017-02-01T05:40:22+00:00" currency="USD" currencySymbol="$">
<Customer customerId="52451114">
<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>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<OrderSource>EB2C</OrderSource>
<MessageSource>ZCROrderConfirm</MessageSource>
<ORSOCode />
<BillingAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>60608</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress>email@domain.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<OrderConfirmedOrderItems>
<OrderItem webLineId="1" itemId="67-12345666" quantity="1" isHiddenGift="false" id="KEY-201702010559346205588391" isBundleParent="false">
<Description>
<Description>Paris Blues Marlene 11-5</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Paris Blues Marlene 11-5</Title>
<Color id="169156">White Patent</Color>
<Size id="50295">4.5M</Size>
<StyleNumber>88486</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>26.98</Amount>
<UnitPrice>26.98</UnitPrice>
</Pricing>
<ShippingMethod displayText="Priority Mail">USPS_PRIOR</ShippingMethod>
<EstimatedShipDate>2017-02-01</EstimatedShipDate>
<EDDMessage>
<MessageType>DeliveryDate</MessageType>
<StartDate>2017-02-03T05:59:57+00:00</StartDate>
<EndDate>2017-02-10T05:59:57+00:00</EndDate>
</EDDMessage>
<FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20170208</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
<OrderItem webLineId="2" itemId="67-12345666" quantity="1" isHiddenGift="false" id="KEY-201702010559346205588392" isBundleParent="false">
<Description>
<Description>Paris Blues Marlene 11-5</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Paris Blues Marlene 11-5</Title>
<Color id="169156">White Patent</Color>
<Size id="50295">4.5M</Size>
<StyleNumber>88486</StyleNumber>
<VendorPartNumber />
</Description>
<Pricing>
<Amount>26.98</Amount>
<UnitPrice>26.98</UnitPrice>
</Pricing>
<ShippingMethod displayText="Priority Mail">USPS_PRIOR</ShippingMethod>
<EstimatedShipDate>2017-02-01</EstimatedShipDate>
<EDDMessage>
<MessageType>DeliveryDate</MessageType>
<StartDate>2017-02-03T05:59:57+00:00</StartDate>
<EndDate>2017-02-10T05:59:57+00:00</EndDate>
</EDDMessage>
<FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
<OrderItemKind>physical</OrderItemKind>
<AdditionalValues>
<KeyValuePair>
<Key>PickupDate</Key>
<Value>20170208</Value>
</KeyValuePair>
<KeyValuePair>
<Key>PickupTime</Key>
<Value>235900</Value>
</KeyValuePair>
<KeyValuePair>
<Key>ImageLink</Key>
<Value>https://test</Value>
</KeyValuePair>
</AdditionalValues>
</OrderItem>
</OrderConfirmedOrderItems>
<ShippedAddress>
<PersonName>
<LastName>last name</LastName>
<FirstName>first name</FirstName>
</PersonName>
<Address>
<Line1>123 Line1</Line1>
<City>Chicago</City>
<MainDivision>IL</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>12345</PostalCode>
</Address>
<PhoneNumber>123456789</PhoneNumber>
<EmailAddress />
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderConfirmedPayments>
<Payment>
<PaymentDescription>VC</PaymentDescription>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>************1111</PaymentMaskedAccount>
<PaymentAmount>64.72</PaymentAmount>
</Payment>
</OrderConfirmedPayments>
<OrderHistoryURL />
<ShopRunnerMessage />
<OrderSummary totalAmount="64.72" salesTaxAmount="3.81" subTotalAmount="53.96" shippingAmount="6.95" dutyAmount="0" feesAmount="0" discountAmount="0.00" />
</OrderConfirmed>
</OrderConfirmedList>