Skip to content

Restocking shipment status updated
Webhook

Request

Sent when a restocking shipment moves to another status. The payload is the restocking shipment as GET /restocking_shipments/{id} returns it. Restocking shipments belong to the merchant, so the event is sent to every sales channel of the merchant that registered a URL for it.

Security
BearerAuth
Headers
x-hive-signaturestringrequired

Hex-encoded HMAC-SHA256 digest of the request body, keyed with your API token (the oldest valid one, if the sales channel has several).

x-hive-event-idstringrequired

Identifies the webhook call. Retries of the same call carry the same value.

Bodyapplication/jsonrequired
delivery_optionstringrequired

How the shipment is delivered to the warehouse.

Enum:"postal""courier""dropoff""hive_freight"
estimated_arrival_datestring or null, (date)required

The estimated arrival date.

po_numberstring or nullrequired

Purchase order number.

restocking_shipment_itemsArray of objects(RestockingShipmentItem)required

The items in the shipment.

supplier_namestring or nullrequired

Supplier name.

tracking_codestring or nullrequired

The shipment's tracking code.

warehouse_idinteger, (int64)required

Hive's ID of the destination warehouse.

Payload
{
  "id": 13,
  "merchant_id": 1,
  "warehouse_id": 71,
  "estimated_arrival_date": "2022-12-01",
  "delivery_option": "postal",
  "tracking_code": "1234567",
  "po_number": null,
  "supplier_name": null,
  "status": "restocked",
  "barcode": "RS.13",
  "restocking_shipment_items": [
    { … }
  ]
}

Responses

Any 2xx status acknowledges the webhook.