/api/v1/facilities/{facilityId}/inventory/allocations (POST)

POST

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

curl --request POST \
  --url https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/inventory/allocations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quantity": 1, "unitOfMeasureCode": "example", "reference": "example", "lotNumber": "example", "allowPartial": true }'

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Request Body^required

object

productId

string format: uuid

nullable

quantity

integer format: int32

nullable

unitOfMeasureCode

string

nullable

reference

string

nullable

lotNumber

string

nullable

allowPartial

boolean

Example ^generated

{
  "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "quantity": 1,
  "unitOfMeasureCode": "example",
  "reference": "example",
  "lotNumber": "example",
  "allowPartial": true
}

object

productId

string format: uuid

nullable

quantity

integer format: int32

nullable

unitOfMeasureCode

string

nullable

reference

string

nullable

lotNumber

string

nullable

allowPartial

boolean

Example ^generated

{
  "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "quantity": 1,
  "unitOfMeasureCode": "example",
  "reference": "example",
  "lotNumber": "example",
  "allowPartial": true
}

object

productId

string format: uuid

nullable

quantity

integer format: int32

nullable

unitOfMeasureCode

string

nullable

reference

string

nullable

lotNumber

string

nullable

allowPartial

boolean

Example ^generated

{
  "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "quantity": 1,
  "unitOfMeasureCode": "example",
  "reference": "example",
  "lotNumber": "example",
  "allowPartial": true
}

Responses

201

Created

object

id

required

string format: uuid

facilityId

required

string format: uuid

productId

required

string format: uuid

sku

required

string

productName

required

string

reference

required

string

lotNumber

required

string

nullable

requestedQuantity

required

integer format: int32

allocatedQuantity

required

integer format: int32

pickedQuantity

required

integer format: int32

unpickedQuantity

required

integer format: int32

status

required

string

Allowed values: Open Picked Released Issued

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

lines

required

Array<object>

object

id

required

string format: uuid

lineNumber

required

integer format: int32

positionId

required

string format: uuid

quantity

required

integer format: int32

pickedQuantity

required

integer format: int32

unpickedQuantity

required

integer format: int32

picks

required

Array<object>

object

id

required

string format: uuid

positionId

required

string format: uuid

quantity

required

integer format: int32

transactionId

required

string format: uuid

pickedAt

required

string format: date-time

positions

required

Array<object>

object

id

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

id

required

string format: uuid

facilityId

required

string format: uuid

productId

required

string format: uuid

sku

required

string

productName

required

string

reference

required

string

lotNumber

required

string

nullable

requestedQuantity

required

integer format: int32

allocatedQuantity

required

integer format: int32

pickedQuantity

required

integer format: int32

unpickedQuantity

required

integer format: int32

status

required

string

Allowed values: Open Picked Released Issued

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

lines

required

Array<object>

object

id

required

string format: uuid

lineNumber

required

integer format: int32

positionId

required

string format: uuid

quantity

required

integer format: int32

pickedQuantity

required

integer format: int32

unpickedQuantity

required

integer format: int32

picks

required

Array<object>

object

id

required

string format: uuid

positionId

required

string format: uuid

quantity

required

integer format: int32

transactionId

required

string format: uuid

pickedAt

required

string format: date-time

positions

required

Array<object>

object

id

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

{
  "status": "Open",
  "positions": [
    {
      "stockStatus": "Available",
      "blockedReasons": [
        "ProductInactive"
      ]
    }
  ]
}

object

id

required

string format: uuid

facilityId

required

string format: uuid

productId

required

string format: uuid

sku

required

string

productName

required

string

reference

required

string

lotNumber

required

string

nullable

requestedQuantity

required

integer format: int32

allocatedQuantity

required

integer format: int32

pickedQuantity

required

integer format: int32

unpickedQuantity

required

integer format: int32

status

required

string

Allowed values: Open Picked Released Issued

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

lines

required

Array<object>

object

id

required

string format: uuid

lineNumber

required

integer format: int32

positionId

required

string format: uuid

quantity

required

integer format: int32

pickedQuantity

required

integer format: int32

unpickedQuantity

required

integer format: int32

picks

required

Array<object>

object

id

required

string format: uuid

positionId

required

string format: uuid

quantity

required

integer format: int32

transactionId

required

string format: uuid

pickedAt

required

string format: date-time

positions

required

Array<object>

object

id

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

{
  "status": "Open",
  "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"
}

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