carton

Required scopes: inventory_read Store must have one of: WMS

Arguments

ID!

required

The opaque carton ID.

Returns

Carton

An identified physical box operated by the authenticated warehouse. It can exist before assignment to a shipment.

Show fields

[DocumentOption!]!

required

Documents supported by the carton’s current shipment association. An unassigned carton has none.

Show fields

[DocumentFormat!]!

required

Its supported representations.

DocumentKind!

required

The available document.

Int!

required

The carton’s numeric display reference. Use id for identity.

Dimensions

Measured carton dimensions.

Show fields

Float

The height, in unit.

Float

The length, in unit.

DimensionUnit!

required

The unit all three measurements are expressed in.

Float

The width, in unit.

String!

required

The saved display label, falling back to its numeric reference.

ID!

required

The permanent opaque carton ID.

Weight

Measured carton weight.

Show fields

WeightUnit!

required

The unit the value is expressed in.

Float!

required

The numeric magnitude of the weight.

Example

query {
  carton(id: "...") {
    cartonNumber
    displayIdentifier
    id
  }
}

Getting Started

Guides

Reference

Arguments

Returns

Example