Shipments

The Shipment resource

Property	Type	Description
created_at	ISO8601 datetime	When the shipment was created
delivered_at	ISO8601 datetime	When the shipment was delivered
delivery_status	String	Information transmitted to the carrier - the shipment has been marked as shipped by Hive but no further statuses from the carrier yet In transit - the parcel is on the way to the carrier hub Out for delivery - the parcel has left the carrier hub and is in the process of being delivered Delivered - the parcel has been successfully delivered Returned to sender - the carrier initiated a return to the sender Action required - the parcel is going through an unconventional event (e.g. failed delivery attempt, shipment lost, address issues etc.)
id	Integer	The shipment's unique identifier in Hive
items	Array of ShipmentItem objects	Which line items this shipment includes
merchant_order_id	String	Related order's unique identifier provided by merchant
order_id	Integer	Related order's unique identifier in Hive
shipment_provider	String	Name of the shipment provider/carrier
shipped_at	ISO8601 datetime	When the shipment was shipped
status	String	waiting_for_picking - initial status (normally shipment is created with this status during order import) on_hold - shipment is on hold for now, for example because shop is configured to start fulfillment in future or there are some issues (e.g. incorrect address or not enough inventory amount) picking_assigned - fulfillment center employee assigned themselves to pick this shipment's items in_picking - shipment items picking process has been started picked - shipment items have been picked and are ready for packing in_packing - shipment items packing process has been started packed - shipment items have been packed and are ready for shipping in_shipping - shipping process has been started shipped - a shipping label has been created for the shipment and it has left the packing station (and now the shipment is awaiting carrier pickup or is already picked up) cancelled - shipment is cancelled and will not be fulfilled, e.g. because the order was cancelled via Merchant API
tracking_number	String	Tracking number assigned by the shipment provider/carrier
tracking_url	String	Shipment provider website showing tracking information
updated_at	ISO8601 datetime	When the shipment was updated

The ShipmentItem resource

Property	Type	Description
batches	Array of ShipmentItemBatch objects	Which batches were sent for this line item
id	Integer	The shipment item's unique identifier in Hive
merchant_item_id	String	The order line item identifier as provided by the merchant
quantity	Integer	Number of SKUs in this line item
serial_numbers	Array of ShipmentItemSerialNumber objects	Which serial numbers were sent for this line item
sku	A ShipmentItemSku object	SKU identifiers of this line item

The ShipmentItemBatch resource

Property	Type	Description
expiry_date	ISO8601 date	Expiration date of the batch
name	String	Name of the batch
quantity	Integer	Number of items taken from this batch
tracking_code	String	Tracking code of the batch

The ShipmentItemSerialNumber resource

Property	Type	Description
serial_number	String	The serial number

The ShipmentItemSku resource

Property	Type	Description
id	Integer	Hive unique identifier for the SKU
merchant_sku_id	String	SKU identifier as provided by the merchant

List all shipments

Lists all shipments of an order

GET https://app.hive.app/merchant_api/v1/shipments

Returns shipments ordered by descending creation time.

Query Parameters

Name	Type	Description
order_id	Integer	The (Hive) ID of the order
created_at[lt]	ISO8601 datetime	Return results where the created_at field is less than this value.
created_at[lte]	ISO8601 datetime	Return results where the created_at field is less than or equal to this value.
created_at[gt]	ISO8601 datetime	Return results where the created_at field is greater than this value.
created_at[gte]	ISO8601 datetime	Return results where the created_at field is greater than or equal to this value.

200: OK

{
  "data": [
    {
      "created_at": "2022-06-04T03:17:25.533+02:00",
      "delivered_at": "2022-06-06T22:17:46.000+02:00",
      "delivery_status": "Delivered",
      "id": 170,
      "items": [
        {
          "batches": [
            {
              "expiry_date": "2023-06-04T00:00:00.000+02:00",
              "name": "Batch 1",
              "quantity": 1,
              "tracking_code": "ABC123"
            }
          ],
          "id": 201,
          "merchant_item_id": "QWERTY0987",
          "quantity": 1,
          "serial_numbers": [
            {
              "serial_number": "1234567890"
            }
          ],
          "sku": {
            "id": 123000,
            "merchant_sku_id": "ABC123"
          }
        },
        {
          "batches": [],
          "id": 202,
          "merchant_item_id": "QWERTY6543",
          "quantity": 2,
          "serial_numbers": [],
          "sku": {
            "id": 123001,
            "merchant_sku_id": "DEF456"
          }
        }
      ],
      "merchant_order_id": "20220604-383",
      "order_id": 575,
      "shipment_provider": "DHL",
      "shipped_at": "2022-06-04T07:53:20.511+02:00",
      "status": "shipped",
      "tracking_number": "CR123456789DE",
      "tracking_url": "https://www.dhl.de/en/privatkunden/dhl-sendungsverfolgung.html?piececode=CR123456789DE",
      "updated_at": "2022-07-22T16:53:31.388+02:00"
    }
  ],
  "pagination": {
    "current_page": 1,
    "item_count": 2,
    "page_count": 1,
    "items_per_page": 20
  }
}

404: Not Found There was no order matching the given ID

{
  "success": false,
  "errors": [
    "record not found"
  ]
}