Required scopes:
locations_read
Arguments
Forward pagination cursor — returns items after it. Pass an edges[].cursor or
pageInfo.endCursor from a previous page.
Backward pagination cursor — returns items before it. Pass an edges[].cursor
or pageInfo.startCursor from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.
Which key to sort by (defaults to the first key, newest-first). Combine with
reverse to flip direction.
Reverses the sort direction selected by orderBy (or its default).
Returns
A paginated list of Location items.
The list of edges (each a node plus its pagination cursor).
Opaque cursor for this item; pass to after/before to page from here.
The item at this edge.
The city of the location’s address.
The company name associated with the location.
The country code, e.g. “US”.
When the record was created.
Per-product inventory levels held at this location.Requires: inventory_read
ArgumentsForward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.
Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.
The location’s display name.
The contact phone number for the location.
The postal or ZIP code, e.g. “84101”.
The state or province code, e.g. “UT”.
The first line of the street address.
The second line of the street address.
When the record was last updated.
The nodes in this page, without the edge/cursor wrapper — a convenience over edges.
The city of the location’s address.
The company name associated with the location.
The country code, e.g. “US”.
When the record was created.
Per-product inventory levels held at this location.Requires: inventory_read
ArgumentsForward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.
Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.
The list of edges (each a node plus its pagination cursor).
The nodes in this page, without the edge/cursor wrapper — a convenience over edges.
Pagination metadata for the current page.
The location’s display name.
The contact phone number for the location.
The postal or ZIP code, e.g. “84101”.
The state or province code, e.g. “UT”.
The first line of the street address.
The second line of the street address.
When the record was last updated.
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to after to page forward.
Whether more items exist after this page (drives forward pagination with first/after).
Whether more items exist before this page (drives backward pagination with last/before).
Cursor of the first edge in this page; pass to before to page backward.
Example
