Build Version:

GET inventory

Gets a list of inventory items.

Request Information

» Expands

Name	Description	Usage
skus	This will retrieve the related list of SKUs.	GET inventory?expand=skus

» Filters

Name	Description	Usage
quantityOnHand	This will filter the request by quantity on hand.	GET inventory?filter=quantityonhand~{operator}~{value}
sku	This will filter the request by SKU.	GET inventory?filter=sku~{operator}~{value}

» Sorting

Name	Description	Usage
quantityOnHand	This will sort the response by quantity on hand.	GET inventory?sort=quantityonhand
sku	This will sort the response by SKU.	GET inventory?sort=sku

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET inventory?page=index~{value}
size	The size of the page when retrieving paged results.	GET inventory?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

application/json

Sample:

	{
  "Inventories": [
    {
      "InventoryId": 1,
      "QuantityOnHand": 1000.0,
      "ReorderLevel": 10.0,
      "Sku": "apg234",
      "Skus": [
        {
          "Attributes": [],
          "CustomerPricingSku": [],
          "Custom1": "",
          "Custom2": "",
          "Custom3": "",
          "DisplayOrder": null,
          "ExternalId": "",
          "FinalPrice": null,
          "ImageAltTag": "Green Apple",
          "ImageFile": "apple-green.jpg",
          "ImageLargePath": "~/data/default/images/catalog/450/apple-green.jpg",
          "ImageMediumPath": "~/data/default/images/catalog/250/apple-green.jpg",
          "ImageSmallPath": "~/data/default/images/catalog/100/apple-green.jpg",
          "ImageSmallThumbnailPath": "~/data/default/images/catalog/37/apple-green.jpg",
          "ImageThumbnailPath": "~/data/default/images/catalog/50/apple-green.jpg",
          "Inventory": {
            "InventoryId": 0,
            "QuantityOnHand": null,
            "ReorderLevel": null,
            "Sku": null,
            "Skus": []
          },
          "IsActive": true,
          "Note": "",
          "ProductId": 302,
          "ProductPrice": null,
          "PromotionPrice": 1.23,
          "RecurringBillingFrequency": "1",
          "RecurringBillingInitialAmount": 0.00,
          "RecurringBillingPeriod": "",
          "RecurringBillingTotalCycles": 1,
          "RetailPriceOverride": null,
          "SalePriceOverride": 2.99,
          "Sku": "apg234",
          "SkuId": 2,
          "Supplier": null,
          "SupplierId": 1,
          "UpdateDate": "2013-12-06T02:04:16.85",
          "WebServiceDownloadDate": null,
          "WeightAdditional": 0.70,
          "WholesalePriceOverride": null,
          "AttributesIds": null,
          "Error": null,
          "UserType": null,
          "UserName": null
        }
      ]
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}