> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# overboxShipments

> List overbox shipments, newest first, by status, consolidator, or tracking number.

**Required scopes:** [`shipping_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-shipping_read)

## Arguments

**after** `String`

Forward pagination cursor — returns overbox shipments after it.

**before** `String`

Backward pagination cursor — returns overbox shipments before it.

**first** `Int`

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

**last** `Int`

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

**orderBy** `[OverboxShipmentSortKey](/docs/api-reference/v3/reference/shipping/overbox-shipment-sort-key)`

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

**reverse** `Boolean`

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

**service** `[OverboxService](/docs/api-reference/v3/reference/shipping/overbox-service)`

Only overbox shipments to this consolidator.

**status** `[OverboxShipmentStatus](/docs/api-reference/v3/reference/shipping/overbox-shipment-status)`

Only overbox shipments with this status.

**trackingNumber** `String`

Only the overbox with this first-mile tracking number.

## Returns

**overboxShipments** `[OverboxShipmentConnection!](/docs/api-reference/v3/pagination)` *required*

A paginated list of OverboxShipment items.

**fields**

**edges** `[\[OverboxShipmentEdge!\]!](/docs/api-reference/v3/pagination)` *required*

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

**fields**

**cursor** `String!` *required*

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

**node** `[OverboxShipment!](/docs/api-reference/v3/reference/shipping/overbox-shipment)` *required*

The item at this edge.

**fields**

**carrier** `[OverboxCarrier!](/docs/api-reference/v3/reference/shipping/overbox-carrier)` *required*

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

**dimensions** `[Dimensions](/docs/api-reference/v3/reference/catalog/dimensions)`

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

**fulfillmentCenter** `String!` *required*

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

**id** `ID!` *required*

The id of this overbox shipment.

**labelUrl** `String!` *required*

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

**parcels** `[OverboxShipmentParcelConnection!](/docs/api-reference/v3/pagination)` *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`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-shipping_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns parcels after it.

**before** `String`

Backward pagination cursor — returns parcels before it.

**first** `Int`

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

**last** `Int`

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

**purchasedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the overbox label was bought.

**service** `[OverboxService!](/docs/api-reference/v3/reference/shipping/overbox-service)` *required*

The consolidator the overbox ships to.

**status** `[OverboxShipmentStatus!](/docs/api-reference/v3/reference/shipping/overbox-shipment-status)` *required*

Where the overbox label is in its lifecycle.

**trackingNumber** `String!` *required*

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

**trackingStatus** `[OverboxTrackingStatus](/docs/api-reference/v3/reference/shipping/overbox-tracking-status)`

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

**weight** `[Weight](/docs/api-reference/v3/reference/catalog/weight)`

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

**nodes** `[\[OverboxShipment!\]!](/docs/api-reference/v3/reference/shipping/overbox-shipment)` *required*

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

**fields**

**carrier** `[OverboxCarrier!](/docs/api-reference/v3/reference/shipping/overbox-carrier)` *required*

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

**dimensions** `[Dimensions](/docs/api-reference/v3/reference/catalog/dimensions)`

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

**fields**

**height** `Float`

The height, in `unit`.

**length** `Float`

The length, in `unit`.

**unit** `[DimensionUnit!](/docs/api-reference/v3/reference/catalog/dimension-unit)` *required*

The unit all three measurements are expressed in.

**width** `Float`

The width, in `unit`.

**fulfillmentCenter** `String!` *required*

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

**id** `ID!` *required*

The id of this overbox shipment.

**labelUrl** `String!` *required*

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

**parcels** `[OverboxShipmentParcelConnection!](/docs/api-reference/v3/pagination)` *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`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-shipping_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns parcels after it.

**before** `String`

Backward pagination cursor — returns parcels before it.

**first** `Int`

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

**last** `Int`

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

**Fields**

**edges** `[\[OverboxShipmentParcelEdge!\]!](/docs/api-reference/v3/pagination)` *required*

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

**nodes** `[\[OverboxShipmentParcel!\]!](/docs/api-reference/v3/reference/shipping/overbox-shipment-parcel)` *required*

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

**pageInfo** `[PageInfo!](/docs/api-reference/v3/pagination)` *required*

Pagination metadata for the current page.

**purchasedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the overbox label was bought.

**service** `[OverboxService!](/docs/api-reference/v3/reference/shipping/overbox-service)` *required*

The consolidator the overbox ships to.

**status** `[OverboxShipmentStatus!](/docs/api-reference/v3/reference/shipping/overbox-shipment-status)` *required*

Where the overbox label is in its lifecycle.

**trackingNumber** `String!` *required*

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

**trackingStatus** `[OverboxTrackingStatus](/docs/api-reference/v3/reference/shipping/overbox-tracking-status)`

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

**weight** `[Weight](/docs/api-reference/v3/reference/catalog/weight)`

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

**fields**

**unit** `[WeightUnit!](/docs/api-reference/v3/reference/catalog/weight-unit)` *required*

The unit the value is expressed in.

**value** `Float!` *required*

The numeric magnitude of the weight.

**pageInfo** `[PageInfo!](/docs/api-reference/v3/pagination)` *required*

Pagination metadata for the current page.

**fields**

**endCursor** `String`

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

**hasNextPage** `Boolean!` *required*

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

**hasPreviousPage** `Boolean!` *required*

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

**startCursor** `String`

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

## Example

```graphql theme={null}
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 }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.