DocsAPI ReferenceWarehouse/bff/warehouse/reservation/create
postWarehouseAdmin BFF

/bff/warehouse/reservation/create

Reserve stock (Tier 1 #1)

WarehousepostBffWarehouseReservationCreate

Parameters

14 body

14 total
Body · 14
warehouseIdnumberRequired
locationIdnumber | null
productCodestring | null

Human-readable product code (mutually exclusive with virtualItemSku).

productVariantCodestring | null

Variant code, requires productCode.

virtualItemSkustring | null

Free-form virtual SKU for non-catalogue items.

quantitynumberRequired
Range: 1
modestring | string
orderIdnumber | null
orderItemIdnumber | null
externalKeystring | null
expiresAtstring | null
idempotencyKeystring | null
notestring | null
performedByMemberIdnumber | null

Request

POST /bff/warehouse/reservation/create

post
curl -X POST "https://api.bizkithub.com/bff/warehouse/reservation/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "warehouseId": 0,
  "quantity": 0
}'

Response

JSON payload

{
  "success": false,
  "reservationId": 0,
  "movementId": 0,
  "newQuantity": 0,
  "newReserved": 0,
  "available": 0,
  "deduped": false
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key