Skip to content

Merchant API v2 (2.0.0)

The Merchant API v2 provides programmatic access to merchant data across all their sales channels.

This version shifts from sales channel-scoped access to merchant-scoped access, allowing access to data across all sales channels owned by a single merchant.

The access tokens remain the same as in v1, but now they provide access to all sales channels.

Rate Limiting

All endpoints are rate limited to 100 requests per minute per merchant. The following headers are included in every response:

  • X-Rate-Limit-Used: The number of requests used in the current minute.
  • X-Rate-Limit-Max: The maximum number of requests allowed per minute (100). If the limit is exceeded, a 429 Too Many Requests response is returned.

Versioning and Deprecation Policy

v1 of the Merchant API will remain available as long as clients use it, but new features and improvements will only be added to v2. We recommend all new integrations use v2.

Pagination

All list endpoints use cursor-based pagination. The pagination.next_page_url field in the response indicates the next page. If null, there are no more results. Use the limit query parameter to control page size. See each endpoint's response schema for details.

Webhooks

Hive sends webhook notifications to inform you about important events in your merchant account. Configure webhook endpoints in your merchant dashboard. See the webhooks section below for available webhook events and their payloads.

Webhook Security

Hive signs all webhook requests with an x-hive-signature header to prevent malicious actors from sending invalid requests. This header contains a hex-encoded HMAC-SHA256 digest of the request body, using your API token as the key. Requests without this header or with invalid signatures should be ignored.

Ruby signature validation example:

def request_valid?(req)
  return false if !req.post?
  request_sig = req.get_header("x-hive-signature")
  expected_sig = OpenSSL::HMAC.hexdigest("sha256", ENV["API_TOKEN"], req.body)
  Rack::Utils.secure_compare(request_sig, expected_sig)
end

Webhook Reliability

Webhook URLs should be idempotent as Hive cannot guarantee the order of calls or retry attempts for the same event. What this means in practice, is that you should check the timestamp of the object in the payload. Ignore payloads with a timestamp older than the last update you saved. Only process the webhook if the updated timestamp is newer than the one you have on file.

Download OpenAPI description
mapi_v2_oas31.json
mapi_v2_oas31.yaml
Overview
URL

https://developers.hive.app

Hive Support

tech.api@hive.app

Languages
Servers
Mock server

https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/

Production API

https://app.hive.app/merchant_api/v2/

Staging API

https://staging.app.hive.app/merchant_api/v2/

InventoryTransferOrders

Operations related to inventory transfer orders

OperationsWebhooks

List inventory transfer orders

Request

Returns all inventory transfer orders for the merchant.

See the Pagination section in the API overview above for details on how pagination works.

Security
BearerAuth
Query
limitinteger[ 1 .. 100 ]

Number of items to return per page (for pagination)

Default 20
created_at[gt]string(date-time)

Filter results created after this date (ISO 8601 format)

created_at[lt]string(date-time)

Filter results created before this date (ISO 8601 format)

created_at[gte]string(date-time)

Filter results created on or after this date (ISO 8601 format)

created_at[lte]string(date-time)

Filter results created on or before this date (ISO 8601 format)

curl -i -X GET \
  'https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/inventory_transfer_orders?limit=20&created_at%5Bgt%5D=2019-08-24T14%3A15%3A22Z&created_at%5Blt%5D=2019-08-24T14%3A15%3A22Z&created_at%5Bgte%5D=2019-08-24T14%3A15%3A22Z&created_at%5Blte%5D=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

A list of inventory transfer orders

Bodyapplication/json
dataArray of objects(InventoryTransferOrder)
paginationobject(Pagination)
Response
application/json
{
  "data": [
    { … }
  ],
  "pagination": {
    "first_page_url": "https://app.hive.app/merchant_api/v2/collection_of_items?limit=20",
    "limit": 20,
    "next_page_url": "https://app.hive.app/merchant_api/v2/collection_of_items?limit=20&page=eyJpZCI6MTIzNDU2fQ"
  }
}

Create a new inventory transfer order

Request

Creates a new inventory transfer order for the merchant.

Security
BearerAuth
Bodyapplication/jsonrequired
destination_idinteger(int64)required

The ID of the destination warehouse

itemsArray of objectsrequired

List of items for the inventory transfer order

Any of:
items[].​inventory_batch_idinteger or null
Any of:

The ID of the inventory batch

