Block an inventory batch

Request

Blocks an inventory batch, preventing its stock from being used for fulfillment. This is typically used when there are quality issues with a specific batch.

Security

BearerAuth

Path

sku_idinteger, (int64)required

SKU ID

idinteger, (int64)required

Inventory Batch ID

Bodyapplication/jsonrequired

notesstring or null

Optional notes explaining why the batch is being blocked (e.g., quality issue description)

user_emailstring, (email)required

Email of the merchant user performing the block action. Must belong to the merchant.

curl -i -X POST \
  'https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/skus/{sku_id}/inventory_batches/{id}/block' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_email": "warehouse-manager@merchant.com",
    "notes": "Quality issue detected during inspection"
  }'

Responses

Inventory batch blocked successfully

Bodyapplication/json

blockedbooleanrequired

Whether this batch has pending blocking issues that prevent fulfillment

expiry_datestring or null, (date)required

Expiration date of the batch (ISO8601 date, read-only)

idintegerrequired

Hive unique ID for the batch (read-only)

lot_numberstring or nullrequired

Lot number for the batch (read-only)

production_datestring or null, (date)required

Production date of the batch (ISO8601 date, read-only)

statusstringrequired

Status of the batch (active or archived)

Enum:"active""archived"

namestringdeprecated

Name of the batch (read-only)

tracking_codestring or nulldeprecated

Tracking code (read-only)

Response

{
  "blocked": false,
  "expiry_date": "2024-12-31",
  "id": 1,
  "lot_number": "LOT-001",
  "name": "Batch-001",
  "production_date": "2024-01-15",
  "status": "active",
  "tracking_code": "BATCH-TRACK-001"
}