trackers

Required scopes: orders_read

Arguments

String

Forward pagination cursor — returns trackers after it.

String

Backward pagination cursor — returns trackers before it.

DateTime

Only return trackers created at or after this ISO-8601 instant.

DateTime

Only return trackers created at or before this ISO-8601 instant.

Int

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

Int

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

TrackerSortKey

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).

TrackerStatus

Only return trackers with this status. UNKNOWN also matches trackers whose stored status Redo does not recognize.

String

Only return trackers with this carrier tracking number.

DateTime

Only return trackers updated at or after this ISO-8601 instant.

DateTime

Only return trackers updated at or before this ISO-8601 instant.

Returns

TrackerConnection!

required

A paginated list of Tracker items.

Show fields

[TrackerEdge!]!

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.

Tracker!

required

The item at this edge.

Show fields

String

The carrier transporting the shipment, if known.

String

The carrier service level, if known.

DateTime!

required

When the tracker was created.

DateTime

When the shipment was delivered, if it has been.

DateTime

The carrier’s estimated delivery time, if known.

ID!

required

The id of this tracker.

TrackerOrderConnection!

required

The orders fulfilled by this shipment.Requires: orders_read

Show fields

Arguments

String

Forward pagination cursor.

String

Backward pagination cursor.

Int

Forward pagination: returns the first N orders (max 100, default 25).

Int

Backward pagination: returns the last N orders (max 100, default 25).

TrackerScanConnection!

required

The tracker’s carrier scan history, newest first.Requires: orders_read

Show fields

Arguments

String

Forward pagination cursor — returns scans after it.

String

Backward pagination cursor — returns scans before it.

Int

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

Int

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

TrackerStatus!

required

The current carrier-tracked delivery status.

String

The carrier tracking number, if known.

String

A public URL to track the shipment, if known.

DateTime!

required

When the tracker was last updated.

[Tracker!]!

required

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

Show fields

String

The carrier transporting the shipment, if known.

String

The carrier service level, if known.

DateTime!

required

When the tracker was created.

DateTime

When the shipment was delivered, if it has been.

DateTime

The carrier’s estimated delivery time, if known.

ID!

required

The id of this tracker.

TrackerOrderConnection!

required

The orders fulfilled by this shipment.Requires: orders_read

Show fields

Arguments

String

Forward pagination cursor.

String

Backward pagination cursor.

Int

Forward pagination: returns the first N orders (max 100, default 25).

Int

Backward pagination: returns the last N orders (max 100, default 25).

Fields

[TrackerOrderEdge!]!

required

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

[TrackerOrder!]!

required

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

PageInfo!

required

Pagination metadata for the current page.

TrackerScanConnection!

required

The tracker’s carrier scan history, newest first.Requires: orders_read

Show fields

Arguments

String

Forward pagination cursor — returns scans after it.

String

Backward pagination cursor — returns scans before it.

Int

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

Int

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

Fields

[TrackerScanEdge!]!

required

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

[TrackerScan!]!

required

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

PageInfo!

required

Pagination metadata for the current page.

TrackerStatus!

required

The current carrier-tracked delivery status.

String

The carrier tracking number, if known.

String

A public URL to track the shipment, if known.

DateTime!

required

When the tracker was last updated.

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 {
  trackers(after: "...", before: "...", createdAtAfter: "...", createdAtBefore: "...", first: 10, last: 10, orderBy: CREATED_AT, reverse: true, status: AVAILABLE_FOR_PICKUP, trackingNumber: "...", updatedAtAfter: "...", updatedAtBefore: "...") {
    nodes {
      carrier
      carrierService
      createdAt
      deliveredAt
      estimatedDeliveryAt
      id
      status
      trackingNumber
      # ...
    }
    pageInfo { hasNextPage endCursor }
  }
}

Getting Started

Guides

Reference

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example