integer(int64)
items[].​quantityinteger(int32)>= 1required

The quantity of this item to transfer

items[].​sku_codestring

The merchant's SKU identifier - required if sku_id is not provided

items[].​sku_idinteger(int64)required

Hive's SKU identifier - required if sku_code is not provided

order_notesstring

Notes for the inventory transfer order

origin_idinteger(int64)required

The ID of the origin warehouse

curl -i -X POST \
  https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/inventory_transfer_orders \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "origin_id": 39,
    "destination_id": 38,
    "order_notes": "",
    "items": [
      {
        "inventory_batch_id": null,
        "quantity": 100,
        "sku_id": 586004
      }
    ]
  }'

Responses

Inventory transfer order created successfully

Bodyapplication/json
completed_atstring or null(date-time)read-only

When the inventory transfer order was completed

created_atstring(date-time)read-onlyrequired

When the inventory transfer order was created

destination_idinteger(int64)required

The ID of the destination warehouse

documentsArray of objects(InventoryTransferOrderDocument)required

List of documents associated with the inventory transfer order

documents[].​idinteger(int64)required

Document ID

documents[].​namestring or nullrequired

Document name

documents[].​urlstringrequired

Document URL

idinteger(int64)read-onlyrequired

Hive's unique identifier for this inventory transfer order

itemsArray of objects(InventoryTransferOrderItem)required

List of items in the inventory transfer order

items[].​idinteger(int64)read-onlyrequired

Hive's unique identifier for this item

items[].​inventory_batchobject or null(InventoryTransferOrderInventoryBatch)
items[].​quantityinteger(int32)>= 1required

The quantity of this item to transfer

items[].​sku_codestringrequired

The merchant's SKU identifier - required if sku_id is not provided

items[].​sku_idinteger(int64)required

Hive's SKU identifier - required if sku_code is not provided

orderobject or null(InventoryTransferOrderReference)required
order.​idinteger or null(int64)

Order ID

order.​statusstring or null

Order status

order_notesstring or null

Notes for the inventory transfer order

origin_idinteger(int64)required

The ID of the origin warehouse

restocking_shipmentsArray of objects(InventoryTransferOrderRestockingShipment)required

List of restocking shipments associated with the inventory transfer order

restocking_shipments[].​estimated_arrival_datestring or null(date)

Estimated arrival date

restocking_shipments[].​idinteger(int64)required

Restocking shipment ID

restocking_shipments[].​itemsArray of objects(RestockingShipmentItem)required

Items in the restocking shipment

restocking_shipments[].​items[].​announced_quantityinteger(int32)>= 0

Quantity of this item in the shipment

restocking_shipments[].​items[].​arrived_quantityinteger(int32)>= 0required

Arrived quantity of this item (after shipment is received)

restocking_shipments[].​items[].​damaged_quantityinteger(int32)>= 0required

Damaged quantity of this item (after shipment is received)

restocking_shipments[].​items[].​idinteger(int64)

Hive's unique identifier

restocking_shipments[].​items[].​missing_quantityinteger(int32)>= 0required

Missing quantity of this item (after shipment is received)

restocking_shipments[].​items[].​remarksstring or null

Free text for remarks

restocking_shipments[].​items[].​sku_codestringrequired

The merchant's SKU identifier - required if sku_id is not provided

restocking_shipments[].​items[].​sku_idinteger(int64)required

Hive SKU identifier - required if sku_code is not provided

restocking_shipments[].​items[].​total_cost_in_centsinteger or null(int32)>= 0

Cost in cents

restocking_shipments[].​statusstringrequired

Restocking shipment status

restocking_shipments[].​tracking_codestring or null

Tracking code

restocking_shipments[].​tracking_urlstring or null

Tracking URL

shipmentsArray of objects(InventoryTransferOrderShipment)required

List of shipments associated with the inventory transfer order

shipments[].​idinteger(int64)required

Shipment ID

shipments[].​issuesArray of objectsrequired

Issues with the shipment

shipments[].​itemsArray of objects(InventoryTransferOrderShipmentItem)required

Items in the shipment

shipments[].​items[].​idinteger(int64)required

Shipment item ID

shipments[].​items[].​quantityinteger(int32)>= 1required

Quantity in the shipment

shipments[].​items[].​sku_codestringrequired

The merchant's SKU code

shipments[].​items[].​sku_idinteger(int64)required

