BizKitHub
DocsAPI ReferenceShipment/bff/shipment/manual-state
postShipmentAdmin BFF

/bff/shipment/manual-state

Operator override (e.g. delivered in person, lost). Runs the shipment lifecycle (order status, COD, restock) and freezes the state against carrier tracking until /resume-tracking. Customer e-mail only with notifyCustomer.

ShipmentpostBffShipmentManual-state

Parameters

JSON body

Request body

application/json
externalIdstringRequired
state"created" | "handed_over" | "in_transit" | "ready_for_pickup" | "delivered" | "returned" | "failed"Required
reasonstringOptional
Length: 0–500
notifyCustomerbooleanOptional

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /bff/shipment/manual-state

post
curl -X POST "https://api.bizkithub.com/bff/shipment/manual-state" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "externalId": "example_externalId",
  "reason": "example_reason",
  "notifyCustomer": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key