Update Package

patch

https://developer-api.bringg.com/services/cc2cd342/{service_uuid1}/{service_uuid2}

Use this API to update a package and return a formatted label (ZPL file) which you can send to a ZPL-compatible label printer. Read more about the package object.

Response (Output) Params

Parameter	Description
fleet_package_label_id _string	The package's unique barcode ID, which can be included on carrier labels and used to match packages with orders if the main label is lost or if the carrier sends updates using their own barcode.
label_base64 _string	The shipping label, encoded in base64 format.
label_url _string	The URL of the shipping label.

Body Params

int32

required

Bringg's ID for the package. Required when external_id is not included.

description

string

A description of the package.

external_id

string

Your external system's ID for this package. Required if id is null.

external_task_id

string

Your external system's ID for the associated order. Required if task_id is not included.

fleet_external_id

string

Your external system's ID for the carrier assigned to the related order.

height_unit

string

required

The measurement unit for the package height. Possible values: mm, cm, m, km, in, yd, ft-us, ft, mi

height_value

float

required

The package height.

length_unit

string

required

The measurement unit for the package length. Possible values: mm, cm, m, km, in, yd, ft-us, ft, mi

length_value

float

required

The package length.

name

string

The package title.

notes

string

A note related to this package.

sequence_number

int32

When an order contains multiple packages, include a sequence number for each package to quickly identify individual packages.

task_id

int32

Bringg's ID for the associated order. Required if external_task_id is not included.

volume_unit

string

The measurement unit for the package volume. Required if volume_value is included. Possible values: mm3, cm3, ml, cl, dl, l, kl, m3, km3, krm, tsk, msk, kkp, glas, kanna, tsp, Tbs, in3, fl-oz, cup, pnt, qt, gal, ft3, yd3

volume_value

float

The package volume. Required if volume_unit is included.

weight_unit

string

required

The measurement unit for the package weight. Possible values: mcg, mg, g, kg, mt, oz, lb, t

weight_value

float

required

The package weight.

width_unit

string

required

The measurement unit for the package width. Possible values: mm, cm, m, km, in, yd, ft-us, ft, mi

width_value

float

required

The package width.

Responses

200200

400400