Get Inventory Quantity

The Get Inventory Quantity operation is used to check available-to-sell (promise) inventory for one or more items. This operation is typically used to add to a cart, update a cart, and restore a persisted cart.

The default value is the fulfillment center quantity.

This operation should not be used to check inventory for items with unlimited inventory (for example, warranties, virtual gift cards, and online gift certificates). Quantities returned for these items might be zero, which can negatively impact the operation of the webstore.

URI Summary

Operation	Action	URI Template	URI Example	Transaction Type	Unique RequestID Needed for Duplicate Detection?	Non-URI Request / Payload	Response
Get quantity	POST	/vM.m/stores/STOREID/inventory/quantity/get.xml	/v1.0/stores/ABCD/inventory/quantity/get.xml	Get available-to-sell (promise) quantity for one or more line items.	No	XML	200 + XML response

Inventory

Examples

One or more standard ship items

QuantityRequestMessage receives QuantityResponseMessage.

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<QuantityRequestMessage xmlns="http://schema.gspt.net/Inventory/3.0">
   <SourceId type="CHANNEL">TMSUS</SourceId>
   <QuantityRequestList>
      <QuantityRequest id="line1">
         <ItemId>GSI-TEST-001</ItemId>
      </QuantityRequest>
   </QuantityRequestList>
</QuantityRequestMessage>

One store pickup item

QuantityRequestMessage receives QuantityResponseMessage

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<QuantityRequestMessage xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <QuantityRequest lineId="line1" itemId="TEST-1234">
      <FulfillmentLocationId type="ISPU">1234</FulfillmentLocationId>
   </QuantityRequest>
</QuantityRequestMessage>

One standard ship item and one store pickup item

QuantityRequestMessage receives QuantityResponseMessage.

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<QuantityRequestMessage xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <QuantityRequest lineId="line1" itemId="1-23456"/>
   <QuantityRequest lineId="line2" itemId="1-23456">
      <FulfillmentLocationId type="ISPU">store1</FulfillmentLocationId>
   </QuantityRequest>
</QuantityRequestMessage>

Response XML

<?xml version="1.0" encoding="UTF-8"?>
<QuantityResponseMessage xmlns="http://schema.gspt.net/Inventory/3.0">
   <QuantityResponseList>
      <QuantityResponse id="line1">
         <ItemId>item1</ItemId>
         <Quantity>0</Quantity>
      </QuantityResponse>
      <QuantityResponse id="line2">
         <ItemId> item2</ItemId>
         <FulfillmentLocationId type="ISPU">loc1</FulfillmentLocationId>
         <Quantity>0</Quantity>
      </QuantityResponse>
   </QuantityResponseList>
</QuantityResponseMessage>

Available-to-sell quantity at specified store locations

InStoreQuantityRequestMessage receives InStoreQuantityResponseMessage.

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<InStoreQuantityRequestMessage xmlns = "http://api.gsicommerce.com/schema/checkout/1.0" 
        itemId = "21-885641255428">
   <StoreFrontId>01-4152</StoreFrontId>
   <StoreFrontId>01-4126</StoreFrontId>
</InStoreQuantityRequestMessage>

Response XML

<?xml version="1.0" encoding="UTF-8"?>
<InStoreQuantityResponseMessage xmlns="http://api.gsicommerce.com/schema/checkout/1.0" 
          itemId="21-885641255428">
   <StoreFrontQuantity>
      <StoreFrontId>01-4152</StoreFrontId>
      <Quantity>999</Quantity>
   </StoreFrontQuantity>
   <StoreFrontQuantity>
      <StoreFrontId>01-4126</StoreFrontId>
      <Quantity>0</Quantity>
   </StoreFrontQuantity>
</InStoreQuantityResponseMessage>