input CreateCustomBoxInput

Fields

FieldTypeDescription
nameString!

Human-readable name for this custom box.

barcodeString

Barcode value for the custom box.

warehouse_idString!

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

dimensionsDimensionsInput!

Package or item dimensions. Length, width, and height are in inches unless account or carrier configuration specifies another unit.

on_handInt

The on-hand quantity for the custom box.

priceDecimal

Customer-facing custom box price as a decimal monetary amount.

activeBoolean

Whether the custom box is active.

packaging_typeString

The packaging type for the custom box, for example BOX or MAILER.

Referenced By

Example

{
  "name": "12x10x4 Box",
  "barcode": "012345678905",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "dimensions": {length: 12.5, width: 8.0, height: 4.0},
  "on_hand": 2,
  "price": 19.99,
  "active": true,
  "packaging_type": "BOX"
}