/api/v1/facilities/{facilityId}/inventory/stock-summary

GET

/api/v1/facilities/{facilityId}/inventory/stock-summary

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

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Query Parameters

ProductId

string format: uuid

Search

string

Page

integer format: int32

PageSize

integer format: int32

Sort

string

Responses

200

OK

object

items

required

Array<object>

object

productId

required

string format: uuid

sku

required

string

productName

required

string

onHand

required

integer format: int64

allocated

required

integer format: int64

available

required

integer format: int64

held

required

integer format: int64

blocked

required

integer format: int64

positionCount

required

integer format: int32

blockedReasons

required

Array<string>

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

quarantine

required

integer format: int64

damaged

required

integer format: int64

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

object

items

required

Array<object>

object

productId

required

string format: uuid

sku

required

string

productName

required

string

onHand

required

integer format: int64

allocated

required

integer format: int64

available

required

integer format: int64

held

required

integer format: int64

blocked

required

integer format: int64

positionCount

required

integer format: int32

blockedReasons

required

Array<string>

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

quarantine

required

integer format: int64

damaged

required

integer format: int64

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "blockedReasons": [
        "ProductInactive"
      ]
    }
  ]
}

object

items

required

Array<object>

object

productId

required

string format: uuid

sku

required

string

productName

required

string

onHand

required

integer format: int64

allocated

required

integer format: int64

available

required

integer format: int64

held

required

integer format: int64

blocked

required

integer format: int64

positionCount

required

integer format: int32

blockedReasons

required

Array<string>

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

quarantine

required

integer format: int64

damaged

required

integer format: int64

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "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"
}