Logistics API: Inventory

Logistics API: Inventory

Resource

https://api.warehousefs.com/public/v1/inventory

The inventory resource represents a "collection" of all of the current inventories recorded in the Shipvine Logistics system. Merchants can extract information about their stock levels by sending GET requests to this resource.

GET

Request

Query Parameters

The method supports the following query parameters:

Parameter Required? Description
merchant-code Yes The unique merchant code assigned to the merchant's account.
changed-since No

A date and time, in universal coordinated time (UTC). If specified, only inventory records that have been created at Shipvine Logistics since the specified date and time will be returned in the response. If not specified, the first few thousand current inventory records associated with the merchant's account will be returned.

The date and time should be in a format that is readily parsable. The canonical date and time format is ISO 8601 format. For example, 1994-11-05T13:15:30Z.

For most integrations, the typical behavior is to leave out the changed-since parameter on the first request of the installation, and then send the parameter on each subsequent request. Doing this keeps transfer times between the Shipvine Logistics API and the merchant's e-commerce server low by only sending the inventory records that have been created since the last request.

Example Request Query String

https://api.warehousefs.com/public/v1/inventory?merchant-code=CONTOSO

Example Request Query String

https://api.warehousefs.com/public/v1/inventory?merchant-code=CONTOSO&changed-since=2009-10-15T16:45:00Z

Entity Body

No entity body may be specified in the request.

Response

If successful, the API will return 200 OK as well as a <Inventories /> element in the entity body. See the XML schema for details about that element.

If any error occurs, the HTTP status code will not be 200 OK . An <Errors /> element may be present in the entity body.

Example Response Entity Body 

<?xml version="1.0" encoding="utf-8"?>
<Inventories xmlns="urn:WarehouseFS-1.0">
  <Inventory>
    <Item>
      <MerchantIdentifier>6146825-River Plaid-Medium</MerchantIdentifier> <-- (1) -->
    </Item>
    <Quantities>
      <QuantityOnHand>2</QuantityOnHand> <-- (2) -->
      <QuantityReserved>0</QuantityReserved> <-- (3) -->
    </Quantities>
  </Inventory>
  <Inventory>
    <Item>
      <MerchantIdentifier>6162318-Franklin Stripe-Medium</MerchantIdentifier>
    </Item>
    <Quantities>
      <QuantityOnHand>1</QuantityOnHand>
      <QuantityReserved>0</QuantityReserved>
    </Quantities>
  </Inventory>
</Inventories>
  1. When synchronizing inventory, the <MerchantIdentifier /> element tells the merchant what corresponding item to update in its e-commerce system.
  2. The <QuantityOnHand /> element contains the quantity physically in Shipvine Logistics' possession.
  3. The <QuantityReserved /> element contains the quantity that is currently reserved for fulfillment requests, candidate requests, or stock reservations. This quantity is likely to be deducted from the quantity on hand soon unless the merchant cancels the corresponding requests. To that end, many merchants use the difference of these two quantity fields when telling customers how many units they have available in stock. However, if the merchant's e-commerce system can allocate inventory locally, a merchant may choose to ignore the <QuantityReserved /> element.

    • Related Articles

    • How can I force a resync of inventory to my online store?

      Many Shipvine integrations such as Shopify or Amazon MWS support inventory sync, where Shipvine will push down its inventory numbers to your online store. To support frequent inventory updates and to prevent very long inventory sync times due to API ...

    • Logistics API: Fulfillment Requests

      Resource #1 https://api.warehousefs.com/public/v1/fulfillment-requests The fulfillment requests resource allows the merchant to search for the Shipvine identifier assigned to requests for a given merchant identifier. GET Request Query Parameters The ...

    • Logistics API: Inbound Shipments

      Resource #1 https://api.warehousefs.com/public/v1/inbound-shipments/{merchantCode} This version of the inbound shipments resource allows the merchant to query for a listing of inbound shipments that may have been recently completed. GET Request URL ...

    • Logistics API: Item Groups

      Resource https://api.warehousefs.com/public/v1/item-groups/{merchantCode}/{merchantIdentifier} The item groups resource allows the merchant to programmatically enter catalog information into the Shipvine Logistics system. In Shipvine's vocabulary, an ...

    • Logistics API: Items

      Resource https://api.warehousefs.com/public/v1/item-groups/{merchantCode}/{groupMerchantIdentifier}/items/{itemMerchantIdentifier} The items resource allows the merchant to programmatically enter catalog information into the Shipvine Logistics ...