Restocking Shipments

The RestockingShipment resource

Property	Type	Description
barcode	String (read-only)	The barcode of the shipment
delivery_option*	String	One of the following: postal, courier, dropoff, hive_freight
estimated_arrival_date*	ISO8601 date	Estimated arrival date
id	Integer (read-only)	Hive's unique identifier
po_number	String	Purchase order number
restocking_shipment_items	An array of RestockingShipmentItem objects	A list of items in the shipment
status	String (read-only)	Possible values: 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
supplier_name	String	Supplier name
tracking_code	String	Shipment tracking code
warehouse_id*	Integer	The ID of the Hive destination warehouse

The RestockingShipmentItem resource

Property	Type	Description
announced_quantity	Integer	Quantity of this item in the shipment
arrived_quantity	Integer (read-only)	Arrived quantity of this item (after shipment is received)
damaged_quantity	Integer (read-only)	Damaged quantity of this item (after shipment is received)
id	Integer (read-only)	Hive's unique identifier
inventory_batches	A RestockingShipmentInventoryBatch object	Batches of this item included in the shipment
missing_quantity	Integer (read-only)	Missing quantity of this item (after shipment is received)
remarks	String	Free text for remarks
sku_id*	Integer	Hive SKU identifier
total_cost_in_cents	Integer	Cost in cents

The RestockingShipmentInventoryBatch resource

Property	Type	Description
arrived_quantity	Integer (read-only)	Arrived quantity of this batch (after shipment is received)
expiry_date	ISO8601 date (read-only)	Expiration date of the batch
id	Integer (read-only)	Hive's unique identifier
name	String (read-only)	Batch name
tracking_code	String (read-only)	Batch tracking code

*Required properties when creating a new record.

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.

200: OK

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
id*	String	The (Hive) ID of the restocking shipment

200: OK

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

404: Not Found There was no restocking shipment matching the given ID

{
  "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
warehouse_id*	Integer	An ID that uniquely identifies the warehouse
estimated_arrival_date*	ISO8601 datetime	The estimated arrival date
delivery_option*	String	The delivery option, must be one of: postal, courier, dropoff, hive_freight
tracking_code	String	The shipment tracking code
po_number	String	The po number
supplier_name	String	The supplier name
restocking_shipment_items.sku_id*	Integer	The (Hive) ID of the sku
restocking_shipment_items.announced_quantity*	Integer	The sku quantity
restocking_shipment_items.remarks	String	The remarks
restocking_shipment_items.total_cost_in_cents	Integer	The total cost in cents of the

201: Created The restocking shipment was created successfully

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

400: Bad Request The request was malformed

{
  "success": false,
  "errors": [
    "bad request"
  ]
}

422: Unprocessable Entity The data was invalid

{
    "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
id*	Integer	The (Hive) ID of the restocking shipment

Request Body

Name	Type	Description
warehouse_id*	Integer	An ID that uniquely identifies the wharehouse
estimated_arrival_date*	ISO8601 datetime	The estimated arrival date
delivery_option*	String	The delivery option, must be one of: postal, courier, dropoff, hive_freight
tracking_code	String	The shipment tracking code
po_number	String	The po number
supplier_name	String	The supplier name
restocking_shipment_items.sku_id*	Integer	The (Hive) ID of the sku
restocking_shipment_items.announced_quantity*	Integer	The sku quantity
restocking_shipment_items.remarks	String	The remarks
restocking_shipment_items.total_cost_in_cents	Integer	The total cost in cents of the

200: OK The restocking shipment was updated successfully

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

400: Bad Request The request was malformed

{
  "success": false,
  "errors": [
    "bad request"
  ]
}

422: Unprocessable Entity The data was invalid

{
    "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
id*	Integer	The (Hive) ID of the restocking shipment

200: OK The restocking shipment was canceled successfully

422: Unprocessable Entity The data was invalid

{
    "success": false,
    "errors": [
        "Cannot cancel a restocking shipment with status arrived"
    ]
}