The SKU ID

shipments[].​restocking_shipmentobject(InventoryTransferOrderRestockingShipment)
shipments[].​statusstringrequired

Shipment status

statusstring(InventoryTransferOrderStatus)read-onlyrequired
Enum"pending""created""processing""completed""cancelled"
updated_atstring(date-time)read-onlyrequired

When the inventory transfer order was last updated

Response
application/json
{
  "id": 297,
  "status": "processing",
  "created_at": "2025-06-05T15:15:12.256+02:00",
  "completed_at": null,
  "order": {
    "id": 1195780,
    "status": "processing"
  },
  "origin_id": 4,
  "destination_id": 2,
  "order_notes": "",
  "documents": [],
  "restocking_shipments": [
    { … }
  ],
  "shipments": [
    { … }
  ],
  "items": [
    { … }
  ],
  "updated_at": "2025-06-05T16:20:15.300+02:00"
}

Get an inventory transfer order

Request

Returns a specific inventory transfer order.

Security
BearerAuth
Path
idinteger(int64)required

Inventory Transfer Order ID

curl -i -X GET \
  'https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/inventory_transfer_orders/{id}' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

An inventory transfer order

Bodyapplication/json
completed_atstring or null(date-time)read-only

When the inventory transfer order was completed

created_atstring(date-time)read-onlyrequired

When the inventory transfer order was created

destination_idinteger(int64)required

The ID of the destination warehouse

documentsArray of objects(InventoryTransferOrderDocument)required

List of documents associated with the inventory transfer order

documents[].​idinteger(int64)required

Document ID

documents[].​namestring or nullrequired

Document name

documents[].​urlstringrequired

Document URL

idinteger(int64)read-onlyrequired

Hive's unique identifier for this inventory transfer order

itemsArray of objects(InventoryTransferOrderItem)required

List of items in the inventory transfer order

items[].​idinteger(int64)read-onlyrequired

Hive's unique identifier for this item

items[].​inventory_batchobject or null(InventoryTransferOrderInventoryBatch)
items[].​quantityinteger(int32)>= 1required

The quantity of this item to transfer

items[].​sku_codestringrequired

The merchant's SKU identifier - required if sku_id is not provided

items[].​sku_idinteger(int64)required

Hive's SKU identifier - required if sku_code is not provided

orderobject or null(InventoryTransferOrderReference)required
order.​idinteger or null(int64)

Order ID

order.​statusstring or null

Order status

order_notesstring or null

Notes for the inventory transfer order

origin_idinteger(int64)required

The ID of the origin warehouse

restocking_shipmentsArray of objects(InventoryTransferOrderRestockingShipment)required

List of restocking shipments associated with the inventory transfer order

restocking_shipments[].​estimated_arrival_datestring or null(date)

Estimated arrival date

restocking_shipments[].​idinteger(int64)required

Restocking shipment ID

restocking_shipments[].​itemsArray of objects(RestockingShipmentItem)required

Items in the restocking shipment

restocking_shipments[].​items[].​announced_quantityinteger(int32)>= 0

Quantity of this item in the shipment

restocking_shipments[].​items[].​arrived_quantityinteger(int32)>= 0required

Arrived quantity of this item (after shipment is received)

restocking_shipments[].​items[].​damaged_quantityinteger(int32)>= 0required

Damaged quantity of this item (after shipment is received)

restocking_shipments[].​items[].​idinteger(int64)

Hive's unique identifier

restocking_shipments[].​items[].​missing_quantityinteger(int32)>= 0required

Missing quantity of this item (after shipment is received)

restocking_shipments[].​items[].​remarksstring or null

Free text for remarks

restocking_shipments[].​items[].​sku_codestringrequired

The merchant's SKU identifier - required if sku_id is not provided

restocking_shipments[].​items[].​sku_idinteger(int64)required

Hive SKU identifier - required if sku_code is not provided

restocking_shipments[].​items[].​total_cost_in_centsinteger or null(int32)>= 0

Cost in cents

restocking_shipments[].​statusstringrequired

Restocking shipment status

restocking_shipments[].​tracking_codestring or null

Tracking code

restocking_shipments[].​tracking_urlstring or null

Tracking URL

shipmentsArray of objects(InventoryTransferOrderShipment)required

List of shipments associated with the inventory transfer order

shipments[].​idinteger(int64)required

