Batch Order Creation through the Bulk Order Service
Submitting orders individually via a REST call does not make sense in all cases. An alternative is to submit batches of orders through the Bulk Order Service.
Bulk Order Service
The Bulk Order Service provides an alternative method of submitting orders to the Radial platform that allows submission of order create messages in bulk. The Bulk Order Service allows the bundling of individual order create messages inside a single, common wrapper. Bulk Order Create messages are delivered to the Radial platform via SFTP. When a bulk order message is received by the Radial platform, each order create message contained within the bulk order wrapper is validated and created as an individual order in the platform. An acknowledgement message is provided in response to the successful receipt of a bulk order create message.
Message Information
|
Specification |
Specification details |
|---|---|
|
Feed Direction |
Client to Radial |
|
Exchange Frequency |
As often as the client requires. (Radial recommends no more than once per hour.) |
|
Timing |
A file receipt acknowledgement will be generated as soon as Radial receives the message from the client. |
|
Communication Protocol |
SFTP |
|
File Name Convention: |
BOSOrder_{ClientCode}_20170210135200.xml |
| File Name Example: | BOSOrder_HIBNA_20170210135200.xml |
|
Data Format |
XML |
|
Source System |
Client |
Response
The response is a Create Order Acknowledgement File. The response can be found in the SFTP delivery folder for bulk order create messages once a bulk order create message has been received. For details of the acknowledgement file, see Create Order Acknowledgement Feed.
Schema
Schema files:
Examples
Example message file: BOSOrder_Regular_0005.xml
Also see the following example.
Copy this code sample.
<BulkOrderCreateRequest>
<OrderCreateRequest orderType="SALES" requestId="00025-980677361" testType="">
<Order customerOrderId="00026BOREG000256">
<Customer customerId="null0002690000000102">
<Name>
<Honorific>Mr</Honorific>
<LastName>Jones</LastName>
<MiddleName>Jr</MiddleName>
<FirstName>Indiana</FirstName>
</Name>
<EmailAddress>bahn@ebay.com</EmailAddress>
<CustomerTaxId>973935484</CustomerTaxId>
</Customer>
<CreateTime>2013-12-25T09:35:16</CreateTime>
<OrderItems>
<OrderItem id="item_1" webLineId="1">
<ItemId>21-58341C0F</ItemId>
<Quantity>1</Quantity>
<Description>
<Description>Fisher-Price Harley Davidson Lights and Sounds Tricycle</Description>
<Color id="x">Red</Color>
<Size id="b">10</Size>
</Description>
<Pricing>
<Merchandise>
<Amount>99.99</Amount>
<PromotionalDiscounts>
<Discount>
<Id>Promo3</Id>
<Code>PromoCode3</Code>
<Amount>4.99</Amount>
<Description>Item Discount for Loyalty</Description>
</Discount>
<Discount>
<Id>Promo4</Id>
<Code>PromoCode4</Code>
<Amount>3.99</Amount>
<Description>Item Discount for Holidays</Description>
</Discount>
</PromotionalDiscounts>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="PA" jurisdictionLevel="STATE">us</Jurisdiction>
<Imposition impositionType="imp">imposition</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>99.99</TaxableAmount>
<CalculatedTax>5.99</CalculatedTax>
<SellerRegistrationId>DEFAULT</SellerRegistrationId>
</Tax>
<Tax taxType="VAT" taxability="NONTAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="PA" jurisdictionLevel="STATE">us</Jurisdiction>
<Imposition impositionType="imp">imposition</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>30.00</TaxableAmount>
<CalculatedTax>1.80</CalculatedTax>
<SellerRegistrationId>DEFAULT</SellerRegistrationId>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>99.99</UnitPrice>
</Merchandise>
<Shipping>
<Amount>9.99</Amount>
<PromotionalDiscounts>
<Discount>
<Id>Promo1</Id>
<Code>PromoCode1</Code>
<Amount>1.99</Amount>
<Description>Shipping Discount for Loyalty</Description>
</Discount>
<Discount>
<Id>Promo2</Id>
<Code>PromoCode2</Code>
<Amount>2.99</Amount>
<Description>Shipping Discount for Holidays</Description>
</Discount>
</PromotionalDiscounts>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SALES" taxability="EXEMPT">
<Situs>SHIP_DESTINATION</Situs>
<Jurisdiction jurisdictionId="PA" jurisdictionLevel="STATE">us</Jurisdiction>
<Imposition impositionType="imp">ship tax imposition</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>99.99</TaxableAmount>
<CalculatedTax>5.99</CalculatedTax>
<SellerRegistrationId>DEFAULT</SellerRegistrationId>
</Tax>
</Taxes>
</TaxData>
</Shipping>
<Duty>
<Amount>1.99</Amount>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SALES" taxability="EXEMPT">
<Situs>Duty_DESTINATION</Situs>
<Jurisdiction jurisdictionId="PA" jurisdictionLevel="STATE">us</Jurisdiction>
<Imposition impositionType="imp">duty tax imposition</Imposition>
<EffectiveRate>0.02</EffectiveRate>
<TaxableAmount>9.99</TaxableAmount>
<CalculatedTax>2.99</CalculatedTax>
<SellerRegistrationId>DEFAULT</SellerRegistrationId>
</Tax>
</Taxes>
</TaxData>
</Duty>
</Pricing>
<ShippingMethod>UPS - 2 DAY</ShippingMethod>
<EstimatedDeliveryDate>
<DeliveryWindow>
<From>2014-01-02T15:00:00</From>
<To>2014-01-05T15:00:00</To>
</DeliveryWindow>
<ShippingWindow>
<From>2013-12-31T15:00:00</From>
<To>2013-12-31T15:00:00</To>
</ShippingWindow>
<Mode>CALIBRATION</Mode>
<MessageType>DeliveryDate</MessageType>
<Template>1</Template>
</EstimatedDeliveryDate>
<CustomAttributes>
<Attribute>
<Key>CustomOrderItemAttrib1</Key>
<Value>BRMC</Value>
</Attribute>
<Attribute>
<Key>CustomOrderItemAttrib2</Key>
<Value>BJM</Value>
</Attribute>
</CustomAttributes>
<ReservationId>12345</ReservationId>
</OrderItem>
</OrderItems>
<Shipping>
<ShipGroups>
<ShipGroup chargeType="" id="shipGroup_1">
<DestinationTarget ref="dest_1"/>
<OrderItems>
<Item ref="item_1"/>
</OrderItems>
</ShipGroup>
</ShipGroups>
<Destinations>
<MailingAddress id="dest_1">
<PersonName>
<Honorific>Mrs.</Honorific>
<LastName>Jones</LastName>
<MiddleName>K.</MiddleName>
<FirstName>Jeniffer</FirstName>
</PersonName>
<Address>
<Line1>630 Allendale Rd.</Line1>
<City>King of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<Phone>215-555-1212</Phone>
</MailingAddress>
<MailingAddress id="billing_1">
<PersonName>
<Honorific>Mr.</Honorific>
<LastName>Jones</LastName>
<MiddleName>Jr.</MiddleName>
<FirstName>Indiana</FirstName>
</PersonName>
<Address>
<Line1>630 Allendale Rd.</Line1>
<City>King of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<Phone>215-555-1212</Phone>
</MailingAddress>
</Destinations>
</Shipping>
<Payment>
<BillingAddress ref="billing_1"/>
<Payments>
<CreditCard>
<PaymentContext>
<PaymentSessionId>19283746509</PaymentSessionId>
<TenderType>VC</TenderType>
<PaymentAccountUniqueId isToken="true">4387751111111111</PaymentAccountUniqueId>
</PaymentContext>
<PaymentRequestId>12345678909</PaymentRequestId>
<CreateTimeStamp>2013-12-25T09:35:16</CreateTimeStamp>
<Amount>99.99</Amount>
<Authorization>
<ResponseCode>APPROVED</ResponseCode>
<BankAuthorizationCode>123456</BankAuthorizationCode>
<CVV2ResponseCode>M</CVV2ResponseCode>
<AVSResponseCode>Y</AVSResponseCode>
<ExtendedAuthorizationResponseCodes>
<ResponseCodeDescription>Lorem Ipsum Dolor Sit</ResponseCodeDescription>
<ReasonCode>0</ReasonCode>
</ExtendedAuthorizationResponseCodes>
<AmountAuthorized>108.79</AmountAuthorized>
</Authorization>
<ExpirationDate>2015-12</ExpirationDate>
<StartDate>2013-12</StartDate>
<IssueNumber>I001</IssueNumber>
<SecureVerificationData>
<AuthenticationAvailable>true</AuthenticationAvailable>
<AuthenticationStatus>Y</AuthenticationStatus>
<CavvUcaf>false</CavvUcaf>
<TransactionId>1</TransactionId>
<ECI>05</ECI>
<PayerAuthenticationResponse>test response</PayerAuthenticationResponse>
</SecureVerificationData>
</CreditCard>
</Payments>
</Payment>
<Currency>USD</Currency>
<TaxHeader>
<Error>false</Error>
</TaxHeader>
<PrintedCatalogCode>Jan2010</PrintedCatalogCode>
<Locale>en_US</Locale>
<CustomAttributes>
<Attribute>
<Key>CustomOrderAttrib1</Key>
<Value>Interpol</Value>
</Attribute>
<Attribute>
<Key>CustomOrderAttrib2</Key>
<Value>BlackKeys</Value>
</Attribute>
</CustomAttributes>
<OrderHistoryUrl>http://orderlookup.com</OrderHistoryUrl>
</Order>
<Context>
<BrowserData>
<HostName>HostName</HostName>
<IPAddress>127.0.0.1</IPAddress>
<SessionId>SessionId</SessionId>
<UserAgent>UserAgent</UserAgent>
<Connection>Connection</Connection>
<Cookies>Cookies</Cookies>
<UserCookie>sds</UserCookie>
<UserAgentOS>OS X</UserAgentOS>
<UserAgentCPU>INTEL</UserAgentCPU>
<HeaderFrom>goog</HeaderFrom>
<EmbeddedWebBrowserFrom>Chrome</EmbeddedWebBrowserFrom>
<JavascriptData>ssd</JavascriptData>
<Referrer>fref</Referrer>
<HTTPAcceptData>
<ContentTypes>ContentTypes</ContentTypes>
<Encoding>Encoding</Encoding>
<Language>Language</Language>
<CharSet>CharSet</CharSet>
</HTTPAcceptData>
</BrowserData>
<SessionInfo>
<RTCTransactionResponseCode>RTCTransactionResponseCode</RTCTransactionResponseCode>
<RTCReasonCodes>RTCReasonCodes</RTCReasonCodes>
</SessionInfo>
<CustomAttributes>
<Attribute>
<Key>AmexPhoneResp</Key>
<Value>Hello, how are you</Value>
</Attribute>
<Attribute>
<Key>AmexNameResp</Key>
<Value>Sir Digsby Chicken Caesar</Value>
</Attribute>
</CustomAttributes>
</Context>
</OrderCreateRequest>
<OrderCreateRequest orderType="SALES" requestId="00025-980677361" testType="">
<Order customerOrderId="00026BOREG000265">
<Customer customerId="null0002690000000102">
<Name>
<Honorific>Mr</Honorific>
<LastName>Jones</LastName>
<MiddleName>Jr</MiddleName>
<FirstName>Indiana</FirstName>
</Name>
<EmailAddress>bahn@ebay.com</EmailAddress>
<CustomerTaxId>973935484</CustomerTaxId>
</Customer>
<CreateTime>2013-12-25T09:35:16</CreateTime>
<OrderItems>
<OrderItem id="item_1" webLineId="1">
<ItemId>21-58341C0F</ItemId>
<Quantity>1</Quantity>
<Description>
<Description>Fisher-Price Harley Davidson Lights and Sounds Tricycle</Description>
<Color id="x">Red</Color>
<Size id="b">10</Size>
</Description>
<Pricing>
<Merchandise>
<Amount>99.99</Amount>
<PromotionalDiscounts>
<Discount>
<Id>Promo3</Id>
<Code>PromoCode3</Code>
<Amount>4.99</Amount>
<Description>Item Discount for Loyalty</Description>
</Discount>
<Discount>
<Id>Promo4</Id>
<Code>PromoCode4</Code>
<Amount>3.99</Amount>
<Description>Item Discount for Holidays</Description>
</Discount>
</PromotionalDiscounts>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SALES" taxability="TAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="PA" jurisdictionLevel="STATE">us</Jurisdiction>
<Imposition impositionType="imp">imposition</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>99.99</TaxableAmount>
<CalculatedTax>5.99</CalculatedTax>
<SellerRegistrationId>DEFAULT</SellerRegistrationId>
</Tax>
<Tax taxType="VAT" taxability="NONTAXABLE">
<Situs>DESTINATION</Situs>
<Jurisdiction jurisdictionId="PA" jurisdictionLevel="STATE">us</Jurisdiction>
<Imposition impositionType="imp">imposition</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>30.00</TaxableAmount>
<CalculatedTax>1.80</CalculatedTax>
<SellerRegistrationId>DEFAULT</SellerRegistrationId>
</Tax>
</Taxes>
</TaxData>
<UnitPrice>99.99</UnitPrice>
</Merchandise>
<Shipping>
<Amount>9.99</Amount>
<PromotionalDiscounts>
<Discount>
<Id>Promo1</Id>
<Code>PromoCode1</Code>
<Amount>1.99</Amount>
<Description>Shipping Discount for Loyalty</Description>
</Discount>
<Discount>
<Id>Promo2</Id>
<Code>PromoCode2</Code>
<Amount>2.99</Amount>
<Description>Shipping Discount for Holidays</Description>
</Discount>
</PromotionalDiscounts>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SALES" taxability="EXEMPT">
<Situs>SHIP_DESTINATION</Situs>
<Jurisdiction jurisdictionId="PA" jurisdictionLevel="STATE">us</Jurisdiction>
<Imposition impositionType="imp">ship tax imposition</Imposition>
<EffectiveRate>0.06</EffectiveRate>
<TaxableAmount>99.99</TaxableAmount>
<CalculatedTax>5.99</CalculatedTax>
<SellerRegistrationId>DEFAULT</SellerRegistrationId>
</Tax>
</Taxes>
</TaxData>
</Shipping>
<Duty>
<Amount>1.99</Amount>
<TaxData>
<TaxClass>89999</TaxClass>
<Taxes>
<Tax taxType="SALES" taxability="EXEMPT">
<Situs>Duty_DESTINATION</Situs>
<Jurisdiction jurisdictionId="PA" jurisdictionLevel="STATE">us</Jurisdiction>
<Imposition impositionType="imp">duty tax imposition</Imposition>
<EffectiveRate>0.02</EffectiveRate>
<TaxableAmount>9.99</TaxableAmount>
<CalculatedTax>2.99</CalculatedTax>
<SellerRegistrationId>DEFAULT</SellerRegistrationId>
</Tax>
</Taxes>
</TaxData>
</Duty>
</Pricing>
<ShippingMethod>UPS - 2 DAY</ShippingMethod>
<EstimatedDeliveryDate>
<DeliveryWindow>
<From>2014-01-02T15:00:00</From>
<To>2014-01-05T15:00:00</To>
</DeliveryWindow>
<ShippingWindow>
<From>2013-12-31T15:00:00</From>
<To>2013-12-31T15:00:00</To>
</ShippingWindow>
<Mode>CALIBRATION</Mode>
<MessageType>DeliveryDate</MessageType>
<Template>1</Template>
</EstimatedDeliveryDate>
<CustomAttributes>
<Attribute>
<Key>CustomOrderItemAttrib1</Key>
<Value>BRMC</Value>
</Attribute>
<Attribute>
<Key>CustomOrderItemAttrib2</Key>
<Value>BJM</Value>
</Attribute>
</CustomAttributes>
<ReservationId>12345</ReservationId>
</OrderItem>
</OrderItems>
<Shipping>
<ShipGroups>
<ShipGroup chargeType="" id="shipGroup_1">
<DestinationTarget ref="dest_1"/>
<OrderItems>
<Item ref="item_1"/>
</OrderItems>
</ShipGroup>
</ShipGroups>
<Destinations>
<MailingAddress id="dest_1">
<PersonName>
<Honorific>Mrs.</Honorific>
<LastName>Jones</LastName>
<MiddleName>K.</MiddleName>
<FirstName>Jeniffer</FirstName>
</PersonName>
<Address>
<Line1>630 Allendale Rd.</Line1>
<City>King of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<Phone>215-555-1212</Phone>
</MailingAddress>
<MailingAddress id="billing_1">
<PersonName>
<Honorific>Mr.</Honorific>
<LastName>Jones</LastName>
<MiddleName>Jr.</MiddleName>
<FirstName>Indiana</FirstName>
</PersonName>
<Address>
<Line1>630 Allendale Rd.</Line1>
<City>King of Prussia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19406</PostalCode>
</Address>
<Phone>215-555-1212</Phone>
</MailingAddress>
</Destinations>
</Shipping>
<Payment>
<BillingAddress ref="billing_1"/>
<Payments>
<CreditCard>
<PaymentContext>
<PaymentSessionId>19283746509</PaymentSessionId>
<TenderType>VC</TenderType>
<PaymentAccountUniqueId isToken="true">4387751111111111</PaymentAccountUniqueId>
</PaymentContext>
<PaymentRequestId>12345678909</PaymentRequestId>
<CreateTimeStamp>2013-12-25T09:35:16</CreateTimeStamp>
<Amount>99.99</Amount>
<Authorization>
<ResponseCode>APPROVED</ResponseCode>
<BankAuthorizationCode>123456</BankAuthorizationCode>
<CVV2ResponseCode>M</CVV2ResponseCode>
<AVSResponseCode>Y</AVSResponseCode>
<ExtendedAuthorizationResponseCodes>
<ResponseCodeDescription>Lorem Ipsum Dolor Sit</ResponseCodeDescription>
<ReasonCode>0</ReasonCode>
</ExtendedAuthorizationResponseCodes>
<AmountAuthorized>108.79</AmountAuthorized>
</Authorization>
<ExpirationDate>2015-12</ExpirationDate>
<StartDate>2013-12</StartDate>
<IssueNumber>I001</IssueNumber>
<SecureVerificationData>
<AuthenticationAvailable>true</AuthenticationAvailable>
<AuthenticationStatus>Y</AuthenticationStatus>
<CavvUcaf>false</CavvUcaf>
<TransactionId>1</TransactionId>
<ECI>05</ECI>
<PayerAuthenticationResponse>test response</PayerAuthenticationResponse>
</SecureVerificationData>
</CreditCard>
</Payments>
</Payment>
<Currency>USD</Currency>
<TaxHeader>
<Error>false</Error>
</TaxHeader>
<PrintedCatalogCode>Jan2010</PrintedCatalogCode>
<Locale>en_US</Locale>
<CustomAttributes>
<Attribute>
<Key>CustomOrderAttrib1</Key>
<Value>Interpol</Value>
</Attribute>
<Attribute>
<Key>CustomOrderAttrib2</Key>
<Value>BlackKeys</Value>
</Attribute>
</CustomAttributes>
<OrderHistoryUrl>http://orderlookup.com</OrderHistoryUrl>
</Order>
<Context>
<BrowserData>
<HostName>HostName</HostName>
<IPAddress>127.0.0.1</IPAddress>
<SessionId>SessionId</SessionId>
<UserAgent>UserAgent</UserAgent>
<Connection>Connection</Connection>
<Cookies>Cookies</Cookies>
<UserCookie>sds</UserCookie>
<UserAgentOS>OS X</UserAgentOS>
<UserAgentCPU>INTEL</UserAgentCPU>
<HeaderFrom>goog</HeaderFrom>
<EmbeddedWebBrowserFrom>Chrome</EmbeddedWebBrowserFrom>
<JavascriptData>ssd</JavascriptData>
<Referrer>fref</Referrer>
<HTTPAcceptData>
<ContentTypes>ContentTypes</ContentTypes>
<Encoding>Encoding</Encoding>
<Language>Language</Language>
<CharSet>CharSet</CharSet>
</HTTPAcceptData>
</BrowserData>
<SessionInfo>
<RTCTransactionResponseCode>RTCTransactionResponseCode</RTCTransactionResponseCode>
<RTCReasonCodes>RTCReasonCodes</RTCReasonCodes>
</SessionInfo>
<CustomAttributes>
<Attribute>
<Key>AmexPhoneResp</Key>
<Value>Hello, how are you</Value>
</Attribute>
<Attribute>
<Key>AmexNameResp</Key>
<Value>Sir Digsby Chicken Caesar</Value>
</Attribute>
</CustomAttributes>
</Context>
</OrderCreateRequest>
</BulkOrderCreateRequest>