Order Shipment Event

An Order Shipment event is sent when items have been shipped from the warehouse to the customer. The event message also contains current pricing. For customers using external payments, it is recommended that Order Shipment is the time that a customer’s credit card is invoiced.

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 OrderShipped 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 OrderShippedList message. The events can be sent in XML or JSON.

XML Schemas:

Ship Confirm Event Types:

  • Regular Ship Confirm Event
  • ZCR Ship Confirmation Event

XPath: /OrderShipped/MessageSource

Regular Ship Confirm Event <MessageSource/>
ZCR Ship Confirmation Event <MessageSource>ZCRShipConfirm</MessageSource>

OrderShipped Messages

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

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

Single-Event Message Examples

Click any heading below to view the contents of the sample message file.

Copy 
<?xml version="1.0" encoding="UTF-8"?>
<OrderShipped xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
              customerOrderId="26111122"
              storeId="StoreCode"
              locale="en_US"
              orderDate="2021-01-30T21:08:14+00:00"
              currencySymbol="$"
              currency="USD">
   <Customer customerId="231110">
      <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/>
   <ShippedOrderItems>
      <OrderItem webLineId="1" itemId="67-1597004" quantity="1" shippedQuantity="1"
                 isHiddenGift="false"
                 id="KEY-201701302112336201072381"
                 isBundleParent="false">
         <Description>
            <Description>Koolaburra by UGG Cable</Description>
            <SKU>12345666</SKU>
            <UPC>12345666</UPC>
            <GlobalId>12345666</GlobalId>
            <Title>Koolaburra by UGG Cable</Title>
            <Color id="174714">Cub</Color>
            <Size id="50475">9M</Size>
            <StyleNumber>91068</StyleNumber>
            <VendorPartNumber/>
         </Description>
         <Pricing>
            <Amount>79.98</Amount>
            <UnitPrice>79.98</UnitPrice>
         </Pricing>
         <Carrier mode="PRIOR" displayText="Priority Mail">USPS</Carrier>
         <TrackingNumberList>
            <TrackingInfo trackingNumber="12345666" trackingURL=""/>
         </TrackingNumberList>
         <FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
         <OrderItemKind>physical</OrderItemKind>
         <AdditionalValues>
            <KeyValuePair>
               <Key>PickupDate</Key>
               <Value>20210206</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>PickupTime</Key>
               <Value>235900</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>ImageLink</Key>
               <Value>https://test</Value>
            </KeyValuePair>
         </AdditionalValues>
      </OrderItem>
   </ShippedOrderItems>
   <ShippedDestination>
      <ShippedAddress>
         <PersonName>
            <LastName>last name</LastName>
            <FirstName>first name</FirstName>
         </PersonName>
         <Address>
            <Line1>123 Line1</Line1>
            <City>Revere</City>
            <MainDivision>MA</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>02151</PostalCode>
         </Address>
         <PhoneNumber>123456789</PhoneNumber>
         <EmailAddress/>
      </ShippedAddress>
   </ShippedDestination>
   <BillingAddress>
      <PersonName>
         <LastName>last name</LastName>
         <FirstName>first name</FirstName>
      </PersonName>
      <Address>
         <Line1>123 Line1</Line1>
         <Line2>Unit 120</Line2>
         <City>Beverly</City>
         <MainDivision>MA</MainDivision>
         <CountryCode>US</CountryCode>
         <PostalCode>12345</PostalCode>
      </Address>
      <PhoneNumber>123456789</PhoneNumber>
      <EmailAddress>email@domain.com</EmailAddress>
   </BillingAddress>
   <OrderSummary totalAmount="79.98" totalTaxAmount="0.00" subTotalAmount="79.98"
                 shippedAmount="0.00"
                 dutyAmount="0"
                 feesAmount="0"
                 discountAmount="6.95">
      <Payments>
         <Payment>
            <PaymentDescription>VC</PaymentDescription>
            <PaymentTenderType>CreditCard</PaymentTenderType>
            <PaymentMaskedAccount>************1234</PaymentMaskedAccount>
            <PaymentAmount>79.98</PaymentAmount>
         </Payment>
      </Payments>
      <OrderTaxesDutiesFeesInformations>
         <TaxesDutiesFeesInformation>
            <TaxDescription amount="0.00">USSalesTax</TaxDescription>
         </TaxesDutiesFeesInformation>
      </OrderTaxesDutiesFeesInformations>
   </OrderSummary>