Shipment ID

shipments[].​issuesArray of objectsrequired

Issues with the shipment

shipments[].​itemsArray of objects(InventoryTransferOrderShipmentItem)required

Items in the shipment

shipments[].​items[].​idinteger(int64)required

Shipment item ID

shipments[].​items[].​quantityinteger(int32)>= 1required

Quantity in the shipment

shipments[].​items[].​sku_codestringrequired

The merchant's SKU code

shipments[].​items[].​sku_idinteger(int64)required

The SKU ID

shipments[].​restocking_shipmentobject(InventoryTransferOrderRestockingShipment)
shipments[].​statusstringrequired

Shipment status

statusstring(InventoryTransferOrderStatus)read-onlyrequired
Enum"pending""created""processing""completed""cancelled"
updated_atstring(date-time)read-onlyrequired

When the inventory transfer order was last updated

Response
application/json
{
  "id": 297,
  "status": "processing",
  "created_at": "2025-06-05T15:15:12.256+02:00",
  "completed_at": null,
  "order": {
    "id": 1195780,
    "status": "processing"
  },
  "origin_id": 4,
  "destination_id": 2,
  "order_notes": "",
  "documents": [],
  "restocking_shipments": [
    { … }
  ],
  "shipments": [
    { … }
  ],
  "items": [
    { … }
  ],
  "updated_at": "2025-06-05T16:20:15.300+02:00"
}

Partially update an inventory transfer order

Request

Partially updates an existing inventory transfer order. Only the provided fields will be updated.

Security
BearerAuth
Path
idinteger(int64)required

Inventory Transfer Order ID

Bodyapplication/jsonrequired
destination_idinteger(int64)

The ID of the destination warehouse

order_notesstring

Notes for the inventory transfer order

origin_idinteger(int64)

The ID of the origin warehouse

curl -i -X PATCH \
  'https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/inventory_transfer_orders/{id}' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_notes": "Updated notes",
    "destination_id": 3
  }'

Responses

Inventory transfer order updated successfully

Bodyapplication/json
completed_atstring or null(date-time)read-only

When the inventory transfer order was completed

created_atstring(date-time)read-onlyrequired

When the inventory transfer order was created

destination_idinteger(int64)required

The ID of the destination warehouse

documentsArray of objects(InventoryTransferOrderDocument)required

List of documents associated with the inventory transfer order

documents[].​idinteger(int64)required

Document ID

documents[].​namestring or nullrequired

Document name

documents[].​urlstringrequired

Document URL

idinteger(int64)read-onlyrequired

Hive's unique identifier for this inventory transfer order

itemsArray of objects(InventoryTransferOrderItem)required

List of items in the inventory transfer order

items[].​idinteger(int64)read-onlyrequired

Hive's unique identifier for this item

items[].​inventory_batchobject or null(InventoryTransferOrderInventoryBatch)
items[].​quantityinteger(int32)>= 1required

The quantity of this item to transfer

items[].​sku_codestringrequired

The merchant's SKU identifier - required if sku_id is not provided

items[].​sku_idinteger(int64)required

Hive's SKU identifier - required if sku_code is not provided

orderobject or null(InventoryTransferOrderReference)required
order.​idinteger or null(int64)

Order ID

order.​statusstring or null

Order status

order_notesstring or null

Notes for the inventory transfer order

origin_idinteger(int64)required

The ID of the origin warehouse

restocking_shipmentsArray of objects(InventoryTransferOrderRestockingShipment)required

List of restocking shipments associated with the inventory transfer order

restocking_shipments[].​estimated_arrival_datestring or null(date)

Estimated arrival date

restocking_shipments[].​idinteger(int64)required

Restocking shipment ID

restocking_shipments[].​itemsArray of objects(RestockingShipmentItem)required

Items in the restocking shipment

restocking_shipments[].​items[].​announced_quantityinteger(int32)>= 0

Quantity of this item in the shipment

restocking_shipments[].​items[].​arrived_quantityinteger(int32)>= 0required

Arrived quantity of this item (after shipment is received)

restocking_shipments[].​items[].​damaged_quantityinteger(int32)>= 0required

Damaged quantity of this item (after shipment is received)

restocking_shipments[].​items[].​idinteger(int64)

Hive's unique identifier

restocking_shipments[].​items[].​missing_quantityinteger(int32)>= 0required

