REL documentation
inventory stocksummaries (http://api.3plcentral.com/rels/inventory/stocksummaries)
Resource:
item availability
C# Rel Const:
Rels.InventorySvc.StockSummaries
URI template:
stocksummaries{?pgsiz,pgnum,rql,orderednotallocated}
Obtain URI from:
Billboard
To get available inventory quantities)
Success status: 200
Name Data Type Description
pgsiz int must be positive; limit 500, specifying more is an error; default 100; max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string see RQL documentation
orderednotallocated bool If true, the response will include the quantity ordered but not allocated. Default value is false.
Type Description
TotalResults int
Summaries IEnumerable<Inventory.Models.StockSummary>
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
TotalReceived decimal
Allocated decimal including what has already been shipped
Available decimal
OnHold decimal
OnHand decimal
OrderedNotAllocated decimal? ... OrderedNotAllocated is null unless orderednotallocated = true in the stocksummaries request
FacilityId int
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "summaries": [
    {
      "itemIdentifier": {
        "sku": "str",
        "id": 2
      },
      "qualifier": "str",
      "totalReceived": 2.0,
      "allocated": 3.0,
      "available": 4.0,
      "onHold": 5.0,
      "onHand": 6.0,
      "orderedNotAllocated": 1.0,
      "facilityId": 7
    }
  ]
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.