API Structure
|
| Field Name |
DataType |
Required |
Instances |
Minimum Usage |
Maximum Usage |
Minimum Length |
Maximum Length |
XPath |
Documentation |
| InventoryStatus |
AnyType |
Yes |
0 |
|
|
|
|
/InventoryStatus |
|
| |
MessageHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/InventoryStatus/MessageHeader |
Encapsulates message routing data. The elements included in this grouping are standard across all messages. |
| |
|
Standard |
String |
Yes |
0 |
1 |
1 |
|
10 |
/InventoryStatus/MessageHeader/Standard |
Code identifying the schema controlling agency, for example, Radial
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 |
/InventoryStatus/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 |
/InventoryStatus/MessageHeader/VersionReleaseNumber |
Release number within the current message header version which is same as HeaderVersion in most of the 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 |
|
|
/InventoryStatus/MessageHeader/SourceData |
Encapsulates data related to the Source or the Sending system. |
| |
|
|
SourceId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/InventoryStatus/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 |
/InventoryStatus/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 |
|
|
/InventoryStatus/MessageHeader/DestinationData |
Encapsulates data related to the Destination or Receiving system. |
| |
|
|
DestinationId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/InventoryStatus/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 |
/InventoryStatus/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 |
/InventoryStatus/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 |
|
|
/InventoryStatus/MessageHeader/MessageData |
Encapsulates message identification information |
| |
|
|
MessageId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/InventoryStatus/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 Inc.
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 |
/InventoryStatus/MessageHeader/MessageData/CorrelationId |
When present, it must contain the MessageId value of an earlier Radial Inc 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 |
|
|
/InventoryStatus/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 |
| |
ItemInventory |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/InventoryStatus/ItemInventory |
Encapsulates the inventory header data to identify the Radial Inc client, catalog and facility information |
| |
|
ClientId |
String |
No |
0 |
0 |
1 |
|
32 |
/InventoryStatus/ItemInventory/ClientId |
The identifier provided by Radial Inc for an individual or organization that has a contractual relationship with Radial Inc in which Radial Inc is providing e-commerce, fulfillment or other services for the individual or organization. This is obsolete in newer releases and should not be used for any partner getting launched after 11.2 release.
Allowable Values: Text string
Required: No
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
gsi_client_id |
String |
Yes |
0 |
1 |
1 |
|
32 |
/InventoryStatus/ItemInventory/gsi_client_id |
The identifier provided by Radial Inc for an individual or organization that has a contractual relationship with Radial Inc in which Radial Inc 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 |
| |
|
FacilityId |
String |
Yes |
0 |
1 |
1 |
|
32 |
/InventoryStatus/ItemInventory/FacilityId |
Unique identifier provided by Radial Inc that designates the facility housing the goods. Typically a distribution center of physical warehouse.
Allowable Values: Text string
Required: Yes
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
ExternalFacilityId |
String |
No |
0 |
0 |
1 |
|
32 |
/InventoryStatus/ItemInventory/ExternalFacilityId |
The unique identifier that maps to what an external client/facility uses to identify their facility. This is for information purpose only.
Allowable Values: Text string
Required: No
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
InventoryStatusType |
String |
Yes |
0 |
1 |
1 |
|
10 |
/InventoryStatus/ItemInventory/InventoryStatusType |
Identifies whether this is a Full snapshot or a Delta. Delta could be Incremental or Replacement. Full SnapShot is always a complete replacement.
Allowable Values:
FS - full snapshot - Changes/overrides the inventory count in OMS. Zeros out items which were not sent in the feed. This feed applies to the entire catalog. This can include offline sales that need to be accounted for in inventory. This is typically done once a day or less often to clean up the incremental/replacement counts and roll them into the larger inventory. Typically used in conjunction with the incremental rather than the replacement feed.
INC - incremental adjustment - Increases / decreases the inventory count for just the items in the feed. For example, if a store has in-store pickup, using this feed to send changes allows faster, more frequent intra-day inventory counts for items that are selling. Or if two TV’s are broken, the store can quickly send a -2. This feed can be sent multiple times per day.
REP - replacement - Changes/overrides the inventory count for just the items in the feed. Similar to the incremental feed, but replaces, rather than increments/decrements the inventory count. So if, for example, all but three TVs are damaged and not sellable, the replacement count would be 3. This feed is not used frequently. It could be used to apply an emergency patch.
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
InventoryDateTime |
|
Yes |
0 |
1 |
1 |
|
|
/InventoryStatus/ItemInventory/InventoryDateTime |
The date and time of the inventory snapshot.
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 |
| |
|
SequenceNumber |
|
No |
0 |
0 |
1 |
|
|
/InventoryStatus/ItemInventory/SequenceNumber |
An optional value VendorNet will look for to determine if this is the next file it should process. This is applicable only for Store Fulfillment Multinode inventory |
| |
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/InventoryStatus/ItemInventory/ExtendedAttributes |
Encapsulates the customizable section of the message which allows for additional details to be added. |
| |
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/InventoryStatus/ItemInventory/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 |
/InventoryStatus/ItemInventory/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 |
/InventoryStatus/ItemInventory/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 |
| |
|
Item |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/InventoryStatus/ItemInventory/Item |
Allows for multiple items sent within same xml message for a given FacilityId and gsi_client_id. for multiple facilities the message needs to be sent seperately. The Item tag should only repeat when sending inventory update for more than one item. ItemInventory tag level data are very static for a given xml message. for e.g. any inventory xml message can only contain single InventoryStatusType for a given facility |
| |
|
|
SellableQuantity |
|
Yes |
0 |
1 |
1 |
|
|
/InventoryStatus/ItemInventory/Item/SellableQuantity |
Total number of the items in the warehouse which could be sold - whether it is allocated against an order or not. Radial Inc will then subtract allocated items in the OMS in determining how many are available for sale. Radial Inc requires items that are allocated to other OMS's to not be included in this number.
Allowable Values: Integer
Required: Yes
Length: 7
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ItemId |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/InventoryStatus/ItemInventory/Item/ItemId |
Encapsulates the set of verious references that can be used to identify an item/SKU. |
| |
|
|
|
GsiCatalogId |
String |
No |
0 |
0 |
1 |
|
4 |
/InventoryStatus/ItemInventory/Item/ItemId/GsiCatalogId |
Radial Inc assigned unique V11 catalog id for each client (gsi_client_id).
Allowable Values: Text string
Required: This is required if ClientItemId is used as an unique id to send the inventory against(gsi_client_id)
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
ClientItemId |
String |
Yes |
0 |
1 |
1 |
|
35 |
/InventoryStatus/ItemInventory/Item/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: Yes
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
OMSItemId |
|
No |
0 |
0 |
1 |
|
|
/InventoryStatus/ItemInventory/Item/ItemId/OMSItemId |
The Radial Inc Internally assigned unique identifier, AKA JDA SKU or Radial SKU or OMS SKU or GII or Radial Inc 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 |
| |
|
|
|
ClientAltItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/InventoryStatus/ItemInventory/Item/ItemId/ClientAltItemId |
An alternative item identifier provided by the client.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
ItemAttributes |
AnyType |
No |
0 |
0 |
1 |
|
|
/InventoryStatus/ItemInventory/Item/ItemAttributes |
Additional information at item level. Specially needed in case of future inventory model. |
| |
|
|
|
LotId |
String |
No |
0 |
0 |
1 |
|
20 |
/InventoryStatus/ItemInventory/Item/ItemAttributes/LotId |
An identifier for a batch or group of items. The identification of this grouping normally comes from the manufacturer and normally applies to items that are dependent on matching of colors or detailed tracking requirements.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
ArrivalDate |
|
No |
0 |
0 |
1 |
|
|
/InventoryStatus/ItemInventory/Item/ItemAttributes/ArrivalDate |
The item’s receipt date or ETA within the WMS.
Allowable Values: ISO 8601 standard in xsd:date data format which is yyyy-mm-dd for e.g. 2012-01-11.
Required: No
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
StockLocationNumber |
String |
No |
0 |
0 |
1 |
|
30 |
/InventoryStatus/ItemInventory/Item/ItemAttributes/StockLocationNumber |
The location of the item within the physical facility. AKA SLN.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
StockingUOM |
String |
No |
0 |
0 |
1 |
|
4 |
/InventoryStatus/ItemInventory/Item/ItemAttributes/StockingUOM |
The unit of measure for the storage of the item, for example, "EACH."
Allowable Values: Text string
Required: No
Length: 4
Default Value: EACH
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
AdjustmentType |
String |
No |
0 |
0 |
1 |
|
15 |
/InventoryStatus/ItemInventory/Item/ItemAttributes/AdjustmentType |
This represents the type of the adjustment done in case of Delta Inventory Feeds when InventoryStatusType = INC.
Allowable Values: ADJUSTMENT, RECEIPT
Required: No.
Length: 15
Default Value: ADJUSTMENT
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
SupplyType |
String |
No |
0 |
0 |
1 |
|
32 |
/InventoryStatus/ItemInventory/Item/ItemAttributes/SupplyType |
This represents if the Inventory is On Hand or Future. Any value other than "ONHAND" represents the future Inventory.
Allowable Values: ONHAND, PO, PO_PLACED, PO_RELEASED, INTRANSIT are some of the allowable values
Required: No
Length: 32
Default Value: ONHAND
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
SupplyReferenceType |
String |
No |
0 |
0 |
1 |
|
40 |
/InventoryStatus/ItemInventory/Item/ItemAttributes/SupplyReferenceType |
The reference type for the given supply type, only applicable in case of future inventory. For example. PO, ASN etc.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
SupplyReference |
String |
No |
0 |
0 |
1 |
|
100 |
/InventoryStatus/ItemInventory/Item/ItemAttributes/SupplyReference |
The value for the given SupplyReferenceType, only applicable in case of future inventory. For e.g. P123 [ a PO Number] , A230 [ an ASN Number] |
| |
|
|
|
SupplyLineReference |
String |
No |
0 |
0 |
1 |
|
24 |
/InventoryStatus/ItemInventory/Item/ItemAttributes/SupplyLineReference |
This indicates the line number for the given SupplyReference for which this inventory update is sent, only applicable in case of future inventory. For e.g. 002 [ the Line Number on a PO].
Allowable Values: Text string
Required: No
Length: 24
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
OriginalArrivalDate |
|
No |
0 |
0 |
1 |
|
|
/InventoryStatus/ItemInventory/Item/ItemAttributes/OriginalArrivalDate |
Encapsulates the original ETA or arrival date. This is only used when receipt is done against the future inventory.
Allowable Values: ISO 8601 standard in xsd:date data format which is yyyy-mm-dd for e.g. 2012-01-11.
Required: No
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
Store |
String |
No |
0 |
0 |
1 |
|
10 |
/InventoryStatus/ItemInventory/Item/Store |
This is an optional field - Store Number that will be used only for Store Fulfillment Multinode inventory |
| |
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/InventoryStatus/ItemInventory/Item/ExtendedAttributes |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/InventoryStatus/ItemInventory/Item/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 |
/InventoryStatus/ItemInventory/Item/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 |
/InventoryStatus/ItemInventory/Item/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 |