Missing quantity of this item (after shipment is received)

restocking_shipments[].​items[].​remarksstring or null

Free text for remarks

restocking_shipments[].​items[].​sku_codestringrequired

The merchant's SKU identifier - required if sku_id is not provided

restocking_shipments[].​items[].​sku_idinteger(int64)required

Hive SKU identifier - required if sku_code is not provided

restocking_shipments[].​items[].​total_cost_in_centsinteger or null(int32)>= 0

Cost in cents

restocking_shipments[].​statusstringrequired

Restocking shipment status

restocking_shipments[].​tracking_codestring or null

Tracking code

restocking_shipments[].​tracking_urlstring or null

Tracking URL

shipmentsArray of objects(InventoryTransferOrderShipment)required

List of shipments associated with the inventory transfer order

shipments[].​idinteger(int64)required

Shipment ID

shipments[].​issuesArray of objectsrequired

Issues with the shipment

shipments[].​itemsArray of objects(InventoryTransferOrderShipmentItem)required

Items in the shipment

shipments[].​items[].​idinteger(int64)required

Shipment item ID

shipments[].​items[].​quantityinteger(int32)>= 1required

Quantity in the shipment

shipments[].​items[].​sku_codestringrequired

The merchant's SKU code

shipments[].​items[].​sku_idinteger(int64)required

The SKU ID

shipments[].​restocking_shipmentobject(InventoryTransferOrderRestockingShipment)
shipments[].​statusstringrequired

Shipment status

statusstring(InventoryTransferOrderStatus)read-onlyrequired
Enum"pending""created""processing""completed""cancelled"
updated_atstring(date-time)read-onlyrequired

When the inventory transfer order was last updated

Response
application/json
{
  "id": 297,
  "status": "processing",
  "created_at": "2025-06-05T15:15:12.256+02:00",
  "completed_at": null,
  "order": {
    "id": 1195780,
    "status": "processing"
  },
  "origin_id": 4,
  "destination_id": 2,
  "order_notes": "",
  "documents": [],
  "restocking_shipments": [
    { … }
  ],
  "shipments": [
    { … }
  ],
  "items": [
    { … }
  ],
  "updated_at": "2025-06-05T16:20:15.300+02:00"
}

Cancel an inventory transfer order

Request

Cancels an existing inventory transfer order.

Security
BearerAuth
Path
idinteger(int64)required

Inventory Transfer Order ID

curl -i -X PUT \
  'https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/inventory_transfer_orders/{id}/cancel' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Inventory transfer order cancelled successfully

Bodyapplication/json
completed_atstring or null(date-time)read-only

When the inventory transfer order was completed

created_atstring(date-time)read-onlyrequired

When the inventory transfer order was created

destination_idinteger(int64)required

The ID of the destination warehouse

documentsArray of objects(InventoryTransferOrderDocument)required

List of documents associated with the inventory transfer order

documents[].​idinteger(int64)required

Document ID

documents[].​namestring or nullrequired

Document name

documents[].​urlstringrequired

Document URL

idinteger(int64)read-onlyrequired

Hive's unique identifier for this inventory transfer order

itemsArray of objects(InventoryTransferOrderItem)required

List of items in the inventory transfer order

items[].​idinteger(int64)read-onlyrequired

Hive's unique identifier for this item

items[].​inventory_batchobject or null(InventoryTransferOrderInventoryBatch)
items[].​quantityinteger(int32)>= 1required

The quantity of this item to transfer

items[].​sku_codestringrequired

The merchant's SKU identifier - required if sku_id is not provided

items[].​sku_idinteger(int64)required

Hive's SKU identifier - required if sku_code is not provided

orderobject or null(InventoryTransferOrderReference)required
order.​idinteger or null(int64)

Order ID

order.​statusstring or null

Order status

order_notesstring or null

Notes for the inventory transfer order

origin_idinteger(int64)required

The ID of the origin warehouse

restocking_shipmentsArray of objects(InventoryTransferOrderRestockingShipment)required

List of restocking shipments associated with the inventory transfer order

restocking_shipments[].​estimated_arrival_datestring or null(date)

Estimated arrival date

restocking_shipments[].​idinteger(int64)required

Restocking shipment ID

restocking_shipments[].​itemsArray of objects(RestockingShipmentItem)required

Items in the restocking shipment

restocking_shipments[].​items[].​announced_quantityinteger(int32)>= 0

