In-Store Return Feed

Overview

For a customer-returned order, the In-Store Return feed transmits information from a client store (client central system) to Order Management. Order Management updates the order data with the return information. The order is flagged as returned for reporting purposes and to prevent duplicate returns.

Notes:

  • Default Character Encoding: Unicode: UTF-8
  • Recipient Acknowledgment Required: Yes
  • Exchange Frequency: Client Specific
  • Production Mailbox Location: Client Specific
  • Test Mailbox Location: Client Specific
  • Filename Format: <ClientId>_<StoreId>_InStoreReturn_<YYYYMMDDHHMISS>.xml
  • The filename combined with the mailbox determines the destination of the In Store Return message.

Schema

In-store return schema: InStoreReturn.xsd

API Structure

In-store return element table: InStoreReturn.xsd.html

Example

ClosedIn-store Return

In the following example, elements with special meaning for this item type are noted in /*comments*/ before the element.

Copy this code sample. 

<InStoreReturn>
   <MessageHeader>
      <Standard>GSI</Standard>
      <HeaderVersion>NGP1.1.0</HeaderVersion>
      <VersionReleaseNumber>NGP1.1.0</VersionReleaseNumber>
      <SourceData>
         <SourceId>TMSNA</SourceId>
         <SourceType>STORE</SourceType>
      </SourceData>
      <DestinationData>
         <DestinationId>GSI</DestinationId>
         <DestinationType>FH</DestinationType>
      </DestinationData>
      <EventType>InStoreReturn</EventType>
      <MessageData>
         <MessageId>600000001</MessageId>
         <CorrelationId>123456789</CorrelationId>
      </MessageData>
      <CreateDateAndTime>2013-08-02T15:05:37-07:00</CreateDateAndTime>
   </MessageHeader>
   <InStoreReturnData>
      <OriginalOMSOrderID>123456789012001</OriginalOMSOrderID> 
      /*To match the returned order against the order record in Order Management, you
      must provide either the OriginalOMSOrderID or the OriginalWebOrderNumber. For reference, this
      example includes both values.*/
      <OriginalWebOrderNumber>7590872569</OriginalWebOrderNumber>
      <gsi_client_id>TMSNA</gsi_client_id>
      <gsi_store_id>TMSUS</gsi_store_id>
      <GsiCatalogId>21</GsiCatalogId>
      <PartnerRetailStoreNumber>82</PartnerRetailStoreNumber>
      <ItemID> 
      /*To match the returned order against the SKU being returned, you must provide either the
      ClientItemId (the client's unique identifier for the SKU) or the OMSItemId (the Radial 
      unique identifier for the SKU). For reference, this example includes both values,
      but you should provide only one of the two values in your InStoreReturnData entry.*/
         <ClientItemId>887170553003</ClientItemId>
         <OMSItemId>40123456</OMSItemId>
      </ItemID>
      <ReturnedQuantity>1</ReturnedQuantity>
      <CreditAmount>
         <MonetaryAmount>69.5</MonetaryAmount>
         <CurrencyCode>USD</CurrencyCode>
      </CreditAmount>
      <ReturnedDateTime>2013-05-01T10:56:49-07:00</ReturnedDateTime>
   </InStoreReturnData>
</InStoreReturn>

Data Keys

ISO Standard Definition
Country – ISO 3166-1 2 Letter Country Standard
Currency – ISO 4217 Currency Standard
Time – ISO 8601 Date Time Standard