</OrderShipped>
Copy 
<?xml version="1.0" encoding="UTF-8"?>
<OrderShipped xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
              customerOrderId="6111122"
              storeId="StoreCode"
              locale="en_US"
              orderDate="2021-01-30T21:08:14+00:00"
              currencySymbol="$"
              currency="USD">
   <Customer customerId="231110">
      <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>ZCRShipConfirm</MessageSource>
   <ORSOCode/>
   <ShippedOrderItems>
      <OrderItem webLineId="1" itemId="67-1597004" quantity="1" shippedQuantity="1"
                 isHiddenGift="false"
                 id="KEY-201701302112336201072381"
                 isBundleParent="false">
         <Description>
            <Description>Koolaburra by UGG Cable</Description>
            <SKU>12345666</SKU>
            <UPC>12345666</UPC>
            <GlobalId>12345666</GlobalId>
            <Title>Koolaburra by UGG Cable</Title>
            <Color id="174714">Cub</Color>
            <Size id="50475">9M</Size>
            <StyleNumber>91068</StyleNumber>
            <VendorPartNumber/>
         </Description>
         <Pricing>
            <Amount>79.98</Amount>
            <UnitPrice>79.98</UnitPrice>
         </Pricing>
         <Carrier mode="PRIOR" displayText="Priority Mail">USPS</Carrier>
         <TrackingNumberList>
            <TrackingInfo trackingNumber="12345666" trackingURL=""/>
         </TrackingNumberList>
         <FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
         <OrderItemKind>physical</OrderItemKind>
         <AdditionalValues>
            <KeyValuePair>
               <Key>PickupDate</Key>
               <Value>20210206</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>PickupTime</Key>
               <Value>235900</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>ImageLink</Key>
               <Value>https://test</Value>
            </KeyValuePair>
         </AdditionalValues>
      </OrderItem>
   </ShippedOrderItems>
   <ShippedDestination>
      <ShippedAddress>
         <PersonName>
            <LastName>last name</LastName>
            <FirstName>first name</FirstName>
         </PersonName>
         <Address>
            <Line1>123 Line1</Line1>
            <City>Revere</City>
            <MainDivision>MA</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>02151</PostalCode>
         </Address>
         <PhoneNumber>123456789</PhoneNumber>
         <EmailAddress/>
      </ShippedAddress>
   </ShippedDestination>
   <BillingAddress>
      <PersonName>
         <LastName>last name</LastName>
         <FirstName>first name</FirstName>
      </PersonName>
      <Address>
         <Line1>123 Line1</Line1>
         <Line2>Unit 120</Line2>
         <City>Beverly</City>
         <MainDivision>MA</MainDivision>
         <CountryCode>US</CountryCode>
         <PostalCode>12345</PostalCode>
      </Address>
      <PhoneNumber>123456789</PhoneNumber>
      <EmailAddress>email@domain.com</EmailAddress>
   </BillingAddress>
   <OrderSummary totalAmount="79.98" totalTaxAmount="0.00" subTotalAmount="79.98"
                 shippedAmount="0.00"
                 dutyAmount="0"
                 feesAmount="0"
                 discountAmount="6.95">
      <Payments>
         <Payment>
            <PaymentDescription>VC</PaymentDescription>
            <PaymentTenderType>CreditCard</PaymentTenderType>
            <PaymentMaskedAccount>************1234</PaymentMaskedAccount>
            <PaymentAmount>79.98</PaymentAmount>
         </Payment>
      </Payments>
      <OrderTaxesDutiesFeesInformations>
         <TaxesDutiesFeesInformation>
            <TaxDescription amount="0.00">USSalesTax</TaxDescription>
         </TaxesDutiesFeesInformation>
      </OrderTaxesDutiesFeesInformations>
   </OrderSummary>
