/api/v1/facilities/{facilityId}/inventory/allocations/{id}/issue
POST
/api/v1/facilities/{facilityId}/inventory/allocations/{id}/issue
const url = 'https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/inventory/allocations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/issue';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"note":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/inventory/allocations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/issue \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "note": "example" }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”facilityId
required
string format: uuid
id
required
string format: uuid
Request Body
Section titled “Request Body”object
note
string
Example generated
{ "note": "example"}object
note
string
Example generated
{ "note": "example"}object
note
string
Example generated
{ "note": "example"}Responses
Section titled “Responses”OK
object
transaction
required
object
transactionId
required
string format: uuid
facilityId
required
string format: uuid
type
required
string
reasonCode
required
string
reference
required
string
note
required
string
occurredAt
required
string format: date-time
lines
required
Array<object>
object
lineNumber
required
integer format: int32
productId
required
string format: uuid
sku
required
string
fromPositionId
required
string format: uuid
fromLocationId
required
string format: uuid
fromLocationCode
required
string
fromLpnId
required
string format: uuid
fromLpnCode
required
string
fromStatus
required
string
toPositionId
required
string format: uuid
toLocationId
required
string format: uuid
toLocationCode
required
string
toLpnId
required
string format: uuid
toLpnCode
required
string
toStatus
required
string
lotNumber
required
string
serial
required
string
expiryDate
required
string format: date
receivedOn
required
string format: date
quantity
required
integer format: int32
positions
required
Array<object>
object
positionId
required
string format: uuid
facilityId
required
string format: uuid
locationId
required
string format: uuid
locationCode
required
string
lpnId
required
string format: uuid
lpnCode
required
string
productId
required
string format: uuid
sku
required
string
lotNumber
required
string
serial
required
string
expiryDate
required
string format: date
receivedOn
required
string format: date
stockStatus
required
string
quantity
required
integer format: int32
allocatedQuantity
required
integer format: int32
allocation
required
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
requestedQuantity
required
integer format: int32
allocatedQuantity
required
integer format: int32
pickedQuantity
required
integer format: int32
unpickedQuantity
required
integer format: int32
status
required
string
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
lpnCode
required
string
productId
required
string format: uuid
sku
required
string
productName
required
string
lotNumber
required
string
serial
required
string
expiryDate
required
string format: date
receivedOn
required
string format: date
stockStatus
required
string
quantity
required
integer format: int32
allocatedQuantity
required
integer format: int32
availableQuantity
required
integer format: int32
blocked
required
boolean
blockedReasons
required
Array<string>
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
object
transaction
required
object
transactionId
required
string format: uuid
facilityId
required
string format: uuid
type
required
string
reasonCode
required
string
reference
required
string
note
required
string
occurredAt
required
string format: date-time
lines
required
Array<object>
object
lineNumber
required
integer format: int32
productId
required
string format: uuid
sku
required
string
fromPositionId
required
string format: uuid
fromLocationId
required
string format: uuid
fromLocationCode
required
string
fromLpnId
required
string format: uuid
fromLpnCode
required
string
fromStatus
required
string
toPositionId
required
string format: uuid
toLocationId
required
string format: uuid
toLocationCode
required
string
toLpnId
required
string format: uuid
toLpnCode
required
string
toStatus
required
string
lotNumber
required
string
serial
required
string
expiryDate
required
string format: date
receivedOn
required
string format: date
quantity
required
integer format: int32
positions
required
Array<object>
object
positionId
required
string format: uuid
facilityId
required
string format: uuid
locationId
required
string format: uuid
locationCode
required
string
lpnId
required
string format: uuid
lpnCode
required
string
productId
required
string format: uuid
sku
required
string
lotNumber
required
string
serial
required
string
expiryDate
required
string format: date
receivedOn
required
string format: date
stockStatus
required
string
quantity
required
integer format: int32
allocatedQuantity
required
integer format: int32
allocation
required
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
requestedQuantity
required
integer format: int32
allocatedQuantity
required
integer format: int32
pickedQuantity
required
integer format: int32
unpickedQuantity
required
integer format: int32
status
required
string
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
lpnCode
required
string
productId
required
string format: uuid
sku
required
string
productName
required
string
lotNumber
required
string
serial
required
string
expiryDate
required
string format: date
receivedOn
required
string format: date
stockStatus
required
string
quantity
required
integer format: int32
allocatedQuantity
required
integer format: int32
availableQuantity
required
integer format: int32
blocked
required
boolean
blockedReasons
required
Array<string>
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{ "transaction": { "type": "Receipt", "reasonCode": "Shrinkage", "lines": [ { "fromStatus": "Available", "toStatus": "Available" } ], "positions": [ { "stockStatus": "Available" } ] }, "allocation": { "status": "Open", "positions": [ { "stockStatus": "Available", "blockedReasons": [ "ProductInactive" ] } ] }}object
transaction
required
object
transactionId
required
string format: uuid
facilityId
required
string format: uuid
type
required
string
reasonCode
required
string
reference
required
string
note
required
string
occurredAt
required
string format: date-time
lines
required
Array<object>
object
lineNumber
required
integer format: int32
productId
required
string format: uuid
sku
required
string
fromPositionId
required
string format: uuid
fromLocationId
required
string format: uuid
fromLocationCode
required
string
fromLpnId
required
string format: uuid
fromLpnCode
required
string
fromStatus
required
string
toPositionId
required
string format: uuid
toLocationId
required
string format: uuid
toLocationCode
required
string
toLpnId
required
string format: uuid
toLpnCode
required
string
toStatus
required
string
lotNumber
required
string
serial
required
string
expiryDate
required
string format: date
receivedOn
required
string format: date
quantity
required
integer format: int32
positions
required
Array<object>
object
positionId
required
string format: uuid
facilityId
required
string format: uuid
locationId
required
string format: uuid
locationCode
required
string
lpnId
required
string format: uuid
lpnCode
required
string
productId
required
string format: uuid
sku
required
string
lotNumber
required
string
serial
required
string
expiryDate
required
string format: date
receivedOn
required
string format: date
stockStatus
required
string
quantity
required
integer format: int32
allocatedQuantity
required
integer format: int32
allocation
required
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
requestedQuantity
required
integer format: int32
allocatedQuantity
required
integer format: int32
pickedQuantity
required
integer format: int32
unpickedQuantity
required
integer format: int32
status
required
string
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
lpnCode
required
string
productId
required
string format: uuid
sku
required
string
productName
required
string
lotNumber
required
string
serial
required
string
expiryDate
required
string format: date
receivedOn
required
string format: date
stockStatus
required
string
quantity
required
integer format: int32
allocatedQuantity
required
integer format: int32
availableQuantity
required
integer format: int32
blocked
required
boolean
blockedReasons
required
Array<string>
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{ "transaction": { "type": "Receipt", "reasonCode": "Shrinkage", "lines": [ { "fromStatus": "Available", "toStatus": "Available" } ], "positions": [ { "stockStatus": "Available" } ] }, "allocation": { "status": "Open", "positions": [ { "stockStatus": "Available", "blockedReasons": [ "ProductInactive" ] } ] }}Bad Request
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Conflict
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}