/api/v1/facilities/{facilityId}/inventory/cycle-counts (GET)

GET

/api/v1/facilities/{facilityId}/inventory/cycle-counts

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

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Query Parameters

Status

string

Origin

string

LocationId

string format: uuid

PlanId

string format: uuid

Page

integer format: int32

PageSize

integer format: int32

Sort

string

Responses

200

OK

object

items

required

Array<object>

object

id

required

string format: uuid

facilityId

required

string format: uuid

number

required

string

locationId

required

string format: uuid

locationCode

required

string

origin

required

string

Allowed values: Planned Anomaly Manual

status

required

string

Allowed values: Open PendingReview Closed Cancelled

outcome

required

string

nullable

Allowed values: Matched Adjusted Recounted Cancelled

planId

required

string format: uuid

nullable

triggerTransactionId

required

string format: uuid

nullable

triggerNote

required

string

nullable

note

required

string

nullable

recountOfId

required

string format: uuid

nullable

countedBy

required

string

nullable

countedAt

required

string format: date-time

nullable

reviewedBy

required

string

nullable

reviewedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

object

items

required

Array<object>

object

id

required

string format: uuid

facilityId

required

string format: uuid

number

required

string

locationId

required

string format: uuid

locationCode

required

string

origin

required

string

Allowed values: Planned Anomaly Manual

status

required

string

Allowed values: Open PendingReview Closed Cancelled

outcome

required

string

nullable

Allowed values: Matched Adjusted Recounted Cancelled

planId

required

string format: uuid

nullable

triggerTransactionId

required

string format: uuid

nullable

triggerNote

required

string

nullable

note

required

string

nullable

recountOfId

required

string format: uuid

nullable

countedBy

required

string

nullable

countedAt

required

string format: date-time

nullable

reviewedBy

required

string

nullable

reviewedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "origin": "Planned",
      "status": "Open",
      "outcome": "Matched"
    }
  ]
}

object

items

required

Array<object>

object

id

required

string format: uuid

facilityId

required

string format: uuid

number

required

string

locationId

required

string format: uuid

locationCode

required

string

origin

required

string

Allowed values: Planned Anomaly Manual

status

required

string

Allowed values: Open PendingReview Closed Cancelled

outcome

required

string

nullable

Allowed values: Matched Adjusted Recounted Cancelled

planId

required

string format: uuid

nullable

triggerTransactionId

required

string format: uuid

nullable

triggerNote

required

string

nullable

note

required

string

nullable

recountOfId

required

string format: uuid

nullable

countedBy

required

string

nullable

countedAt

required

string format: date-time

nullable

reviewedBy

required

string

nullable

reviewedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "origin": "Planned",
      "status": "Open",
      "outcome": "Matched"
    }
  ]
}

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