Order Complete Event

The Order Complete event informs other systems when an order has all lines completely fulfilled, partially fulfilled, or cancelled. Note: This event is consumed by the data warehouse; it is not published to client systems.

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 OrderCompleted message.
If you use the webhooks-based implementation, a set of events is grouped together in an OrderCompletedList message.

Schemas:

OrderCompleted Message

For queue-based implementations, a new OrderCompleted message is generated for each new event.

Queue name: q.Order.Complete.<StoreCode>.2-0

Single-Event Message Examples

The following sample messages illustrate scenarios where an order has been completely shipped, partially shipped, and cancelled.

Order Completely Shipped

Copy

<?xml version="1.0" encoding="UTF-8"?>
<OrderCompleted xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
    customerOrderId="2015030414091856NSMNS"
    orderStatus="COMPLETELY_SHIPPED"
    orderCompletedDate="2015-03-05T18:48:33+00:00"
    storeId="TMSUS"
    currencySymbol="$"
    currency="USD">
    <Customer customerId="4763384408">
        <Name>
            <LastName>Bond</LastName>
            <MiddleName/>
            <FirstName>James</FirstName>
        </Name>
        <EmailAddress>OMS-RIT-Automation@dashboard.gsi</EmailAddress>
    </Customer>
    <OrderCompletedItems>
        <OrderItem webLineId="1" itemId="22475155053" quantity="1" shippedQuantity="1">
            <Description>
                <Description>PromoItem3</Description>
                <Title>PromoItem3</Title>
                <Color id="">Natural</Color>
                <Size id="">XL</Size>
            </Description>
            <Pricing>
                <Amount>14.00</Amount>
                <UnitPrice>20.00</UnitPrice>
            </Pricing>
            <TrackingNumberList>
                <TrackingInfo trackingNumber="201503041811431000040344866217" trackingURL=""/>
            </TrackingNumberList>
        </OrderItem>
        <OrderItem webLineId="2" itemId="22475155054" quantity="1" shippedQuantity="1">
            <Description>
                <Description>PromoItem4</Description>
                <Title>PromoItem4</Title>
                <Color id="">Natural</Color>
                <Size id="">XL</Size>
            </Description>
            <Pricing>
                <Amount>0.00</Amount>
                <UnitPrice>15.00</UnitPrice>
            </Pricing>
            <TrackingNumberList>
                <TrackingInfo trackingNumber="201503041811431000040344866217" trackingURL=""/>
            </TrackingNumberList>
        </OrderItem>
    </OrderCompletedItems>
    <OrderCompletedSummary totalAmount="33.62" salesTaxAmount="15.62" subTotalAmount="35.00"
        shippingAmount="4.99"
        discountAmount="21.99"/>
</OrderCompleted>

Order Partially Shipped

Copy

<?xml version="1.0" encoding="UTF-8"?>
<OrderCompleted xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
    customerOrderId="2015030906haha"
    orderStatus="PARTIALLY_SHIPPED"
    orderCompletedDate="2015-03-09T13:45:36+00:00"
    storeId="TMSUS"
    currencySymbol="$"
    currency="USD">
    <Customer customerId="customer420029219">
        <Name>
            <LastName>Minimum</LastName>
            <MiddleName/>
            <FirstName>Joe</FirstName>
        </Name>
        <EmailAddress>chargegroupswithCustomizationCreditMultiple-IntServices@dashboard.gsi</EmailAddress>
    </Customer>
    <OrderCompletedItems>
        <OrderItem webLineId="1" itemId="201522001" quantity="1" shippedQuantity="1">
            <Description>
                <Description>adidas Essentials Short Sleeve Tee</Description>
                <Title>adidas Essentials Short Sleeve Tee</Title>
                <Color id=""/>
                <Size id=""/>
            </Description>
            <Pricing>
                <Amount>91.01</Amount>
                <UnitPrice>99.99</UnitPrice>
            </Pricing>
        </OrderItem>
        <OrderItem webLineId="2" itemId="201522002" quantity="0" shippedQuantity="0">
            <Description>
                <Description>adidas Essentials Short Sleeve Tee</Description>
                <Title>adidas Essentials Short Sleeve Tee</Title>
                <Color id=""/>
                <Size id=""/>
            </Description>
            <Pricing>
                <Amount>0</Amount>
                <UnitPrice>0</UnitPrice>
            </Pricing>
        </OrderItem>
    </OrderCompletedItems>
    <OrderCompletedSummary totalAmount="105.98" salesTaxAmount="5.88" subTotalAmount="99.99"
        shippingAmount="9.99"
        discountAmount="13.96"/>
</OrderCompleted>

Order Cancelled

Copy

