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

GET

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

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

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Query Parameters

From

string format: date-time

To

string format: date-time

Responses

200

OK

object

facilityId

required

string format: uuid

from

required

string format: date-time

to

required

string format: date-time

receipts

required

object

transactions

required

integer format: int32

units

required

integer format: int64

adjustments

required

object

transactions

required

integer format: int32

unitsIn

required

integer format: int64

unitsOut

required

integer format: int64

byReason

required

Array<object>

object

reason

required

string

Allowed values: Shrinkage Damage Discovered Found Correction CycleCount

transactions

required

integer format: int32

unitsIn

required

integer format: int64

unitsOut

required

integer format: int64

object

facilityId

required

string format: uuid

from

required

string format: date-time

to

required

string format: date-time

receipts

required

object

transactions

required

integer format: int32

units

required

integer format: int64

adjustments

required

object

transactions

required

integer format: int32

unitsIn

required

integer format: int64

unitsOut

required

integer format: int64

byReason

required

Array<object>

object

reason

required

string

Allowed values: Shrinkage Damage Discovered Found Correction CycleCount

transactions

required

integer format: int32

unitsIn

required

integer format: int64

unitsOut

required

integer format: int64

Example

{
  "adjustments": {
    "byReason": [
      {
        "reason": "Shrinkage"
      }
    ]
  }
}

object

facilityId

required

string format: uuid

from

required

string format: date-time

to

required

string format: date-time

receipts

required

object

transactions

required

integer format: int32

units

required

integer format: int64

adjustments

required

object

transactions

required

integer format: int32

unitsIn

required

integer format: int64

unitsOut

required

integer format: int64

byReason

required

Array<object>

object

reason

required

string

Allowed values: Shrinkage Damage Discovered Found Correction CycleCount

transactions

required

integer format: int32

unitsIn

required

integer format: int64

unitsOut

required

integer format: int64

Example

{
  "adjustments": {
    "byReason": [
      {
        "reason": "Shrinkage"
      }
    ]
  }
}

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"
}