Get Inventory Details

The Get Inventory Details operation:

• Gather details about each line item in a cart.
• Provides available inventory based on sourcing rules.

This information is used as input to subsequent Radial Order Management API operation calls.

The Get Inventory Details operation returns the following information for each line item:

• Ship-from address - Used in the Tax and Duties Quote request
• Estimated delivery date - Used in the Create Order request
• Available inventory - Calculated using the ship-to address and based on the seller's sourcing rules

Each line item must have a ship-to address and shipping method for shipped items or must have store location information for in-store items.

For items that are not available for sale when a Get Inventory Details operation is executed, no ship-from address or estimated delivery date is available. These items are represented in an unavailable items section in the response message.

This operation is called each time the ship-to address, shipping method, or requested quantity for an item changes.

For a step-by-step guide to this API, see How to Build an Inventory Details API Request.

URI Summary

URI domain name: Radial recommends using the new domain at apg.radial.com. To connect to production Radial APIs, use the following form of the URL:

https://apg.radial.com/v1.0/proxyname/storecode/function

You should have received the applicable information for proxyname, storecode, and function from your Radial representative.

Note: The old domain will still be in operation until further notice from Radial. For more information on Radial API URIs, see API Requests and Responses.

Schemas

• Inventory-Datatypes-1.0.xsd
• Inventory-Service-InventoryDetails-1.0.xsd

Business Rule - Prevent Use of 'null'

When preparing request messages, prevent the literal string null from being sent in place of missing data. Although null strings might pass XSD validation, they cause various failures in downstream systems.

<?xml version="1.0" encoding="UTF-8"?>
<InventoryDetailsRequestMessage . . .>
   <OrderItem itemId=". . ." lineId="1">
      <Quantity>. . .</Quantity>
      <ShipmentDetails>
         <ShippingMethod>. . .</ShippingMethod>
         <ShipToAddress>
            <Line1>null</Line1>
            <City>null</City>
            <MainDivision>null</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>null</PostalCode>
         </ShipToAddress>
      </ShipmentDetails>
   </OrderItem>
</InventoryDetailsRequestMessage>

Examples

One standard ship item

InventoryDetailsRequestMessage receives InventoryDetailsResponseMessage.

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<InventoryDetailsRequestMessage xmlns="http://schema.gspt.net/Inventory/3.0">
  <SourceId type="CHANNEL">TMSUS</SourceId>
  <Items>
    <OrderItem>
      <ItemId>GSI-TEST-001</ItemId>
      <Quantity>5</Quantity>
      <WebstoreLineId>line1</WebstoreLineId>
      <ShipmentDetails>
        <ShippingMethod>USPSStandard</ShippingMethod>
        <ShipToAddress>
          . . .
        </ShipToAddress>
      </ShipmentDetails>
    </OrderItem>
  </Items>
</InventoryDetailsRequestMessage>

Response XML

<?xml version="1.0" encoding="UTF-8"?>
<InventoryDetailsResponseMessage xmlns="http://schema.gspt.net/Inventory/3.0">
  <InventoryDetails>
    <InventoryDetail>
      <ItemId>item1</ItemId>
      . . .
    </InventoryDetail>
  </InventoryDetails>
 </InventoryDetailsResponseMessage>            

One ISPU item

InventoryDetailsRequestMessage receives InventoryDetailsResponseMessage.

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<InventoryDetailsRequestMessage xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderItem lineId="1" itemId="TEST-1234">
    <Quantity>5</Quantity>
    <InStorePickupDetails>
      <StoreFrontId>12345</StoreFrontId>
      <StoreFrontName>Gaffer's Tater Tots</StoreFrontName>
      <StoreFrontAddress>
        <Line1>One Bagshot Row</Line1>
        <City>Bag End</City>
        <MainDivision>PA</MainDivision>
        <CountryCode>US</CountryCode>
        <PostalCode>19123</PostalCode>
      </StoreFrontAddress>
    </InStorePickupDetails>
  </OrderItem>
</InventoryDetailsRequestMessage>

One standard item and one ISPU item

InventoryDetailsRequestMessage receives InventoryDetailsResponseMessage.

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<InventoryDetailsRequestMessage xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderItem lineId="1" itemId="item1">
    <Quantity>5</Quantity>
    <ShipmentDetails>
      <ShippingMethod>STANDARD</ShippingMethod>
      <ShipToAddress>
        <Line1>One Bagshot Row</Line1>
        <City>Bag End</City>
        <MainDivision>PA</MainDivision>
        <CountryCode>US</CountryCode>
        <PostalCode>19123</PostalCode>
      </ShipToAddress>
    </ShipmentDetails>
  </OrderItem>
  <OrderItem lineId="2" itemId="item2">
    <Quantity>5</Quantity>
    <InStorePickupDetails>
      <StoreFrontId>store1</StoreFrontId>
      <StoreFrontName>Gaffer's Tater Tots</StoreFrontName>
      <StoreFrontAddress>
        <Line1>Ten Bagshot Row</Line1>
        <City>Bag End</City>
        <MainDivision>PA</MainDivision>
        <CountryCode>US</CountryCode>
        <PostalCode>19123</PostalCode>
      </StoreFrontAddress>
    </InStorePickupDetails>
  </OrderItem>
</InventoryDetailsRequestMessage>