<?xml version="1.0" encoding="UTF-8"?>
<OrderCompleted xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
    customerOrderId="572467793LALA"
    orderStatus="COMPLETELY_CANCELLED"
    orderCompletedDate="2015-03-05T18:48:27+00:00"
    storeId="TRU_JP"
    currencySymbol="$"
    currency="USD">
    <Customer customerId="customer572467793">
        <Name>
            <LastName&gt;Minimum</LastName>
            <MiddleName/>
            <FirstName>Joe</FirstName>
        </Name>
        <EmailAddress>OrderItemMultiFees-IntServices@dashboard.gsi</EmailAddress>
    </Customer>
    <OrderCompletedItems>
        <OrderItem webLineId="1" itemId="30482247" quantity="0" shippedQuantity="0">
            <Description>
                <Description>10360 6' PREM RUST NBK-WP</Description>
                <Title>10360 6' PREM RUST NBK-WP</Title>
                <Color id=""/>
                <Size id=""/>
            </Description>
            <Pricing>
                <Amount>0</Amount>
                <UnitPrice>0</UnitPrice>
            </Pricing>
        </OrderItem>
    </OrderCompletedItems>
    <OrderCompletedSummary totalAmount="0.00" salesTaxAmount="0.00" subTotalAmount="0.00"
        shippingAmount="0.00"
        discountAmount="0.00"/>
</OrderCompleted>

OrderCompletedList Message

For Webhooks-based implementations, Order Complete events are grouped together in one OrderCompletedList message.

Event List Message Example

Click the heading below to view the example message.

Example Message: OrderCompletedList

Copy

Example Message: OrderCompletedList
<?xml version="1.0" encoding="UTF-8"?>
<OrderCompletedList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"> 
<OrderCompleted customerOrderId="2015030414091856NSMNS"
    orderStatus="COMPLETELY_SHIPPED"
    orderCompletedDate="2015-03-05T18:48:33+00:00"
    storeId="TMSUS"
    currencySymbol="$"
    currency="USD">
    <Customer customerId="4763384408">
        <Name>
            <LastName>Bond</LastName>
            <MiddleName/>
            <FirstName>James</FirstName>
        </Name>
        <EmailAddress>OMS-RIT-Automation@dashboard.gsi</EmailAddress>
    </Customer>
    <OrderCompletedItems>
        <OrderItem webLineId="1" itemId="22475155053" quantity="1" shippedQuantity="1">
            <Description>
                <Description>PromoItem3</Description>
                <Title>PromoItem3</Title>
                <Color id="">Natural</Color>
                <Size id="">XL</Size>
            </Description>
            <Pricing>
                <Amount>14.00</Amount>
                <UnitPrice>20.00</UnitPrice>
            </Pricing>
            <TrackingNumberList>
                <TrackingInfo trackingNumber="201503041811431000040344866217" trackingURL=""/>
            </TrackingNumberList>
        </OrderItem>
        <OrderItem webLineId="2" itemId="22475155054" quantity="1" shippedQuantity="1">
            <Description>
                <Description>PromoItem4</Description>
                <Title>PromoItem4</Title>
                <Color id="">Natural</Color>
                <Size id="">XL</Size>
            </Description>
            <Pricing>
                <Amount>0.00</Amount>
                <UnitPrice>15.00</UnitPrice>
            </Pricing>
            <TrackingNumberList>
                <TrackingInfo trackingNumber="201503041811431000040344866217" trackingURL=""/>
            </TrackingNumberList>
        </OrderItem>
    </OrderCompletedItems>
    <OrderCompletedSummary totalAmount="33.62" salesTaxAmount="15.62" subTotalAmount="35.00"
        shippingAmount="4.99"
        discountAmount="21.99"/>
</OrderCompleted>
<OrderCompleted customerOrderId="2015030906haha"
    orderStatus="PARTIALLY_SHIPPED"
    orderCompletedDate="2015-03-09T13:45:36+00:00"
    storeId="TMSUS"
    currencySymbol="$"
    currency="USD">
    <Customer customerId="customer420029219">
        <Name>
            <LastName>Minimum</LastName>
            <MiddleName/>
            <FirstName>Joe</FirstName>
        </Name>
        <EmailAddress>chargegroupswithCustomizationCreditMultiple-IntServices@dashboard.gsi</EmailAddress>
    </Customer>
    <OrderCompletedItems>
        <OrderItem webLineId="1" itemId="201522001" quantity="1" shippedQuantity="1">
            <Description>
                <Description>adidas Essentials Short Sleeve Tee</Description>
                <Title>adidas Essentials Short Sleeve Tee</Title>
                <Color id=""/>
                <Size id=""/>
            </Description>
            <Pricing>
                <Amount>91.01</Amount>
                <UnitPrice>99.99</UnitPrice>
            </Pricing>
        </OrderItem>
        <OrderItem webLineId="2" itemId="201522002" quantity="0" shippedQuantity="0">
            <Description>
                <Description>adidas Essentials Short Sleeve Tee</Description>
                <Title>adidas Essentials Short Sleeve Tee</Title>
                <Color id=""/>
                <Size id=""/>
            </Description>
            <Pricing>
                <Amount>0</Amount>
                <UnitPrice>0</UnitPrice>
            </Pricing>
        </OrderItem>
    </OrderCompletedItems>
    <OrderCompletedSummary totalAmount="105.98" salesTaxAmount="5.88" subTotalAmount="99.99"
        shippingAmount="9.99"
        discountAmount="13.96"/>
</OrderCompleted>
</OrderCompletedList>