Order Backorder Event
An Order BackOrder event contains a list of items that have been placed on backorder prior to shipment.
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 OrderBackorder message.
-
If you use the webhooks-based implementation, a set of events is grouped together in an OrderBackorderList message.
Schemas:
- Order-Backorder-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 Backorder Event Types
- Backorder
- Pre-Sell
- 1stDelayNotification
- AllocateCancelNotification
XPath: /OrderBackorder/ShippingDelayType
Example: <ShippingDelayType>Backorder</ShippingDelayType>
OrderBackorder Messages
For queue-based implementations, a new OrderAccepted message is generated for each new event.
Queue name: q.Order.BackOrder.<StoreCode>.2-0
Single-Event Message Examples
Click any heading below to view the contents of the sample message file.
<?xml version="1.0" encoding="UTF-8"?>
<OrderBackorder xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="001198000610"
storeId="TMS_US"
locale="en_US"
orderDate="2016-07-13T13:47:54+00:00"
currencySymbol="$"
currency="USD">
<Customer customerId="00072W01000022">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account/>
<Program/>
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<ShippingDelayType>Backorder</ShippingDelayType>
<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>123456789</PhoneNumber>
<EmailAddress>email@example.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<BackorderOrderItems>
<OrderItem webLineId="1" itemId="73-12345666" quantity="1" isHiddenGift="false"
isBundleParent="false">
<Description>
<Description>Product Description</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Product Title</Title>
<Color id="">Brown</Color>
<Size id="">6-M</Size>
<StyleNumber>F6MDD-T3867P</StyleNumber>
<VendorPartNumber/>
</Description>
<Pricing>
<Amount>188.00</Amount>
<UnitPrice>188.00</UnitPrice>
</Pricing>
<ShippingMethod displayText="Standard">STD</ShippingMethod>
<OrderItemKind>physical</OrderItemKind>
</OrderItem>
</BackorderOrderItems>
<ShippedAddress>
<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>
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderSummary totalAmount="201.87" salesTaxAmount="13.87" subTotalAmount="188.00"
shippingAmount="0.00"
dutyAmount="0"
feesAmount="0"
discountAmount="0.00"/>
</OrderBackorder>
<?xml version="1.0" encoding="UTF-8"?>
<OrderBackorder xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="001198000610"
storeId="TMS_US"
locale="en_US"
orderDate="2016-07-13T13:47:54+00:00"
currencySymbol="$"
currency="USD">
<Customer customerId="00072W01000022">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account/>
<Program/>
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<ShippingDelayType>Pre-Sell</ShippingDelayType>
<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>123456789</PhoneNumber>
<EmailAddress>email@example.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<BackorderOrderItems>
<OrderItem webLineId="1" itemId="73-12345666" quantity="1" isHiddenGift="false"
isBundleParent="false">
<Description>
<Description>Product Description</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Product Title</Title>
<Color id="">Brown</Color>
<Size id="">6-M</Size>
<StyleNumber>F6MDD-T3867P</StyleNumber>
<VendorPartNumber/>
</Description>
<Pricing>
<Amount>188.00</Amount>
<UnitPrice>188.00</UnitPrice>
</Pricing>
<ShippingMethod displayText="Standard">STD</ShippingMethod>
<OrderItemKind>physical</OrderItemKind>
</OrderItem>
</BackorderOrderItems>
<ShippedAddress>
<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>
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderSummary totalAmount="201.87" salesTaxAmount="13.87" subTotalAmount="188.00"
shippingAmount="0.00"
dutyAmount="0"
feesAmount="0"
discountAmount="0.00"/>
</OrderBackorder>
<?xml version="1.0" encoding="UTF-8"?>
<OrderBackorder xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="001198000610"
storeId="TMS_US"
locale="en_US"
orderDate="2016-07-13T13:47:54+00:00"
currencySymbol="$"
currency="USD">
<Customer customerId="00072W01000022">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account/>
<Program/>
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<ShippingDelayType>1stDelayNotification</ShippingDelayType>
<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>123456789</PhoneNumber>
<EmailAddress>email@example.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<BackorderOrderItems>
<OrderItem webLineId="1" itemId="73-12345666" quantity="1" isHiddenGift="false"
isBundleParent="false">
<Description>
<Description>Product Description</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Product Title</Title>
<Color id="">Brown</Color>
<Size id="">6-M</Size>
<StyleNumber>F6MDD-T3867P</StyleNumber>
<VendorPartNumber/>
</Description>
<Pricing>
<Amount>188.00</Amount>
<UnitPrice>188.00</UnitPrice>
</Pricing>
<ShippingMethod displayText="Standard">STD</ShippingMethod>
<OrderItemKind>physical</OrderItemKind>
</OrderItem>
</BackorderOrderItems>
<ShippedAddress>
<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>
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderSummary totalAmount="201.87" salesTaxAmount="13.87" subTotalAmount="188.00"
shippingAmount="0.00"
dutyAmount="0"
feesAmount="0"
discountAmount="0.00"/>
</OrderBackorder>
<?xml version="1.0" encoding="UTF-8"?>
<OrderBackorder xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="001198000610"
storeId="TMS_US"
locale="en_US"
orderDate="2016-07-13T13:47:54+00:00"
currencySymbol="$"
currency="USD">
<Customer customerId="00072W01000022">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account/>
<Program/>
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<ShippingDelayType>AllocateCancelNotification</ShippingDelayType>
<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>123456789</PhoneNumber>
<EmailAddress>email@example.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<BackorderOrderItems>
<OrderItem webLineId="1" itemId="73-12345666" quantity="1" isHiddenGift="false"
isBundleParent="false">
<Description>
<Description>Product Description</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Product Title</Title>
<Color id="">Brown</Color>
<Size id="">6-M</Size>
<StyleNumber>F6MDD-T3867P</StyleNumber>
<VendorPartNumber/>
</Description>
<Pricing>
<Amount>188.00</Amount>
<UnitPrice>188.00</UnitPrice>
</Pricing>
<ShippingMethod displayText="Standard">STD</ShippingMethod>
<OrderItemKind>physical</OrderItemKind>
</OrderItem>
</BackorderOrderItems>
<ShippedAddress>
<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>
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderSummary totalAmount="201.87" salesTaxAmount="13.87" subTotalAmount="188.00"
shippingAmount="0.00"
dutyAmount="0"
feesAmount="0"
discountAmount="0.00"/>
</OrderBackorder>
OrderBackorder List Message
For Webhooks-based implementations, Order Backorder events are grouped together in one OrderBackorderList message.
Event List Message Examples
<?xml version="1.0" encoding="UTF-8"?>
<OrderBackorderList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="001198000610"
storeId="TMS_US"
locale="en_US"
orderDate="2016-07-13T13:47:54+00:00"
currencySymbol="$"
currency="USD">
<Customer customerId="00072W01000022">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account/>
<Program/>
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<ShippingDelayType>Backorder</ShippingDelayType>
<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>123456789</PhoneNumber>
<EmailAddress>email@example.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<BackorderOrderItems>
<OrderItem webLineId="1" itemId="73-12345666" quantity="1" isHiddenGift="false"
isBundleParent="false">
<Description>
<Description>Product Description</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Product Title</Title>
<Color id="">Brown</Color>
<Size id="">6-M</Size>
<StyleNumber>F6MDD-T3867P</StyleNumber>
<VendorPartNumber/>
</Description>
<Pricing>
<Amount>188.00</Amount>
<UnitPrice>188.00</UnitPrice>
</Pricing>
<ShippingMethod displayText="Standard">STD</ShippingMethod>
<OrderItemKind>physical</OrderItemKind>
</OrderItem>
</BackorderOrderItems>
<ShippedAddress>
<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>
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderSummary totalAmount="201.87" salesTaxAmount="13.87" subTotalAmount="188.00"
shippingAmount="0.00"
dutyAmount="0"
feesAmount="0"
discountAmount="0.00"/>
</OrderBackorderList>
<?xml version="1.0" encoding="UTF-8"?>
<OrderBackorderList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="001198000610"
storeId="TMS_US"
locale="en_US"
orderDate="2016-07-13T13:47:54+00:00"
currencySymbol="$"
currency="USD">
<Customer customerId="00072W01000022">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account/>
<Program/>
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<ShippingDelayType>Pre-Sell</ShippingDelayType>
<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>123456789</PhoneNumber>
<EmailAddress>email@example.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<BackorderOrderItems>
<OrderItem webLineId="1" itemId="73-12345666" quantity="1" isHiddenGift="false"
isBundleParent="false">
<Description>
<Description>Product Description</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Product Title</Title>
<Color id="">Brown</Color>
<Size id="">6-M</Size>
<StyleNumber>F6MDD-T3867P</StyleNumber>
<VendorPartNumber/>
</Description>
<Pricing>
<Amount>188.00</Amount>
<UnitPrice>188.00</UnitPrice>
</Pricing>
<ShippingMethod displayText="Standard">STD</ShippingMethod>
<OrderItemKind>physical</OrderItemKind>
</OrderItem>
</BackorderOrderItems>
<ShippedAddress>
<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>
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderSummary totalAmount="201.87" salesTaxAmount="13.87" subTotalAmount="188.00"
shippingAmount="0.00"
dutyAmount="0"
feesAmount="0"
discountAmount="0.00"/>
</OrderBackorderList>
<?xml version="1.0" encoding="UTF-8"?>
<OrderBackorderList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="001198000610"
storeId="TMS_US"
locale="en_US"
orderDate="2016-07-13T13:47:54+00:00"
currencySymbol="$"
currency="USD">
<Customer customerId="00072W01000022">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account/>
<Program/>
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<ShippingDelayType>1stDelayNotification</ShippingDelayType>
<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>123456789</PhoneNumber>
<EmailAddress>email@example.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<BackorderOrderItems>
<OrderItem webLineId="1" itemId="73-12345666" quantity="1" isHiddenGift="false"
isBundleParent="false">
<Description>
<Description>Product Description</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Product Title</Title>
<Color id="">Brown</Color>
<Size id="">6-M</Size>
<StyleNumber>F6MDD-T3867P</StyleNumber>
<VendorPartNumber/>
</Description>
<Pricing>
<Amount>188.00</Amount>
<UnitPrice>188.00</UnitPrice>
</Pricing>
<ShippingMethod displayText="Standard">STD</ShippingMethod>
<OrderItemKind>physical</OrderItemKind>
</OrderItem>
</BackorderOrderItems>
<ShippedAddress>
<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>
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderSummary totalAmount="201.87" salesTaxAmount="13.87" subTotalAmount="188.00"
shippingAmount="0.00"
dutyAmount="0"
feesAmount="0"
discountAmount="0.00"/>
</OrderBackorderList>
<?xml version="1.0" encoding="UTF-8"?>
<OrderBackorderList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
customerOrderId="001198000610"
storeId="TMS_US"
locale="en_US"
orderDate="2016-07-13T13:47:54+00:00"
currencySymbol="$"
currency="USD">
<Customer customerId="00072W01000022">
<Name>
<LastName>Last Name</LastName>
<FirstName>First Name</FirstName>
</Name>
<EmailAddress>email@example.com</EmailAddress>
<LoyaltyPrograms>
<LoyaltyProgram>
<Account/>
<Program/>
<CustomAttributes>
<Attribute>
<Key>OrderTotalPointsEarned</Key>
<Value>0</Value>
</Attribute>
</CustomAttributes>
</LoyaltyProgram>
</LoyaltyPrograms>
</Customer>
<ShippingDelayType>AllocateCancelNotification</ShippingDelayType>
<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>123456789</PhoneNumber>
<EmailAddress>email@example.com</EmailAddress>
</BillingAddress>
<ShipGroups>
<ShipGroup>
<BackorderOrderItems>
<OrderItem webLineId="1" itemId="73-12345666" quantity="1" isHiddenGift="false"
isBundleParent="false">
<Description>
<Description>Product Description</Description>
<SKU>12345666</SKU>
<UPC>12345666</UPC>
<GlobalId>12345666</GlobalId>
<Title>Product Title</Title>
<Color id="">Brown</Color>
<Size id="">6-M</Size>
<StyleNumber>F6MDD-T3867P</StyleNumber>
<VendorPartNumber/>
</Description>
<Pricing>
<Amount>188.00</Amount>
<UnitPrice>188.00</UnitPrice>
</Pricing>
<ShippingMethod displayText="Standard">STD</ShippingMethod>
<OrderItemKind>physical</OrderItemKind>
</OrderItem>
</BackorderOrderItems>
<ShippedAddress>
<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>
</ShippedAddress>
</ShipGroup>
</ShipGroups>
<OrderSummary totalAmount="201.87" salesTaxAmount="13.87" subTotalAmount="188.00"
shippingAmount="0.00"
dutyAmount="0"
feesAmount="0"
discountAmount="0.00"/>
</OrderBackorderList>