Skip to main content

ConfigCarriersBox Object

Description​

A named box preset used to pass parcel dimensions to the carrier at label purchase.

Declaration​

type ConfigCarriersBox {
_id: String!
name: String!
length: Float!
width: Float!
height: Float!
unit: String!
maxWeight: Float
weightUnit: String!
}

Fields​

NameTypeDescription
_idString!Internal identifier for the box.
nameString!Display name of the box (e.g. "Shipping box SM").
lengthFloat!Length in the box unit.
widthFloat!Width in the box unit.
heightFloat!Height in the box unit.
unitString!Dimension unit. Valid values are "cm" or "in".
maxWeightFloatMaximum order weight this box can take, in the box weight unit. Null = no limit.
weightUnitString!Weight unit. Valid values are "kg" or "lb".