GuidesAPI Reference
Log In
API Reference

Create Package

Use this API to create 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.

Body Params
string
required

Your external system's ID for this package.

string

A description of the package.

string
required

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

string

Your external system's ID for the carrier assigned with the package.

string
required

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

float
required

The package height.

string
required

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

float
required

The package length.

string

The package title.

string

A note related to this package.

int32

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

int32

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

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

float

The package volume. Required if volume_unit is included.

string
required

The measurement unit for the package weight. Possible values:

float
required

Required if present "weight_unit"

string
required

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

float
required

The package weight.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json