Create a Parcel

post

https://api-sandbox.gophr.com/v2-commercial-api/jobs/{job_id}/deliveries/{delivery_id}/parcels

Creates a parcel for the given delivery. Note that adding parcels to a delivery is not allowed once the job has been confirmed.

Path Params

job_id

string

required

delivery_id

string

required

Body Params

parcel_external_id

string

required

Your own ID. A unique order/reference code for the parcel.

parcel_reference_number

string

length between 1 and 36

Number or text visible for the courier related to the parcel.

parcel_description

string

length between 1 and 36

Description of parcel being delivered.

parcel_insurance_value

number

Value for the insurance, use it only if you need to insure your package.

id_check

integer

enum

Is it required to check the recipient's ID or not.

Allowed:

width

float

required

Width of parcel in centimeters.

length

float

required

Length of parcel in centimeters.

height

float

required

Height of parcel in centimeters.

weight

float

required

Weight of pacel in kilograms.

is_food

integer

enum

If parcel contains food items or not.

Allowed:

is_fragile

integer

enum

If parcel is fragile or not.

Allowed:

is_liquid

integer

enum

If parcel contains liquid or not.

Allowed:

is_not_rotatable

integer

enum

If parcel can be rotated or not.

Allowed:

is_glass

integer

enum

If parcel contains glass items or not.

Allowed:

is_baked

integer

enum

If parcel contains items which are baked or not.

Allowed:

is_flower

integer

enum

If parcel contains flowers or not.

Allowed:

is_alcohol

integer

enum

If parcel contains alcohol or not.

Allowed:

is_beef

integer

enum

If parcel contains beef or not.

Allowed:

is_pork

integer

enum

If parcel contains pork or not.

Allowed:

Responses

200OK

401Example response

403Example response

422Example response