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.

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.