</OrderShipped>

OrderShippedList Messages

For Webhooks-based implementations, Order Shipment Confirm events are grouped together in one OrderShippedList message.

Event List Message Examples

Click any heading below to view the contents of the sample message file.

Copy 
<?xml version="1.0" encoding="UTF-8"?>
<OrderShippedList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
              customerOrderId="26111122"
              storeId="StoreCode"
              locale="en_US"
              orderDate="2021-01-30T21:08:14+00:00"
              currencySymbol="$"
              currency="USD">
   <Customer customerId="231110">
      <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/>
   <ShippedOrderItems>
      <OrderItem webLineId="1" itemId="67-1597004" quantity="1" shippedQuantity="1"
                 isHiddenGift="false"
                 id="KEY-201701302112336201072381"
                 isBundleParent="false">
         <Description>
            <Description>Koolaburra by UGG Cable</Description>
            <SKU>12345666</SKU>
            <UPC>12345666</UPC>
            <GlobalId>12345666</GlobalId>
            <Title>Koolaburra by UGG Cable</Title>
            <Color id="174714">Cub</Color>
            <Size id="50475">9M</Size>
            <StyleNumber>91068</StyleNumber>
            <VendorPartNumber/>
         </Description>
         <Pricing>
            <Amount>79.98</Amount>
            <UnitPrice>79.98</UnitPrice>
         </Pricing>
         <Carrier mode="PRIOR" displayText="Priority Mail">USPS</Carrier>
         <TrackingNumberList>
            <TrackingInfo trackingNumber="12345666" trackingURL=""/>
         </TrackingNumberList>
         <FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
         <OrderItemKind>physical</OrderItemKind>
         <AdditionalValues>
            <KeyValuePair>
               <Key>PickupDate</Key>
               <Value>20210206</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>PickupTime</Key>
               <Value>235900</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>ImageLink</Key>
               <Value>https://test</Value>
            </KeyValuePair>
         </AdditionalValues>
      </OrderItem>
   </ShippedOrderItems>
   <ShippedDestination>
      <ShippedAddress>
         <PersonName>
            <LastName>last name</LastName>
            <FirstName>first name</FirstName>
         </PersonName>
         <Address>
            <Line1>123 Line1</Line1>
            <City>Revere</City>
            <MainDivision>MA</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>02151</PostalCode>
         </Address>
         <PhoneNumber>123456789</PhoneNumber>
         <EmailAddress/>
      </ShippedAddress>
   </ShippedDestination>
   <BillingAddress>
      <PersonName>
         <LastName>last name</LastName>
         <FirstName>first name</FirstName>
      </PersonName>
      <Address>
         <Line1>123 Line1</Line1>
         <Line2>Unit 120</Line2>
         <City>Beverly</City>
         <MainDivision>MA</MainDivision>
         <CountryCode>US</CountryCode>
         <PostalCode>12345</PostalCode>
      </Address>
      <PhoneNumber>123456789</PhoneNumber>
      <EmailAddress>email@domain.com</EmailAddress>
   </BillingAddress>
   <OrderSummary totalAmount="79.98" totalTaxAmount="0.00" subTotalAmount="79.98"
                 shippedAmount="0.00"
                 dutyAmount="0"
                 feesAmount="0"
                 discountAmount="6.95">
      <Payments>
         <Payment>
            <PaymentDescription>VC</PaymentDescription>
            <PaymentTenderType>CreditCard</PaymentTenderType>
            <PaymentMaskedAccount>************1234</PaymentMaskedAccount>
            <PaymentAmount>79.98</PaymentAmount>
         </Payment>
      </Payments>
      <OrderTaxesDutiesFeesInformations>
         <TaxesDutiesFeesInformation>
            <TaxDescription amount="0.00">USSalesTax</TaxDescription>
         </TaxesDutiesFeesInformation>
      </OrderTaxesDutiesFeesInformations>
   </OrderSummary>
