object CustomBox

Fields

Field	Type	Description
`id`	`String`	Public API ID for this identifiable.
`legacy_id`	BigInt	Numeric legacy ID for this identifiable; use only where legacy IDs are required.
`account_id`	`String`	Public API account ID that identifies the related record.
`warehouse_id`	`String`	Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.
`warehouse_identifier`	`String`	Warehouse display identifier, usually Primary or Secondary. Use warehouse_id for the public API warehouse ID.
`barcode`	`String`	Barcode value for the custom box.
`name`	`String`	Human-readable name for this custom box.
`dimensions`	Dimensions	Package or item dimensions. Length, width, and height are in inches unless account or carrier configuration specifies another unit.
`active`	`Boolean`	Whether this custom box is active and available for use.
`on_hand`	`Int`	On hand as a whole-unit count.
`cost`	Decimal	Internal cost as a decimal monetary amount; distinct from customer-facing price.
`packaging_type`	`String`	The packaging type for the custom box, for example BOX or MAILER.
`price`	Decimal	Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value.

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "Q3VzdG9tQm94OjEyMzQ=",
  "warehouse_id": "Q3VzdG9tQm94OjEyMzQ=",
  "warehouse_identifier": "Primary Warehouse",
  "barcode": "012345678905",
  "name": "12x10x4 Box",
  "dimensions": {length: 12.5, width: 8.0, height: 4.0},
  "active": true,
  "on_hand": 2,
  "cost": 19.99,
  "packaging_type": "BOX",
  "price": 19.99
}