Get Product Inventory By Warehouse

GET 
/products/:lookupkey/:key/inventory/warehouses/:warehouseId

This endpoint gives cumulative product inventory data by searching on a lookup key and warehouse id.

Request

Path Parameters

lookupkey stringrequired

Available lookup keys: id, sourceId, sku, supplierCode

key stringrequired

Lookup key value

warehouseId stringrequired

Warehouse id

Query Parameters

expands string

Expands cumulative inventory data with detailed records

Responses

200

Get Product Inventory By Warehouse - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

data

object[]

Array [

localQuantity number

localReservedQuantity number

nextDeliveryDate string

productId number

supplierQuantity number

supplierReservedQuantity number

totalQuantity number

totalReservedQuantity number

]

messages undefined[]
total number

Example (from schema)

{
  "data": [
    {
      "localQuantity": 16,
      "localReservedQuantity": 0,
      "nextDeliveryDate": "2022-02-15T00:00:00",
      "productId": 38952,
      "supplierQuantity": 3,
      "supplierReservedQuantity": 0,
      "totalQuantity": 19,
      "totalReservedQuantity": 0
    }
  ],
  "messages": [],
  "total": 1
}

Get Product Inventory By Warehouse - 200

{
  "data": [
    {
      "localQuantity": 16,
      "localReservedQuantity": 0,
      "nextDeliveryDate": "2022-02-15T00:00:00",
      "productId": 38952,
      "supplierQuantity": 3,
      "supplierReservedQuantity": 0,
      "totalQuantity": 19,
      "totalReservedQuantity": 0
    }
  ],
  "messages": [],
  "total": 1
}

404

Get Product Inventory By Warehouse - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 80006,
    "messages": [
      "Product with id [59328] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/80006",
    "status": 404,
    "type": "ProductNotFound"
  }
}

Get Product Inventory By Warehouse - 404

{
  "error": {
    "code": 80006,
    "messages": [
      "Product with id [59328] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/80006",
    "status": 404,
    "type": "ProductNotFound"
  }
}

Loading...