Quantity of this item in the shipment

restocking_shipments[].​items[].​arrived_quantityinteger(int32)>= 0required

Arrived quantity of this item (after shipment is received)

restocking_shipments[].​items[].​damaged_quantityinteger(int32)>= 0required

Damaged quantity of this item (after shipment is received)

restocking_shipments[].​items[].​idinteger(int64)

Hive's unique identifier

restocking_shipments[].​items[].​missing_quantityinteger(int32)>= 0required

Missing quantity of this item (after shipment is received)

restocking_shipments[].​items[].​remarksstring or null

Free text for remarks

restocking_shipments[].​items[].​sku_codestringrequired

The merchant's SKU identifier - required if sku_id is not provided

restocking_shipments[].​items[].​sku_idinteger(int64)required

Hive SKU identifier - required if sku_code is not provided

restocking_shipments[].​items[].​total_cost_in_centsinteger or null(int32)>= 0

Cost in cents

restocking_shipments[].​statusstringrequired

Restocking shipment status

restocking_shipments[].​tracking_codestring or null

Tracking code

restocking_shipments[].​tracking_urlstring or null

Tracking URL

shipmentsArray of objects(InventoryTransferOrderShipment)required

List of shipments associated with the inventory transfer order

shipments[].​idinteger(int64)required

Shipment ID

shipments[].​issuesArray of objectsrequired

Issues with the shipment

shipments[].​itemsArray of objects(InventoryTransferOrderShipmentItem)required

Items in the shipment

shipments[].​items[].​idinteger(int64)required

Shipment item ID

shipments[].​items[].​quantityinteger(int32)>= 1required

Quantity in the shipment

shipments[].​items[].​sku_codestringrequired

The merchant's SKU code

shipments[].​items[].​sku_idinteger(int64)required

The SKU ID

shipments[].​restocking_shipmentobject(InventoryTransferOrderRestockingShipment)
shipments[].​statusstringrequired

Shipment status

statusstring(InventoryTransferOrderStatus)read-onlyrequired
Enum"pending""created""processing""completed""cancelled"
updated_atstring(date-time)read-onlyrequired

When the inventory transfer order was last updated

Response
application/json
{
  "id": 297,
  "status": "processing",
  "created_at": "2025-06-05T15:15:12.256+02:00",
  "completed_at": null,
  "order": {
    "id": 1195780,
    "status": "processing"
  },
  "origin_id": 4,
  "destination_id": 2,
  "order_notes": "",
  "documents": [],
  "restocking_shipments": [
    { … }
  ],
  "shipments": [
    { … }
  ],
  "items": [
    { … }
  ],
  "updated_at": "2025-06-05T16:20:15.300+02:00"
}

inventoryTransferOrderStatusUpdatedWebhookWebhook

Request

Security
BearerAuth
Headers
x-hive-signaturestringrequired

HMAC-SHA256 signature of the request body using your API token as the key

Bodyapplication/json
event_typestringrequired

The type of webhook event

Value"inventory_transfer_order.status_updated"
event_idstring(uuid)required

Unique identifier for this webhook event

timestampstring(date-time)required

When the event occurred

dataobject(InventoryTransferOrder)required
data.​completed_atstring or null(date-time)read-only

When the inventory transfer order was completed

data.​created_atstring(date-time)read-onlyrequired

When the inventory transfer order was created

data.​destination_idinteger(int64)required

The ID of the destination warehouse

data.​documentsArray of objects(InventoryTransferOrderDocument)required

List of documents associated with the inventory transfer order

data.​documents[].​idinteger(int64)required

Document ID

data.​documents[].​namestring or nullrequired

Document name

data.​documents[].​urlstringrequired

Document URL

data.​idinteger(int64)read-onlyrequired

Hive's unique identifier for this inventory transfer order

data.​itemsArray of objects(InventoryTransferOrderItem)required

List of items in the inventory transfer order

data.​items[].​idinteger(int64)read-onlyrequired

Hive's unique identifier for this item

data.​items[].​inventory_batchobject or null(InventoryTransferOrderInventoryBatch)
data.​items[].​quantityinteger(int32)>= 1required

The quantity of this item to transfer

data.​items[].​sku_codestringrequired

The merchant's SKU identifier - required if sku_id is not provided

data.​items[].​sku_idinteger(int64)required

