Docs API Reference Warehouse/bff/warehouse/reservation/release

postWarehouseAdmin BFF

/bff/warehouse/reservation/release

Release reservation(s) (Tier 1 #1)

WarehousepostBffWarehouseReservationRelease

Parameters

JSON body

Request body

application/json

reservationIdnumberOptional

orderIdnumberOptional

orderItemIdnumber | nullOptional

One of 2:

Variant 1

number

Variant 2

null

externalKeystringOptional

Length: 0–120

reason"storno" | "expired" | "manual" | "cart_abandoned"Optional

notestring | nullOptional

One of 2:

Variant 1

string

Variant 2

null

idempotencyKeystring | nullOptional

One of 2:

Variant 1

string

Length: 0–80

Variant 2

null

performedByMemberIdnumber | nullOptional

One of 2:

Variant 1

number

Variant 2

null

Response schema

1 status code documented

200Success

successbooleanRequired

releasedobject[]Required

Each array item:

reservationIdnumberRequired

warehouseIdnumberRequired

productIdnumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

productVariantIdnumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

virtualItemSkustring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

quantitynumberRequired

newReservednumberRequired

newQuantitynumberRequired

movementIdnumberRequired

alreadyResolvedbooleanRequired

Response example

application/json

{
  "success": false,
  "released": [
    {
      "reservationId": 0,
      "warehouseId": 0,
      "quantity": 0,
      "newReserved": 0,
      "newQuantity": 0,
      "movementId": 0
    }
  ],
  "alreadyResolved": false
}

Request example

POST /bff/warehouse/reservation/release

post

curl -X POST "https://api.bizkithub.com/bff/warehouse/reservation/release" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "reservationId": 0,
  "orderId": 0,
  "externalKey": "example_externalKey"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key