Order Returned In Transit Event

The Order Returned InTransit event is triggered when a returned item has been shipped by the customer.

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 OrderReturnInTransit message.

• If you use the webhooks-based implementation, a set of events is grouped together in an OrderOrderReturnInTransitList message.

Schema:

• Order-Return-InTransit-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

OrderReturnInTransit Message

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

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

Single-Event Message Example

<?xml version="1.0" encoding="UTF-8"?>
<OrderReturnInTransit xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
                      customerOrderId="000536012121212"
                      storeId="TMS_US">
   <Customer>
      <Name>
         <LastName>Last Name</LastName>
         <FirstName>First Name</FirstName>
      </Name>
      <EmailAddress>email@example.com</EmailAddress>
   </Customer>
   <ReturnLabelInfo>
      <RMAId/>
      <CarrierName>UPS</CarrierName>
      <CarrierServiceCode>GROUND</CarrierServiceCode>
      <LabelNumber>1ZA308299000974019</LabelNumber>
      <TrackingURL>http://wwwapps.ups.com/WebTracking/processInputRequest?tracknums_displayed=5&amp;TypeOfInquiryNumber=T&amp;button_index=201&amp;loc=en_US&amp;AgreeToTermsAndConditions=yes&amp;track.x=37&amp;track.y=6&amp;InquiryNumber1=1ZA308299000974019</TrackingURL>
      <LabelCode>UW</LabelCode>
   </ReturnLabelInfo>
</OrderReturnInTransit>

OrderReturnInTransitList Message

For Webhooks-based implementations, Order Returned In Transit events are grouped together in one OrderReturnInTransitList message.

Event List Message Example

<?xml version="1.0" encoding="UTF-8"?>
<OrderReturnInTransitList xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
                      customerOrderId="000536012121212"
                      storeId="TMS_US">
   <Customer>
      <Name>
         <LastName>Last Name</LastName>
         <FirstName>First Name</FirstName>
      </Name>
      <EmailAddress>email@example.com</EmailAddress>
   </Customer>
   <ReturnLabelInfo>
      <RMAId/>
      <CarrierName>UPS</CarrierName>
      <CarrierServiceCode>GROUND</CarrierServiceCode>
      <LabelNumber>1ZA308299000974019</LabelNumber>
      <TrackingURL>http://wwwapps.ups.com/WebTracking/processInputRequest?tracknums_displayed=5&amp;TypeOfInquiryNumber=T&amp;button_index=201&amp;loc=en_US&amp;AgreeToTermsAndConditions=yes&amp;track.x=37&amp;track.y=6&amp;InquiryNumber1=1ZA308299000974019</TrackingURL>
      <LabelCode>UW</LabelCode>
   </ReturnLabelInfo>
</OrderReturnInTransitList>