Upsert Package

post

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

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

<details>
  <summary className="APISectionHeader-heading4MUMLbp4_nLs">Response (Output) Params</summary>
  <ROADObjectPackageResponse />
</details>

Body Params

int32

required

Bringg's ID for the package. Required when external_id is not included. When creating a new package, this should be null.

description

string

A description of the package.

external_id

string

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

fleet_external_id

string

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

external_task_id

string

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

height_value

float

required

The package height.

height_unit

string

required

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

length_value

float

required

The package length.

length_unit

string

required

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

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

Language

Loading…

Response

Choose an example:

application/json

200200

400400