Order Accepted Event
An Order Accepted event is sent when the Order Service has accepted the order and delivered it to the Order Management System successfully. The event message contains all products and addresses in the 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 OrderAccepted message.
-
If you use the webhooks-based implementation, a set of events is grouped together in an OrderAcceptedList message.
Schemas:
- Order-Accepted-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
OrderAccepted Message
For queue-based implementations, a new OrderAccepted message is generated for each new event.
Queue name: q.Order.Accepted.<StoreCode>.2-0
Single-Event Message Example
<?xml version="1.0" encoding="UTF-8"?>
<OrderAccepted xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="000026794924380"
storeId="TMS_US"
orderAcceptedSource="GOS"
currency="USD"
currencySymbol="$">
<Customer customerId="00004794924380">
<Name>
<LastName>Minimo</LastName>
<FirstName>Joe</FirstName>
</Name>
<EmailAddress>emailexample@testemail.com</EmailAddress>
</Customer>
<OrderAcceptedOrderItems>
<OrderItem webLineId="1" itemId="GSI-2958179" quantity="1">
<Description>
<Description>6-PACK CREW 10-13</Description>
<Color id="red">Red</Color>
<Size id="10">10</Size>
</Description>
<Pricing>
<Amount>99.99</Amount>
</Pricing>
</OrderItem>
</OrderAcceptedOrderItems>
<OrderAcceptedPayments>
<Payment>
<PaymentDescription/>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>4111094781641111</PaymentMaskedAccount>
<PaymentAmount>99.99</PaymentAmount>
</Payment>
</OrderAcceptedPayments>
<OrderSummary totalAmount="634.20" salesTaxAmount="70.00" vatTaxAmount="9.00"
subTotalAmount="629.10"
feesAmount="50.00"/>
</OrderAccepted>
OrderAcceptedList Message
For Webhooks-based implementations, Order Accepted events are grouped together in one OrderAcceptedList message.
Event List Message Example
<?xml version="1.0" encoding="UTF-8"?>
<OrderAcceptedList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="000026794924380"
storeId="TMS_US"
orderAcceptedSource="GOS"
currency="USD"
currencySymbol="$">
<Customer customerId="00004794924380">
<Name>
<LastName>Minimo</LastName>
<FirstName>Joe</FirstName>
</Name>
<EmailAddress>emailexample@testemail.com</EmailAddress>
</Customer>
<OrderAcceptedOrderItems>
<OrderItem webLineId="1" itemId="GSI-2958179" quantity="1">
<Description>
<Description>6-PACK CREW 10-13</Description>
<Color id="red">Red</Color>
<Size id="10">10</Size>
</Description>
<Pricing>
<Amount>99.99</Amount>
</Pricing>
</OrderItem>
</OrderAcceptedOrderItems>
<OrderAcceptedPayments>
<Payment>
<PaymentDescription/>
<PaymentTenderType>CreditCard</PaymentTenderType>
<PaymentMaskedAccount>4111094781641111</PaymentMaskedAccount>
<PaymentAmount>99.99</PaymentAmount>
</Payment>
</OrderAcceptedPayments>
<OrderSummary totalAmount="634.20" salesTaxAmount="70.00" vatTaxAmount="9.00"
subTotalAmount="629.10"
feesAmount="50.00"/>
</OrderAcceptedList>