/api/v1/facilities/{facilityId}/inventory/count-plans/{id}/generate

POST

/api/v1/facilities/{facilityId}/inventory/count-plans/{id}/generate

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

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

id

required

string format: uuid

Responses

200

OK

object

plan

required

object

id

required

string format: uuid

facilityId

required

string format: uuid

name

required

string

fromLocationCode

required

string

nullable

toLocationCode

required

string

nullable

frequencyDays

required

integer format: int32

status

required

string

Allowed values: Active Inactive PendingDelete

nextRunAt

required

string format: date-time

nullable

lastRunAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

opened

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

object

plan

required

object

id

required

string format: uuid

facilityId

required

string format: uuid

name

required

string

fromLocationCode

required

string

nullable

toLocationCode

required

string

nullable

frequencyDays

required

integer format: int32

status

required

string

Allowed values: Active Inactive PendingDelete

nextRunAt

required

string format: date-time

nullable

lastRunAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

opened

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

Example

{
  "plan": {
    "status": "Active"
  },
  "opened": [
    {
      "origin": "Planned",
      "status": "Open",
      "outcome": "Matched"
    }
  ]
}

object

plan

required

object

id

required

string format: uuid

facilityId

required

string format: uuid

name

required

string

fromLocationCode

required

string

nullable

toLocationCode

required

string

nullable

frequencyDays

required

integer format: int32

status

required

string

Allowed values: Active Inactive PendingDelete

nextRunAt

required

string format: date-time

nullable

lastRunAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

opened

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

Example

{
  "plan": {
    "status": "Active"
  },
  "opened": [
    {
      "origin": "Planned",
      "status": "Open",
      "outcome": "Matched"
    }
  ]
}

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

409

Conflict

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