Hive's SKU identifier - required if sku_code is not provided

data.​orderobject or null(InventoryTransferOrderReference)required
data.​order.​idinteger or null(int64)

Order ID

data.​order.​statusstring or null

Order status

data.​order_notesstring or null

Notes for the inventory transfer order

data.​origin_idinteger(int64)required

The ID of the origin warehouse

data.​restocking_shipmentsArray of objects(InventoryTransferOrderRestockingShipment)required

List of restocking shipments associated with the inventory transfer order

data.​restocking_shipments[].​estimated_arrival_datestring or null(date)

Estimated arrival date

data.​restocking_shipments[].​idinteger(int64)required

Restocking shipment ID

data.​restocking_shipments[].​itemsArray of objects(RestockingShipmentItem)required

Items in the restocking shipment

data.​restocking_shipments[].​items[].​announced_quantityinteger(int32)>= 0

Quantity of this item in the shipment

data.​restocking_shipments[].​items[].​arrived_quantityinteger(int32)>= 0required

Arrived quantity of this item (after shipment is received)

data.​restocking_shipments[].​items[].​damaged_quantityinteger(int32)>= 0required

Damaged quantity of this item (after shipment is received)

data.​restocking_shipments[].​items[].​idinteger(int64)

Hive's unique identifier

data.​restocking_shipments[].​items[].​missing_quantityinteger(int32)>= 0required

Missing quantity of this item (after shipment is received)

data.​restocking_shipments[].​items[].​remarksstring or null

Free text for remarks

data.​restocking_shipments[].​items[].​sku_codestringrequired

The merchant's SKU identifier - required if sku_id is not provided

data.​restocking_shipments[].​items[].​sku_idinteger(int64)required

Hive SKU identifier - required if sku_code is not provided

data.​restocking_shipments[].​items[].​total_cost_in_centsinteger or null(int32)>= 0

Cost in cents

data.​restocking_shipments[].​statusstringrequired

Restocking shipment status

data.​restocking_shipments[].​tracking_codestring or null

Tracking code

data.​restocking_shipments[].​tracking_urlstring or null

Tracking URL

data.​shipmentsArray of objects(InventoryTransferOrderShipment)required

List of shipments associated with the inventory transfer order

data.​shipments[].​idinteger(int64)required

Shipment ID

data.​shipments[].​issuesArray of objectsrequired

Issues with the shipment

data.​shipments[].​itemsArray of objects(InventoryTransferOrderShipmentItem)required

Items in the shipment

data.​shipments[].​items[].​idinteger(int64)required

Shipment item ID

data.​shipments[].​items[].​quantityinteger(int32)>= 1required

Quantity in the shipment

data.​shipments[].​items[].​sku_codestringrequired

The merchant's SKU code

data.​shipments[].​items[].​sku_idinteger(int64)required

The SKU ID

data.​shipments[].​restocking_shipmentobject(InventoryTransferOrderRestockingShipment)
data.​shipments[].​statusstringrequired

Shipment status

data.​statusstring(InventoryTransferOrderStatus)read-onlyrequired
Enum"pending""created""processing""completed""cancelled"
data.​updated_atstring(date-time)read-onlyrequired

When the inventory transfer order was last updated

application/json
{
  "event_type": "inventory_transfer_order.status_updated",
  "event_id": "123e4567-e89b-12d3-a456-426614174004",
  "timestamp": "2023-10-01T19:00:00Z",
  "data": {
    "id": 123456,
    "status": "completed",
    "created_at": "2023-10-01T19:00:00Z",
    "completed_at": "2023-10-01T20:00:00Z",
    "origin_id": 4,
    "destination_id": 2,
    "updated_at": "2023-10-01T20:00:00Z",
    "order": { … },
    "order_notes": "",
    "documents": [],
    "restocking_shipments": [],
    "shipments": [],
    "items": [ … ]
  }
}

Responses

Webhook received successfully

Orders

Operations related to orders

OperationsWebhooks

RestockingShipments

Operations related to restocking shipments

OperationsWebhooks

Returns

Operations related to returns

OperationsWebhooks

SKUs

Operations related to Stock Keeping Units (SKUs)

Operations

SalesChannels

Operations related to sales channels

Operations

Shipments

Operations related to shipments

OperationsWebhooks

Warehouses

Operations related to warehouses

Operations

Webhooks

Webhook event notifications

Webhooks