The Restocking Shipment resource
Properties
id - the restocking shipment's unique identifier in Hive system
status - the restocking shipment's status on Hive side. Possible values:
Status options
shipped - initial status meaning that restocking shipment is on the way
delivered - the restocking shipment is delivered to the fulfillment center, but its content is not verified yet
arrived - Hive completed the arrival documentation, checked packing slip, picture of shipment and documents are uploaded
processing - the restocking shipment is getting unpacked and its items are getting restocked into storage boxes and pallets
restocked - the restocking shipment is fully processed in the fulfillment center and its items are completely restocked
cancelled - the restocking shipment is cancelled by merchant
List all restocking shipments
List all Restocking Shipments
GET https://app.hive.app/merchant_api/v1/restocking_shipments
Returns restocking shipments ordered by descending creation time.
note: arrived_quantity, damaged_quantity and missing_quantity are visible only if the status is restocked
{
"data": [
{
"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": [
{
"id": 15,
"sku_id": 558,
"announced_quantity": 10,
"arrived_quantity": 2,
"damaged_quantity": 1,
"missing_quantity": 7,
"remarks": null,
"total_cost_in_cents": null,
"inventory_batches": [
{
"id": 827,
"name": "Morph II - 827",
"tracking_code": "A01234",
"expiry_date": "2023-12-30",
"arrived_quantity": 3
},
{
"id": 828,
"name": "Morph II - 828",
"tracking_code": "B56789",
"expiry_date": "2024-02-15",
"arrived_quantity": 1
}
]
}
]
}
],
"pagination": {
"current_page": 1,
"item_count": 1,
"page_count": 1,
"items_per_page": 20
}
}
Get one restocking shipment
Get one restocking shipment
GET https://app.hive.app/merchant_api/v1/restocking_shipments/{id}
Path Parameters
| Name | Type | Description |
|---|
| | The (Hive) ID of the restocking shipment |
{
"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": "shipped",
"barcode": "RS.13",
"restocking_shipment_items": [
{
"id": 15,
"sku_id": 558,
"announced_quantity": 10,
"arrived_quantity": 2,
"damaged_quantity": 1,
"missing_quantity": 7,
"remarks": null,
"total_cost_in_cents": null,
"inventory_batches": [
{
"id": 827,
"name": "Morph II - 827",
"tracking_code": "A01234",
"expiry_date": "2023-12-30",
"arrived_quantity": 3
},
{
"id": 828,
"name": "Morph II - 828",
"tracking_code": "B56789",
"expiry_date": "2024-02-15",
"arrived_quantity": 1
}
]
}
]
}
{
"success": false,
"errors": [
"record not found"
]
}
Create a new restocking shipment
Creates a new restocking shipment
POST https://app.hive.app/merchant_api/v1/restocking_shipments/
Request Body
| Name | Type | Description |
|---|
| | An ID that uniquely identifies the wharehouse |
| | The estimated arrival date |
| | The delivery option, must be one of: postal, courier, dropoff, hive_freight |
| | The shipment tracking code |
| | |
| | |
restocking_shipment_items.sku_id* | | |
restocking_shipment_items.announced_quantity* | | |
restocking_shipment_items.remarks | | |
restocking_shipment_items.total_cost_in_cents | | The total cost in cents of the |
{
"id": 16,
"merchant_id": 1,
"warehouse_id": 71,
"estimated_arrival_date": "2022-12-01",
"delivery_option": "postal",
"tracking_code": null,
"po_number": null,
"supplier_name": null,
"status": "shipped",
"barcode": "RS.16",
"restocking_shipment_items": [
{
"id": 18,
"sku_id": 558,
"announced_quantity": 12,
"remarks": null,
"total_cost_in_cents": null
}
]
}
{
"success": false,
"errors": [
"bad request"
]
}
{
"success": false,
"errors": [
"Warehouse can't be blank"
]
}
Update a restocking shipment
Update a restocking shipment
PUT https://app.hive.app/merchant_api/v1/restocking_shipments/{id}/
Replaces the whole resource.
The restocking shipment can be updated only if the status is shipped or created
Path Parameters
| Name | Type | Description |
|---|
| | The (Hive) ID of the restocking shipment |
Request Body
| Name | Type | Description |
|---|
| | An ID that uniquely identifies the wharehouse |
| | The estimated arrival date |
| | The delivery option, must be one of: postal, courier, dropoff, hive_freight |
| | The shipment tracking code |
| | |
| | |
restocking_shipment_items.sku_id* | | |
restocking_shipment_items.announced_quantity* | | |
restocking_shipment_items.remarks | | |
restocking_shipment_items.total_cost_in_cents | | The total cost in cents of the |
{
"id": 16,
"merchant_id": 1,
"warehouse_id": 71,
"estimated_arrival_date": "2022-12-01",
"delivery_option": "postal",
"tracking_code": null,
"po_number": null,
"supplier_name": null,
"status": "shipped",
"barcode": "RS.16",
"restocking_shipment_items": [
{
"id": 18,
"sku_id": 558,
"announced_quantity": 12,
"remarks": null,
"total_cost_in_cents": null
}
]
}
{
"success": false,
"errors": [
"bad request"
]
}
{
"success": false,
"errors": [
"Warehouse can't be blank"
]
}
Cancel a restocking shipment
Cancel a restocking shipment
PUT https://app.hive.app/merchant_api/v1/restocking_shipments/{id}/cancel
The restocking shipment can be canceled only if the status is shipped or created
Query Parameters
| Name | Type | Description |
|---|
| | The (Hive) ID of the restocking shipment |
{
"success": false,
"errors": [
"Cannot cancel a restocking shipment with status arrived"
]
}
