In-Store Return API Structure
|
| Field Name |
DataType |
Required |
Instances |
Minimum Usage |
Maximum Usage |
Minimum Length |
Maximum Length |
XPath |
Documentation |
| InStoreReturn |
AnyType |
Yes |
0 |
|
|
|
|
/InStoreReturn |
|
| |
MessageHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/InStoreReturn/MessageHeader |
Encapsulates message routing data. The elements included in this grouping are standard across all messages |
| |
|
Standard |
String |
Yes |
0 |
1 |
1 |
|
10 |
/InStoreReturn/MessageHeader/Standard |
Code identifying the schema-controlling agency, for example, GSI.
Allowable Values: Text string
Required: Yes
Length: 10
Default Value: GSI
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
HeaderVersion |
String |
Yes |
0 |
1 |
1 |
|
10 |
/InStoreReturn/MessageHeader/HeaderVersion |
Version of the message being used, for example NGP1.0.0. Each new version whole number represents a significant change from a previous whole version and reflects a need for upgrades. For example, a change from Version 1.X to 2.X or 2.X to NGP1.0.0 represents a substantial change in the framework and would be a recommended upgrade point. A change in the number after the decimal represents a minor upgrade/modification to the framework.
Allowable Values: Text string
Required: Yes
Length: 10
Default Value: NGP1.0.0 or current version on which partner is launched
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
VersionReleaseNumber |
String |
Yes |
0 |
1 |
1 |
|
15 |
/InStoreReturn/MessageHeader/VersionReleaseNumber |
Release number within the current message header version which is the same as HeaderVersion in most cases.
Allowable Values: Text string
Required: Yes
Length: 15
Default Value: NGP1.0.0 or current version on which partner is launched
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
SourceData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/InStoreReturn/MessageHeader/SourceData |
Encapsulates data related to the Source or the Sending system |
| |
|
|
SourceId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/InStoreReturn/MessageHeader/SourceData/SourceId |
Unique identifier of the System that originated the message. The SourceId is a unique identifier provided by the initiator of the message. For those messages originating from an Order Management System (OMS), it would be the unique OMS identifier. For those messages originating from a Warehouse Management System (WMS), it would be the unique WMS identifier.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
SourceType |
String |
Yes |
0 |
1 |
1 |
|
10 |
/InStoreReturn/MessageHeader/SourceData/SourceType |
The descriptive category/name/code used to define the system that originated the message.
Allowable Values:
OMS = Order Management System
WMS = Warehouse Management System
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
DestinationData |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/InStoreReturn/MessageHeader/DestinationData |
Encapsulates data related to the Destination or Receiving system |
| |
|
|
DestinationId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/InStoreReturn/MessageHeader/DestinationData/DestinationId |
Unique identifier of the System that is the intended recipient of the message. There can be multiple DestinationId/DestinationType sets per message to allow for one message to be sent to multiple receiving systems.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
DestinationType |
String |
Yes |
0 |
1 |
1 |
|
10 |
/InStoreReturn/MessageHeader/DestinationData/DestinationType |
The descriptive category used to define the system that is the intended recipient of the message.
Allowable Values:
OMS = Order Management System,
WMS = Warehouse Management System,
FH= Fulfillment Hub.
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
EventType |
String |
Yes |
0 |
1 |
1 |
|
35 |
/InStoreReturn/MessageHeader/EventType |
The name of the event to which the message pertains.
Allowable Values: InventoryStatus
Required: Yes
Length: 35
Default Value: InventoryStatus
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
MessageData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/InStoreReturn/MessageHeader/MessageData |
Encapsulates message identification information |
| |
|
|
MessageId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/InStoreReturn/MessageHeader/MessageData/MessageId |
Globally unique identifier for each Message. The MessageId is populated from the Source system and must be a global identifier for Radial.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: any non blank value
Restrictions: In cases when the Product Hub or Fulfillment Hub originates the message, this field is the unique Business Process ID (BPID).
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
CorrelationId |
String |
No |
0 |
0 |
1 |
|
20 |
/InStoreReturn/MessageHeader/MessageData/CorrelationId |
When present, it must contain the MessageId value of an earlier Radial Message to which this message relates.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
CreateDateAndTime |
|
Yes |
0 |
1 |
1 |
|
|
/InStoreReturn/MessageHeader/CreateDateAndTime |
Original message creation date and time assigned by the Source.
Allowable Values: ISO 8601 standard with offset from UTC in xsd:datetime data format which is yyyy-mm-ddTHH:mm:ss-hh:mm for e.g. 2012-01-11T14:19:05-06:00, 2012-01-11T14:19:05Z.
Required: Yes
Length: xsd:datetime.
Default Value: Current Date Time
Restrictions: Needs to be complying with yyyy-mm-ddTHH:mm:ss-hh:mm format
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
InStoreReturnData |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/InStoreReturn/InStoreReturnData |
|
| |
|
OriginalOMSOrderID |
|
No |
0 |
0 |
1 |
|
|
/InStoreReturn/InStoreReturnData/OriginalOMSOrderID |
12-digit OMS Order Number plus 3-digit reference ID.
Allowable Values: Integer
Required: Required if the OriginalWebOrderNumber is not provided.
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
OriginalWebOrderNumber |
String |
No |
0 |
0 |
1 |
|
30 |
/InStoreReturn/InStoreReturnData/OriginalWebOrderNumber |
Identifier assigned when the order was originaly placed using the web store.
Allowable Values: Text string
Required: Required if the OriginalOMSOrderID is not provided.
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
OriginalCustomerOrderID |
String |
No |
0 |
0 |
1 |
|
30 |
/InStoreReturn/InStoreReturnData/OriginalCustomerOrderID |
original Exchange Platform order.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
gsi_client_id |
String |
Yes |
0 |
1 |
1 |
|
32 |
/InStoreReturn/InStoreReturnData/gsi_client_id |
The identifier provided by Radial for an individual or organization that has a contractual relationship with Radial in which Radial is providing e-commerce, fulfillment or other services for the individual or organization. This refers to the V11/ ECP1.0.0 gsi_client_id. e.g. TMSNA.
Allowable Values: Text string
Required: Yes
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
gsi_store_id |
String |
Yes |
0 |
1 |
1 |
|
32 |
/InStoreReturn/InStoreReturnData/gsi_store_id |
Radial assigned store ID.
Allowable Values: Text string
Required: Yes
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
GsiCatalogId |
String |
Yes |
0 |
1 |
1 |
|
4 |
/InStoreReturn/InStoreReturnData/GsiCatalogId |
Radial assigned catalog ID.
Allowable Values: Text string
Required: Yes
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
PartnerRetailStoreNumber |
String |
Yes |
0 |
1 |
1 |
|
32 |
/InStoreReturn/InStoreReturnData/PartnerRetailStoreNumber |
Identifies the Retail Store Number in which the customer returned the item that was originally purchased from the web store.
Allowable Values: Text string
Required: Yes
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
ItemID |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/InStoreReturn/InStoreReturnData/ItemID |
|
| |
|
|
GsiCatalogId |
String |
No |
0 |
0 |
1 |
|
4 |
/InStoreReturn/InStoreReturnData/ItemID/GsiCatalogId |
This Radial -assigned value specifies to which catalog an item belongs. An item may belong to only one catalog. Used to cross category link products.
Allowable Values: Text string
Required: Yes either at standard element level or thru extended attributes.
Length: 4
Restrictions: The catalog ID must exist in the Radial system. |
| |
|
|
ClientItemId |
String |
No |
0 |
0 |
1 |
|
35 |
/InStoreReturn/InStoreReturnData/ItemID/ClientItemId |
The retailer/client unique item id or SKU used to identify the item. This is the unique id which is being sent on the Item Master catalog.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OMSItemId |
|
No |
0 |
0 |
1 |
|
|
/InStoreReturn/InStoreReturnData/ItemID/OMSItemId |
The Radial Internally assigned unique identifier, AKA JDA SKU or GSI SKU or OMS SKU or GII or Radial SKU. Not applicable for 3rd Party fulfillment model in V11 platform.
Allowable Values: Integer
Required: No
Length: 9
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/InStoreReturn/InStoreReturnData/ItemID/ExtendedAttributes |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/InStoreReturn/InStoreReturnData/ItemID/ExtendedAttributes/Name |
The short title of the additional attribute, for example "CatalogId."
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/InStoreReturn/InStoreReturnData/ItemID/ExtendedAttributes/Description |
A brief description of the additional attribute
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/InStoreReturn/InStoreReturnData/ItemID/ExtendedAttributes/Value |
The specific value of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
ReturnedQuantity |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/InStoreReturn/InStoreReturnData/ReturnedQuantity |
Quantity returned to the store.
Allowable Values: Decimal
Required: Yes
Length: 10.2
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
CreditAmount |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/InStoreReturn/InStoreReturnData/CreditAmount |
Encapsulates the information necessary for reflecting the credit issued in-store against the returned item. |
| |
|
|
MonetaryAmount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/InStoreReturn/InStoreReturnData/CreditAmount/MonetaryAmount |
The monetary amount for the defined amount type.
Allowable Values: Decimal
Required: Yes
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
CurrencyCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/InStoreReturn/InStoreReturnData/CreditAmount/CurrencyCode |
The type of currency (dollars, francs, etc.) associated with the monetary amount.
The type of currency (dollars, francs, etc) used for the transaction.
Allowable Values: ISO 4217 currency code. http://www.iso.org/iso/support/currency_codes_list-1.htm
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
ReturnedDateTime |
|
Yes |
0 |
1 |
1 |
|
|
/InStoreReturn/InStoreReturnData/ReturnedDateTime |
Date and time returned to the store.
Allowable Values: ISO 8601 standard with offset from UTC in:datetime data format which is yyyy-mm-ddTHH:mm:ss-hh:mm for e.g. 2012-01-11T14:19:05-06:00
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/InStoreReturn/InStoreReturnData/ExtendedAttributes |
|
| |
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/InStoreReturn/InStoreReturnData/ExtendedAttributes/Name |
The short title of the additional attribute, for example "CatalogId."
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/InStoreReturn/InStoreReturnData/ExtendedAttributes/Description |
A brief description of the additional attribute
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/InStoreReturn/InStoreReturnData/ExtendedAttributes/Value |
The specific value of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |