GET inventory/{inventoryId}

Gets an inventory item.

Request Information

» Parameters

Name Description Additional information
inventoryId The ID of the inventory item.

Define this parameter in the request URI.

» Expands

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

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.

  "Inventory": {
    "InventoryId": 1,
    "QuantityOnHand": 1000,
    "ReorderLevel": 10,
    "Sku": "apg234",
    "Skus": [
        "Attributes": [],
        "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": null,
        "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
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false