object CarrierBox

Fields

Field	Type	Description
`account_id`	`String`	Public API account ID that identifies the related record.
`box_code`	`String`	Carrier box code used to identify this package type.
`warehouse_identifier`	`String`	Warehouse display identifier, usually Primary or Secondary. Use warehouse_id for the public API warehouse ID.
`warehouse_id`	`String`	Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.
`on_hand`	`Int`	On hand as a whole-unit count.
`active`	`Boolean`	Whether this carrier box is active and available for use.
`price`	Decimal	Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value.
`carrier`	`String`	Carrier name or carrier code used for shipping.
`carrier_code`	`String`	Carrier code for this carrier box.
`name`	`String`	Human-readable name for this carrier box.
`area`	Decimal	Monetary amount as a decimal value in the record currency; not cents.
`dimensions`	Dimensions	Package or item dimensions. Length, width, and height are in inches unless account or carrier configuration specifies another unit.
`international`	`Boolean`	Whether this carrier box supports international shipments.
`barcode`	`String`	Barcode value for the carrier box.

Referenced By

Example

{
  "account_id": "Q2FycmllckJveDoxMjM0",
  "box_code": "STANDARD",
  "warehouse_identifier": "Primary Warehouse",
  "warehouse_id": "Q2FycmllckJveDoxMjM0",
  "on_hand": 2,
  "active": true,
  "price": 19.99,
  "carrier": "ups",
  "carrier_code": "ups",
  "name": "UPS Medium Box",
  "area": 96.0,
  "dimensions": {length: 12.5, width: 8.0, height: 4.0},
  "international": true,
  "barcode": "012345678905"
}