</OrderShippedList>
Copy 
<?xml version="1.0" encoding="UTF-8"?>
<OrderShippedList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
              customerOrderId="6111122"
              storeId="StoreCode"
              locale="en_US"
              orderDate="2021-01-30T21:08:14+00:00"
              currencySymbol="$"
              currency="USD">
   <Customer customerId="231110">
      <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>ZCRShipConfirm</MessageSource>
   <ORSOCode/>
   <ShippedOrderItems>
      <OrderItem webLineId="1" itemId="67-1597004" quantity="1" shippedQuantity="1"
                 isHiddenGift="false"
                 id="KEY-201701302112336201072381"
                 isBundleParent="false">
         <Description>
            <Description>Koolaburra by UGG Cable</Description>
            <SKU>12345666</SKU>
            <UPC>12345666</UPC>
            <GlobalId>12345666</GlobalId>
            <Title>Koolaburra by UGG Cable</Title>
            <Color id="174714">Cub</Color>
            <Size id="50475">9M</Size>
            <StyleNumber>91068</StyleNumber>
            <VendorPartNumber/>
         </Description>
         <Pricing>
            <Amount>79.98</Amount>
            <UnitPrice>79.98</UnitPrice>
         </Pricing>
         <Carrier mode="PRIOR" displayText="Priority Mail">USPS</Carrier>
         <TrackingNumberList>
            <TrackingInfo trackingNumber="12345666" trackingURL=""/>
         </TrackingNumberList>
         <FulfillmentMethod>SHIP_TO_HOME</FulfillmentMethod>
         <OrderItemKind>physical</OrderItemKind>
         <AdditionalValues>
            <KeyValuePair>
               <Key>PickupDate</Key>
               <Value>20210206</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>PickupTime</Key>
               <Value>235900</Value>
            </KeyValuePair>
            <KeyValuePair>
               <Key>ImageLink</Key>
               <Value>https://test</Value>
            </KeyValuePair>
         </AdditionalValues>
      </OrderItem>
   </ShippedOrderItems>
   <ShippedDestination>
      <ShippedAddress>
         <PersonName>
            <LastName>last name</LastName>
            <FirstName>first name</FirstName>
         </PersonName>
         <Address>
            <Line1>123 Line1</Line1>
            <City>Revere</City>
            <MainDivision>MA</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>02151</PostalCode>
         </Address>
         <PhoneNumber>123456789</PhoneNumber>
         <EmailAddress/>
      </ShippedAddress>
   </ShippedDestination>
   <BillingAddress>
      <PersonName>
         <LastName>last name</LastName>
         <FirstName>first name</FirstName>
      </PersonName>
      <Address>
         <Line1>123 Line1</Line1>
         <Line2>Unit 120</Line2>
         <City>Beverly</City>
         <MainDivision>MA</MainDivision>
         <CountryCode>US</CountryCode>
         <PostalCode>12345</PostalCode>
      </Address>
      <PhoneNumber>123456789</PhoneNumber>
      <EmailAddress>email@domain.com</EmailAddress>
   </BillingAddress>
   <OrderSummary totalAmount="79.98" totalTaxAmount="0.00" subTotalAmount="79.98"
                 shippedAmount="0.00"
                 dutyAmount="0"
                 feesAmount="0"
                 discountAmount="6.95">
      <Payments>
         <Payment>
            <PaymentDescription>VC</PaymentDescription>
            <PaymentTenderType>CreditCard</PaymentTenderType>
            <PaymentMaskedAccount>************1234</PaymentMaskedAccount>
            <PaymentAmount>79.98</PaymentAmount>
         </Payment>
      </Payments>
      <OrderTaxesDutiesFeesInformations>
         <TaxesDutiesFeesInformation>
            <TaxDescription amount="0.00">USSalesTax</TaxDescription>
         </TaxesDutiesFeesInformation>
      </OrderTaxesDutiesFeesInformations>
   </OrderSummary>
</OrderShippedList>

Example: JSON Format

