overboxShipments

Required scopes: shipping_read

Arguments

String

Forward pagination cursor — returns overbox shipments after it.

String

Backward pagination cursor — returns overbox shipments before it.

Int

Forward pagination: returns the first N overbox shipments (max 100, default 25). Use with after; mutually exclusive with last/before.

Int

Backward pagination: returns the last N overbox shipments (max 100, default 25). Use with before; mutually exclusive with first/after.

OverboxShipmentSortKey

Which key to sort by (defaults to the first key, newest-first). Combine with reverse to flip direction.

Boolean

Reverses the sort direction selected by orderBy (or its default).

OverboxService

Only overbox shipments to this consolidator.

OverboxShipmentStatus

Only overbox shipments with this status.

String

Only the overbox with this first-mile tracking number.

Returns

OverboxShipmentConnection!

required

A paginated list of OverboxShipment items.

Show fields

[OverboxShipmentEdge!]!

required

The list of edges (each a node plus its pagination cursor).

Show fields

String!

required

Opaque cursor for this item; pass to after/before to page from here.

OverboxShipment!

required

The item at this edge.

Show fields

OverboxCarrier!

required

The first-mile carrier the overbox label was bought on.

Dimensions

The outer box’s dimensions, as declared on the label.

String!

required

The consolidator’s induction center the overbox ships to, as configured for your account (e.g. EWR).

ID!

required

The id of this overbox shipment.

String!

required

URL of the printable overbox label, a 4x6 PDF when rendering succeeds and otherwise the carrier’s own label file.

OverboxShipmentParcelConnection!

required

The labeled parcels sealed inside the box: those labeled for this consolidator from the same ship-from location since its previous overbox. Empty for a location’s first overbox.Requires: shipping_read

Show fields

Arguments

String

Forward pagination cursor — returns parcels after it.

String

Backward pagination cursor — returns parcels before it.

Int

Forward pagination: returns the first N parcels (max 100, default 25). Use with after; mutually exclusive with last/before.

Int

Backward pagination: returns the last N parcels (max 100, default 25). Use with before; mutually exclusive with first/after.

DateTime!

required

When the overbox label was bought.

OverboxService!

required

The consolidator the overbox ships to.

OverboxShipmentStatus!

required

Where the overbox label is in its lifecycle.

String!

required

The first-mile carrier’s tracking number for the box.

OverboxTrackingStatus

The first-mile carrier’s latest status for the box. Null until the carrier first scans it.

Weight

The outer box’s weight, as declared on the label.

[OverboxShipment!]!

required

The nodes in this page, without the edge/cursor wrapper — a convenience over edges.

Show fields

OverboxCarrier!

required

The first-mile carrier the overbox label was bought on.

Dimensions

The outer box’s dimensions, as declared on the label.

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 consolidator’s induction center the overbox ships to, as configured for your account (e.g. EWR).

ID!

required

The id of this overbox shipment.

String!

required

URL of the printable overbox label, a 4x6 PDF when rendering succeeds and otherwise the carrier’s own label file.

OverboxShipmentParcelConnection!

required

Show fields

Arguments

String

Forward pagination cursor — returns parcels after it.

String

Backward pagination cursor — returns parcels before it.

Int

Forward pagination: returns the first N parcels (max 100, default 25). Use with after; mutually exclusive with last/before.

Int

Backward pagination: returns the last N parcels (max 100, default 25). Use with before; mutually exclusive with first/after.

Fields

[OverboxShipmentParcelEdge!]!

required

The list of edges (each a node plus its pagination cursor).

[OverboxShipmentParcel!]!

required

The nodes in this page, without the edge/cursor wrapper — a convenience over edges.

PageInfo!

required

Pagination metadata for the current page.

DateTime!

required

When the overbox label was bought.

OverboxService!

required

The consolidator the overbox ships to.

OverboxShipmentStatus!

required

Where the overbox label is in its lifecycle.

String!

required

The first-mile carrier’s tracking number for the box.

OverboxTrackingStatus

The first-mile carrier’s latest status for the box. Null until the carrier first scans it.

Weight

The outer box’s weight, as declared on the label.

Show fields

WeightUnit!

required

The unit the value is expressed in.

Float!

required

The numeric magnitude of the weight.

PageInfo!

required

Pagination metadata for the current page.

Show fields

String

Cursor of the last edge in this page; pass to after to page forward.

Boolean!

required

Whether more items exist after this page (drives forward pagination with first/after).

Boolean!

required

Whether more items exist before this page (drives backward pagination with last/before).

String

Cursor of the first edge in this page; pass to before to page backward.

Example

query {
  overboxShipments(after: "...", before: "...", first: 10, last: 10, orderBy: PURCHASED_AT, reverse: true, service: APC, status: LABEL_PURCHASED, trackingNumber: "...") {
    nodes {
      carrier
      fulfillmentCenter
      id
      labelUrl
      purchasedAt
      service
      status
      trackingNumber
      # ...
    }
    pageInfo { hasNextPage endCursor }
  }
}

Getting Started

Guides

Reference

overboxShipments

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example