Skip to content

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

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

orderobject or null(InventoryTransferOrderReference)required
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

shipmentsArray of objects(InventoryTransferOrderShipment)required

List of shipments associated with the inventory transfer order

statusstring(InventoryTransferOrderStatus)read-onlyrequired

Status of the inventory transfer order. Possible values:

  • pending: Initial status when the transfer order is created
  • created: The transfer order has been created and is ready for processing
  • processing: The transfer order is currently being processed
  • completed: The transfer order has been successfully completed
  • cancelled: The transfer order has been cancelled
Enum:"pending""created""processing""completed""cancelled"
updated_atstring, (date-time)read-onlyrequired

When the inventory transfer order was last updated

Response
{
  "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"
}