/api/v1/facilities/{facilityId}/inventory/lookup

GET

const url = 'https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/inventory/lookup';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/inventory/lookup \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Query Parameters

Code

string

Responses

200

object

code

required

string

kind

required

string

Allowed values: Lpn Location Barcode Sku

lpn

required

object

required

string format: uuid

facilityId

required

string format: uuid

code

required

string

type

required

string

Allowed values: Pallet Case Tote

parentLpnId

required

string format: uuid

nullable

parentLpnCode

required

string

nullable

locationId

required

string format: uuid

locationCode

required

string

childCount

required

integer format: int32

empty

required

boolean

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

children

required

Array<object>

object

required

string format: uuid

facilityId

required

string format: uuid

code

required

string

type

required

string

Allowed values: Pallet Case Tote

parentLpnId

required

string format: uuid

nullable

parentLpnCode

required

string

nullable

locationId

required

string format: uuid

locationCode

required

string

childCount

required

integer format: int32

empty

required

boolean

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

location

required

object

required

string format: uuid

code

required

string

ownerKind

required

string

Allowed values: Storage Equipment

status

required

string

Allowed values: Active Inactive PendingDelete

blocked

required

boolean

blockedReasons

required

Array<string>

Allowed values: ProductInactive ProductDeleted ProductUnknown LocationInactive LocationDeleted LocationUnknown FacilityInactive FacilityDeleted FacilityUnknown

product

required

object

required

string format: uuid

sku

required

string

name

required

string

status

required

string

Allowed values: Active Inactive PendingDelete

trackLots

required

boolean

trackSerials

required

boolean

trackExpiry

required

boolean

unitOfMeasureCode

required

string

nullable

baseUnitQuantity

required

integer format: int32

nullable

contents

required

object

positionCount

required

integer format: int32

truncated

required

boolean

positions

required

Array<object>

object

required

string format: uuid

facilityId

required

string format: uuid

locationId

required

string format: uuid

locationCode

required

string

lpnId

required

string format: uuid

nullable

lpnCode

required

string

nullable

productId

required

string format: uuid

sku

required

string

productName

required

string

lotNumber

required

string

nullable

serial

required

string

nullable

expiryDate

required

string format: date

nullable

receivedOn

required

string format: date

stockStatus

required

string

Allowed values: Available Quarantine Damaged

quantity

required

integer format: int32

allocatedQuantity

required

integer format: int32

availableQuantity

required

integer format: int32

blocked

required

boolean

blockedReasons

required

Array<string>

Allowed values: ProductInactive ProductDeleted ProductUnknown LocationInactive LocationDeleted LocationUnknown FacilityInactive FacilityDeleted FacilityUnknown

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

object

code

required

string

kind

required

string

Allowed values: Lpn Location Barcode Sku

lpn

required

object

required

string format: uuid

facilityId

required

string format: uuid

code

required

string

type

required

string

Allowed values: Pallet Case Tote

parentLpnId

required

string format: uuid

nullable

parentLpnCode

required

string

nullable

locationId

required

string format: uuid

locationCode

required

string

childCount

required

integer format: int32

empty

required

boolean

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

children

required

Array<object>

object

required

string format: uuid

facilityId

required

string format: uuid

code

required

string

type

required

string

Allowed values: Pallet Case Tote

parentLpnId

required

string format: uuid

nullable

parentLpnCode

required

string

nullable

locationId

required

string format: uuid

locationCode

required

string

childCount

required

integer format: int32

empty

required

boolean

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

location

required

object

required

string format: uuid

code

required

string

ownerKind

required

string

Allowed values: Storage Equipment

status

required

string

Allowed values: Active Inactive PendingDelete

blocked

required

boolean

blockedReasons

required

Array<string>

Allowed values: ProductInactive ProductDeleted ProductUnknown LocationInactive LocationDeleted LocationUnknown FacilityInactive FacilityDeleted FacilityUnknown

product

required

object

required

string format: uuid

sku

required

string

name

required

string

status

required

string

Allowed values: Active Inactive PendingDelete

trackLots

required

boolean

trackSerials

required

boolean

trackExpiry

required

boolean

unitOfMeasureCode

required

string

nullable

baseUnitQuantity

required

integer format: int32

nullable

contents

required

object

positionCount

required

integer format: int32

truncated

required

boolean

positions

required

Array<object>

object

required

string format: uuid

facilityId

required

string format: uuid

locationId

required