Note: If you want to use the JSON format, contact your Radial representative for the XML to JSON mappings.

Copy 
{
    "customer": {
        "name": {
            "lastName": "Jones",
            "firstName": "Indiana"
        },
        "emailAddress": "TESTFRAUD@radial.com",
        "customerId": "null4188504045"
    },
    "orderSource": "WEB",
    "messageSource": null,
    "orsoCode": "EB2C",
    "shipDate": "2023-05-17T12:41:58+0000",
    "totalOrderLine": "2",
    "totalShippedLine": "2",
    "shippedOrderItems": [
        {
            "description": {
                "description": "Black Tennis Shoes",
                "sku": "21252052",
                "upc": "0360123652011",
                "globalId": "21252052",
                "title": "Black Tennis Shoes",
                "color": {
                    "id": "700",
                    "text": "Brown"
                },
                "size": {
                    "id": "6-M",
                    "text": "6-M"
                },
                "styleNumber": "84529",
                "productImageURL": null
            },
            "pricing": {
                "amount": "113.00",
                "unitPrice": "114.00"
            },
            "carrier": {
                "value": "UPS",
                "mode": "GND51",
                "displayText": null
            },
            "trackingNumberList": {
                "trackingInfo": {
                    "trackingNumber": "1Z1000238207277215",
                    "trackingURL": "https://narvar.com/tracking/tmsus/narvar?tracking_numbers=1Z1000238207277215&dzip=19406&src=sce&order_number=0002602253461653&carrier=UPS&type=ret"
                }
            },
            "fulfillmentMethod": "SHIP_TO_HOME",
            "orderItemKind": "physical",
            "additionalValues": [
                {
                    "key": "PVAR_DESC_COLOR",
                    "value": "Brown"
                },
                {
                    "key": "requestLineId",
                    "value": "item_2"
                },
                {
                    "key": "OrderAttrName1",
                    "value": "OrderAttrVal1"
                },
                {
                    "key": "ExtnScheduledMaxDelDate",
                    "value": "2024-04-19T13:18:40Z"
                }
            ],
            "itemRelationships": null,
            "webLineId": "2",
            "itemId": "21-ISPUProd02",
            "quantity": "1",
            "shippedQuantity": "1",
            "id": "Key-2",
            "orderItemStatus": "COMPLETELY_SHIPPED"
        }
    ],
    "shippedDestination": {
        "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"
        }
    },
    "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"
    },
    "orderSummary": {
        "payments": {
            "payment": {
                "paymentDescription": "VC",
                "paymentTenderType": "CreditCard",
                "paymentMaskedAccount": "***********1111",
                "paymentAmount": "113.00"
            }
        },
        "orderTaxesDutiesFeesInformations": [
            {
                "taxDescription": {
                    "value": "USSalesTax",
                    "amount": "0.00"
                }
            },
            {
                "taxDescription": {
                    "value": "TotalTaxAmount",
                    "amount": ""
                }
            }
        ],
        "totalAmount": "113.00",
        "totalTaxAmount": "0.00",
        "giftWrapAmount": "0.00",
        "subTotalAmount": "113.00",
        "shippedAmount": "0.00",
        "dutyAmount": "0.00",
        "feesAmount": "0.00",
        "discountAmount": "0.00"
    },
    "additionalAttributes": [
        {
            "key": "MAJOR_ORDER_GRP_ATTR",
            "value": "shipgroup_1"
        },
        {
            "key": "OrderAttrName1",
            "value": "OrderAttrVal1"
        },
        {
            "key": "eventTimestamp",
            "value": "2024-04-17T13:23:26.864Z"
        },
        {
            "key": "RETURN_DOT_COM_URL",
            "value": "lvsdevreturnuiapp04-01.gspt.net/en/Themodelstore_us"
        }
    ],
    "customerOrderId": "0002602253461653",
    "storeId": "TMSUS",
    "locale": "en_US",
    "orderDate": "2024-04-17T12:18:39.000Z",
    "currencySymbol": "$",
    "currency": "USD"
}