Skip to content

Create an inventory batch for a SKU

Request

Creates a new inventory batch for the specified SKU. Merchants can use this to create batches before announcing restocking shipments.

Security
BearerAuth
Path
sku_idinteger, (int64)required

SKU ID

Bodyapplication/jsonrequired
lot_numberstring or null

Lot number for the batch

production_datestring or null, (date)

Production date of the batch (ISO8601 date)

expiry_datestring or null, (date)

Expiration date of the batch (ISO8601 date)

curl -i -X POST \
  'https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/skus/{sku_id}/inventory_batches' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "lot_number": "LOT-2024-001",
    "production_date": "2024-01-15",
    "expiry_date": "2025-12-31"
  }'

Responses

Inventory batch created 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"
}