Shipments

The Shipment resource

Properties

id - the shipment's unique identifier in Hive system

delivery_status - the shipment's status on Hive side in terms of delivery. Possible values:

Delivery status options

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.)

merchant_order_id - related order's unique identifier provided by merchant

order_id - related order's unique identifier in Hive system

status - the shipment's status on Hive side in terms of fulfillment. Possible values:

Status options

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

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. Responses 200: OK

200: OK

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

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

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