API Reference
Start typing to search…

Package Object

The package object is included in the Create Package and Update Package requests and returned as part of some webhook callbacks.

About Packages

Send the create, update, or upsert package requests to send Bringg details about the dimensions of packages included in an order. In the API response, Bringg provides a label that you can print and attach to the package.

The label is provided as a link to a ZPL file and a ZPL file encoded in base64 format.

Package Details

Below is a list of parameters you can send to Bringg as part of the package object, for example, when sending the Create Package request.

Read our Data Formatting article for more details about how different parameter types, such as datetime, are formatted and used in Bringg.

Parameter

Description

Validations and Notes

  • *description**
    string

A description of the package.

For example, a detailed description of the package contents.

  • *external_id**
    string

Your external system's ID for this package.

Required if id is not included.

  • *external_task_id**
    string

Your external system's ID for the associated order.

Required if task_id is not included.

  • *extras**
    json

Custom attributes associated with this package.

JSON format of field and value. For example:
{"field":"value"}

  • *fleet_external_id**
    string

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

  • *height_unit**
    string

The measurement unit for the package height.

Required.
Possible values: mm, cm, m, km, in, yd, ft-us, ft, mi

  • *height_value**
    float

The package height.

Required.

  • *id**
    int32

Bringg's ID for the package.

Required if external_id is not included. When creating a new package, this should be null.

  • *length_unit**
    string

The measurement unit for the package length.

Required.
Possible values: mm, cm, m, km, in, yd, ft-us, ft, mi

  • *length_value**
    float

The package length.

Required.

  • *name**
    string

The package title.

For example, a short description of what is included in the package.

  • *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 value_unit is included.

  • *weight_unit**
    string

The measurement unit for the package weight.

Required.
Possible values: mcg, mg, g, kg, mt, oz, lb, t

  • *weight_value**
    float

The measurement unit for the package weight.

Required.

  • *width_unit**
    string

The measurement unit for the package width.

Required.
Possible values: mm, cm, m, km, in, yd, ft-us, ft, mi

  • *width_value**
    float

The package width.

Required.

Response & Webhook Data

Below is a list of the data returned in webhooks and responses to your API requests. The inclusion of specific parameters may depend on your use case, your API request, and the webhook fields you have subscribed to.