Return Credit Request API Structure
|
| Field Name |
DataType |
Required |
Instances |
Minimum Usage |
Maximum Usage |
Minimum Length |
Maximum Length |
XPath |
Documentation |
| ReturnCreditRequest |
AnyType |
Yes |
0 |
|
|
|
|
/ReturnCreditRequest |
|
| |
MessageHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ReturnCreditRequest/MessageHeader |
Encapsulates message routing data. The elements included in this grouping are standard across all messages. |
| |
|
Standard |
String |
Yes |
0 |
1 |
1 |
|
10 |
/ReturnCreditRequest/MessageHeader/Standard |
Code identifying the schema controlling agency. |
| |
|
HeaderVersion |
String |
Yes |
0 |
1 |
1 |
|
10 |
/ReturnCreditRequest/MessageHeader/HeaderVersion |
Version of the message being used. 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 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. |
| |
|
VersionReleaseNumber |
String |
Yes |
0 |
1 |
1 |
|
15 |
/ReturnCreditRequest/MessageHeader/VersionReleaseNumber |
Release number within the current message header version number. |
| |
|
SourceData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ReturnCreditRequest/MessageHeader/SourceData |
Encapsulates data related to the Source or the Sending system. |
| |
|
|
SourceId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/ReturnCreditRequest/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. |
| |
|
|
SourceType |
String |
Yes |
0 |
1 |
1 |
|
10 |
/ReturnCreditRequest/MessageHeader/SourceData/SourceType |
The descriptive category/name/code used to define the system that originated the message. OMS = Order Management System, WMS = Warehouse Management System. |
| |
|
DestinationData |
AnyType |
Yes |
1 |
1 |
1 |
|
|
/ReturnCreditRequest/MessageHeader/DestinationData |
Encapsulates data related to the Destination or Receiving system. |
| |
|
|
DestinationId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/ReturnCreditRequest/MessageHeader/DestinationData/DestinationId |
Unique identifier of the System that is the intended recipient of the message. There can be more than one DestinationId/DestinationType sets per message to allow for one message to be sent to multiple receiving systems. |
| |
|
|
DestinationType |
String |
Yes |
0 |
1 |
1 |
|
10 |
/ReturnCreditRequest/MessageHeader/DestinationData/DestinationType |
The descriptive category used to define the system that is the intended recipient of the message. OMS = Order Management System, WMS = Warehouse Management System. |
| |
|
EventType |
String |
Yes |
0 |
1 |
1 |
|
35 |
/ReturnCreditRequest/MessageHeader/EventType |
The name of the event to which the message pertains. |
| |
|
MessageData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ReturnCreditRequest/MessageHeader/MessageData |
Encapsulates message identification information. |
| |
|
|
MessageId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/ReturnCreditRequest/MessageHeader/MessageData/MessageId |
Globally unique identifier for each message. The MessageId will be populated from the source system and must be a global identifier for Radial Xchange. |
| |
|
|
CorrelationId |
String |
No |
0 |
0 |
1 |
|
20 |
/ReturnCreditRequest/MessageHeader/MessageData/CorrelationId |
When present, it must contain the MessageId value of an earlier Radial Xchange Message to which this message relates. |
| |
|
CreateDateAndTime |
|
Yes |
0 |
1 |
1 |
|
|
/ReturnCreditRequest/MessageHeader/CreateDateAndTime |
Original message creation date and time assigned by the Source. Follows ISO 8601 standard with offset from UTC. |
| |
ReturnCreditRequestData |
AnyType |
Yes |
1 |
1 |
-1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData |
Encapsulates the request details and allows for multiple Return Credit Requests to be sent from the WMS to the OMS. |
| |
|
ReturnCreditRequestHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader |
Encapsulates the Header level information related to the Return Transaction. |
| |
|
|
ClientId |
String |
No |
0 |
0 |
1 |
|
32 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/ClientId |
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. Note - require gsi_store_id if not included. |
| |
|
|
FacilityId |
String |
Yes |
0 |
1 |
1 |
|
32 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/FacilityId |
Unique identifier of the facility. |
| |
|
|
ReturnOrderId |
String |
No |
0 |
0 |
1 |
|
30 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/ReturnOrderId |
The identifier assigned to the return transaction. |
| |
|
|
ReturnDateTime |
|
Yes |
0 |
1 |
1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/ReturnDateTime |
The date and time when the return order was received. Follows ISO 8601 standard with offset from UTC. |
| |
|
|
OriginalOMSOrderId |
|
No |
0 |
0 |
1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/OriginalOMSOrderId |
The Original Order Id assigned by the Order Management System. If the OriginalExternalShipmentId (A third-party fulfiller’s Shipment Identifier) is present then the OriginalOMSOrderId becomes optional. |
| |
|
|
OriginalCustomerOrderId |
String |
No |
0 |
0 |
1 |
|
30 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/OriginalCustomerOrderId |
The Original Order Id that is known to the customer. Typically this is assigned by the Web or Order Source System. This is required if the OriginalOMSOrderId is not present. |
| |
|
|
MarketplaceOrderId |
String |
No |
0 |
0 |
1 |
|
30 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/MarketplaceOrderId |
For clients with MP who are unable to send the OriginalOMSOrderId in the RCR’s, we have found that OMS system will throw exception since they definitely need this value at their system for MP RCR’s to pass. The only work around is that OMS can still work with the 'Marketplace Order ID' – but they need it as OMS field “ExtnReferenceOrderNo”. |
| |
|
|
OriginalExternalShipmentId |
String |
No |
0 |
0 |
1 |
|
40 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/OriginalExternalShipmentId |
The original External Shipment ID - A third-party fulfiller’s Shipment Identifier. If the OriginalOMSOrderId is not present then original External Shipment ID is required. |
| |
|
|
ExtendedAttributes |
AnyType |
No |
1 |
0 |
-1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/ExtendedAttributes |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/ExtendedAttributes/Name |
The short title of the additional attribute. |
| |
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/ExtendedAttributes/Description |
A brief description of the additional attribute. |
| |
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestHeader/ExtendedAttributes/Value |
The specific value of the additional attribute. |
| |
|
ReturnCreditRequestDetail |
AnyType |
Yes |
1 |
1 |
-1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail |
Encapsulates line level/item level details about the Return Order. |
| |
|
|
ReturnOrderLineNumber |
|
No |
0 |
0 |
1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ReturnOrderLineNumber |
Line number of the return order. |
| |
|
|
OriginalOrderLineNumber |
|
No |
0 |
0 |
1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/OriginalOrderLineNumber |
Line number of the original order. |
| |
|
|
ItemId |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ItemId |
Encapsulates the set of various references that can be used to identify an item/SKU. |
| |
|
|
|
GsiCatalogId |
String |
No |
0 |
0 |
1 |
|
4 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/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 |
Yes |
0 |
1 |
1 |
|
35 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ItemId/ClientItemId |
The retailer's SKU or unique item identifier. (Partner Item Number) |
| |
|
|
|
OMSItemId |
|
No |
0 |
0 |
1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ItemId/OMSItemId |
The Radial SKU or unique item identifier. |
| |
|
|
|
ClientAltItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ItemId/ClientAltItemId |
An Alternative item identifier provided by the client. |
| |
|
|
|
ExtendedAttributes |
AnyType |
No |
1 |
0 |
-1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ItemId/ExtendedAttributes |
|
| |
|
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ItemId/ExtendedAttributes/Name |
The short title of the additional attribute. |
| |
|
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ItemId/ExtendedAttributes/Description |
A brief description of the additional attribute. |
| |
|
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ItemId/ExtendedAttributes/Value |
The specific value of the additional attribute. |
| |
|
|
QuantityReturned |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/QuantityReturned |
The quantity of the item returned. |
| |
|
|
CustomerReasonCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/CustomerReasonCode |
The Customer identified reason for the return. |
| |
|
|
FacilityReasonCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/FacilityReasonCode |
The Facility identified reason for the return. |
| |
|
|
RTANumber |
String |
No |
0 |
0 |
1 |
|
30 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/RTANumber |
The Return Authorization number, required for goods needing authorization before they can be accepted as a return. |
| |
|
|
DispositionCode |
String |
No |
0 |
0 |
1 |
|
1 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/DispositionCode |
Identifies the condition of the item. Typically used when an item is considered damaged when being returned. S = Sellable, D = Non-sellable/Damaged. |
| |
|
|
LineComment |
String |
No |
0 |
0 |
1 |
|
150 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/LineComment |
Additional comments as necessary for the returned item. |
| |
|
|
ExtendedAttributes |
AnyType |
No |
1 |
0 |
-1 |
|
|
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ExtendedAttributes |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ExtendedAttributes/Name |
The short title of the additional attribute. |
| |
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ExtendedAttributes/Description |
A brief description of the additional attribute. |
| |
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/ReturnCreditRequest/ReturnCreditRequestData/ReturnCreditRequestDetail/ExtendedAttributes/Value |
The specific value of the additional attribute. |