Get Inventory by Id

GET 
/inventory/id/:id

This endpoint is used to get an inventory data via it's unique inventory record Id.

Request

Path Parameters

id stringrequired

Inventory record Id

Responses

200

Get Inventory by Id - 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

companyId number

costPrice number

dateModified string

id number

location string

nextDeliveryDate string

notes string

productId number

quantity number

sku string

supplier string

supplierCode string

usergroupId number

warehouseId number
messages undefined[]
total number

Example (from schema)

{
  "data": {
    "companyId": 0,
    "costPrice": 0,
    "dateModified": "2022-02-21T12:52:38",
    "id": 16141,
    "location": "",
    "nextDeliveryDate": "2021-02-25T00:00:00",
    "notes": "",
    "productId": 37232,
    "quantity": 15,
    "sku": "757540",
    "supplier": "QUANTORE",
    "supplierCode": "757540",
    "usergroupId": 143,
    "warehouseId": 4
  },
  "messages": [],
  "total": 1
}

Get Inventory by Id - 200

{
  "data": {
    "companyId": 0,
    "costPrice": 0,
    "dateModified": "2022-02-21T12:52:38",
    "id": 16141,
    "location": "",
    "nextDeliveryDate": "2021-02-25T00:00:00",
    "notes": "",
    "productId": 37232,
    "quantity": 15,
    "sku": "757540",
    "supplier": "QUANTORE",
    "supplierCode": "757540",
    "usergroupId": 143,
    "warehouseId": 4
  },
  "messages": [],
  "total": 1
}

404

Get Inventory by Id - 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": 13006,
    "messages": [
      "Inventory with id [58991] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/13006",
    "status": 404,
    "type": "InventoryNotFound"
  }
}

Get Inventory by Id - 404

{
  "error": {
    "code": 13006,
    "messages": [
      "Inventory with id [58991] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/13006",
    "status": 404,
    "type": "InventoryNotFound"
  }
}

Loading...