Parcels
IMPORTANT - You can only add, update and delete parcels for adraft job.
Parcels represent the individual packages within a delivery. A parcel belongs to a delivery and deliveries can have many parcels. Parcels contain the following data:
- Details of the parcel contents.
- Parcel size and weight.
- Parcel value (used for insurance purposes).
- External reference numbers associated with the parcel.
- Whether the parcel requires an age check to be performed.
When creating a job, the parcel_external_id field is used to match pickups with deliveries. For this reason, the parcel_external_id field must be unique within a job.
Parcel Insurance
You can add insurance for a parcel by passing the parcel_insurance_value field. The pricing for parcel insurance is as below:
| Parcel Insurance Value Sent to API (£) | Cost (£) |
|---|---|
| 0.00 - 100 | 0.00 |
| 100.01 - 1000 | 2.00 |
| 1000.01 - 2000 | 5.00 |
| 2000.01 - 3000 | 5.00 |
| 3000.01 - 4000 | 5.00 |
| 4000.01 - 5000 | 5.00 |
| 5000.01 - 6000 | 10.00 |
| 6000.01 - 7000 | 35.00 |
| 7000.01 - 8000 | 40.00 |
| 8000.01 - 9000 | 45.00 |
| 9000.01 - 10000 | 50.00 |
Parcel Tags
Tags allow you to specify special handling requirements or contents information for each parcel.
All tag fields are optional boolean values (1 or 0).
Available Tags
| Field | Description |
|---|---|
is_food | Parcel contains hot food |
is_fragile | Parcel contains fragile items requiring careful handling |
is_liquid | Parcel contains liquids |
is_glass | Parcel contains glass items |
is_baked | Parcel contains baked goods |
is_flower | Parcel contains flowers |
is_alcohol | Parcel contains alcoholic beverages (may require age verification) |
is_beef | Parcel contains beef products |
is_pork | Parcel contains pork products |
is_not_rotatable | Parcel must remain upright and cannot be tilted during transport |
Example Request
{
"parcel_external_id": "PARCEL-001",
"width": 20,
"length": 30,
"height": 15,
"weight": 2.5,
"parcel_description": "Birthday cake",
"is_food": 1,
"is_fragile": 1,
"is_not_rotatable": 1
} Courier Matching
Tags help Gophr match your delivery with appropriate couriers. Parcels tagged with is_beef or is_pork will only be
assigned to couriers who have indicated they can carry these items.
Note: To require age verification at delivery, use the
id_checkfield on the parcel - this is separate from the
is_alcoholtag.
Tags Do Not Override Vehicle Selection
Tags are informational and do not automatically restrict vehicle types. The system will honour the vehicle type you request at booking, regardless of the tags set.
Notes
- Tags are set per-parcel, not per-job. Different parcels within the same job can have different tags.
- If no tags are specified, the parcel is treated as a standard item with no special handling requirements.
Updated 16 days ago
