List of Item Inventories

v1.0.0

Retrieve inventory for one or more items. This API requires elevated permissions, please speak to your success manager.

Input

{
  "type": "object",
  "properties": {
    "externalSkuNames": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "limit": {
      "type": "integer"
    },
    "merchantIds": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "page": {
      "type": "integer"
    },
    "warehouseIds": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "description": "Item this inventory data is based on",
            "properties": {
              "id": {
                "type": "integer",
                "description": "FDC ID for this Item"
              },
              "skuReference": {
                "type": "string",
                "description": "Sku reference name for this item"
              }
            }
          },
          "merchant": {
            "type": "object",
            "description": "Merchant that owns this item",
            "properties": {
              "name": {
                "type": "string",
                "description": "Merchants name for this item"
              }
            }
          },
          "quantity": {
            "type": "object",
            "properties": {
              "total": {
                "type": "object",
                "properties": {
                  "availableToPromise": {
                    "type": "integer",
                    "description": "Number of items that are available to be used in an order"
                  }
                }
              }
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "count": {
              "type": "integer",
              "description": "Count of records returned in response, this will be equal to or less then the limit parameter"
            },
            "currentPage": {
              "type": "integer",
              "description": "Current page of the response, this will match the page parameter"
            },
            "total": {
              "type": "integer",
              "description": "Total number of records available to request"
            },
            "totalPages": {
              "type": "integer",
              "description": "Total number of pages available to request"
            }
          }
        }
      }
    }
  }
}