string format: uuid

locationCode

required

string

lpnId

required

string format: uuid

nullable

lpnCode

required

string

nullable

productId

required

string format: uuid

sku

required

string

productName

required

string

lotNumber

required

string

nullable

serial

required

string

nullable

expiryDate

required

string format: date

nullable

receivedOn

required

string format: date

stockStatus

required

string

Allowed values: Available Quarantine Damaged

quantity

required

integer format: int32

allocatedQuantity

required

integer format: int32

availableQuantity

required

integer format: int32

blocked

required

boolean

blockedReasons

required

Array<string>

Allowed values: ProductInactive ProductDeleted ProductUnknown LocationInactive LocationDeleted LocationUnknown FacilityInactive FacilityDeleted FacilityUnknown

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "kind": "Lpn",
  "lpn": {
    "type": "Pallet"
  },
  "children": [
    {
      "type": "Pallet"
    }
  ],
  "location": {
    "ownerKind": "Storage",
    "status": "Active",
    "blockedReasons": [
      "ProductInactive"
    ]
  },
  "product": {
    "status": "Active"
  },
  "contents": {
    "positions": [
      {
        "stockStatus": "Available",
        "blockedReasons": [
          "ProductInactive"
        ]
      }
    ]
  }
}

object

code

required

string

kind

required

string

Allowed values: Lpn Location Barcode Sku

lpn

required

object

required

string format: uuid

facilityId

required

string format: uuid

code

required

string

type

required

string

Allowed values: Pallet Case Tote

parentLpnId

required

string format: uuid

nullable

parentLpnCode

required

string

nullable

locationId

required

string format: uuid

locationCode

required

string

childCount

required

integer format: int32

empty

required

boolean

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

children

required

Array<object>

object

required

string format: uuid

facilityId

required

string format: uuid

code

required

string

type

required

string

Allowed values: Pallet Case Tote

parentLpnId

required

string format: uuid

nullable

parentLpnCode

required

string

nullable

locationId

required

string format: uuid

locationCode

required

string

childCount

required

integer format: int32

empty

required

boolean

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

location

required

object

required

string format: uuid

code

required

string

ownerKind

required

string

Allowed values: Storage Equipment

status

required

string

Allowed values: Active Inactive PendingDelete

blocked

required

boolean

blockedReasons

required

Array<string>

Allowed values: ProductInactive ProductDeleted ProductUnknown LocationInactive LocationDeleted LocationUnknown FacilityInactive FacilityDeleted FacilityUnknown

product

required

object

required

string format: uuid

sku

required

string

name

required

string

status

required

string

Allowed values: Active Inactive PendingDelete

trackLots

required

boolean

trackSerials

required

boolean

trackExpiry

required

boolean

unitOfMeasureCode

required

string

nullable

baseUnitQuantity

required

integer format: int32

nullable

contents

required

object

positionCount

required

integer format: int32

truncated

required

boolean

positions

required

Array<object>

object

required

string format: uuid

facilityId

required

string format: uuid

locationId

required

string format: uuid

locationCode

required

string

lpnId

required

string format: uuid

nullable

lpnCode

required

string

nullable

productId

required

string format: uuid

sku

required

string

productName

required

string

lotNumber

required

string

nullable

serial

required

string

nullable

expiryDate

required

string format: date

nullable

receivedOn

required

string format: date

stockStatus

required

string

Allowed values: Available Quarantine Damaged

quantity

required

integer format: int32

allocatedQuantity

required

integer format: int32

availableQuantity

required

integer format: int32

blocked

required

boolean

blockedReasons

required

Array<string>

Allowed values: ProductInactive ProductDeleted ProductUnknown LocationInactive LocationDeleted LocationUnknown FacilityInactive FacilityDeleted FacilityUnknown

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "kind": "Lpn",
  "lpn": {
    "type": "Pallet"
  },
  "children": [
    {
      "type": "Pallet"
    }
  ],
  "location": {
    "ownerKind": "Storage",
    "status": "Active",
    "blockedReasons": [
      "ProductInactive"
    ]
  },
  "product": {
    "status": "Active"
  },
  "contents": {
    "positions": [
      {
        "stockStatus": "Available",
        "blockedReasons": [
          "ProductInactive"
        ]
      }
    ]
  }
}

400

Bad Request

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

/api/v1/facilities/{facilityId}/inventory/lookup

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

Example

400

Example generated

Example generated

404

Example generated

Example generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated