> ## Documentation Index
> Fetch the complete documentation index at: https://redo-44af351d-docs-v3-graphql-api-reference.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# purchaseOrders
> List purchase orders, optionally filtered by supplier or status.
**Required scopes:**
[`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_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`.
PurchaseOrderSortKey}>
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).
PurchaseOrderStatus}>
Only return purchase orders with this status.
Only return purchase orders for this supplier.
## Returns
PurchaseOrderConnection!} required>
A paginated list of PurchaseOrder items.
[PurchaseOrderEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
PurchaseOrder!} required>
The item at this edge.
DateTime}>
When the purchase order was closed.
DateTime!} required>
When the record was created.
The id of this purchase order.
PurchaseOrderItemConnection!} required>
A paginated list of the order's line items.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_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`.
Location}>
The location the order's inventory is destined for.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
An internal note on the purchase order.
Date}>
The date the order was placed with the supplier.
The merchant-facing purchase order number.
An external reference for the purchase order.
InboundShipmentConnection!} required>
Inbound shipments fulfilling this purchase order.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_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`.
PurchaseOrderStatus!} required>
The current lifecycle status of the purchase order.
Supplier}>
The supplier the order was placed with.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
A note shared with the supplier.
Free-form tags applied to the purchase order.
DateTime!} required>
When the record was last updated.
[PurchaseOrder!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
DateTime}>
When the purchase order was closed.
DateTime!} required>
When the record was created.
The id of this purchase order.
PurchaseOrderItemConnection!} required>
A paginated list of the order's line items.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_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`.
**Fields**
[PurchaseOrderItemEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[PurchaseOrderItem!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
Location}>
The location the order's inventory is destined for.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
The city of the location's address.
The company name associated with the location.
The country code, e.g. "US".
DateTime!} required>
When the record was created.
The id of this location.
LocationInventoryLevelConnection!} required>
Per-product inventory levels held at this location.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_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`.
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.
DateTime!} required>
When the record was last updated.
An internal note on the purchase order.
Date}>
The date the order was placed with the supplier.
The merchant-facing purchase order number.
An external reference for the purchase order.
InboundShipmentConnection!} required>
Inbound shipments fulfilling this purchase order.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_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`.
**Fields**
[InboundShipmentEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[InboundShipment!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
PurchaseOrderStatus!} required>
The current lifecycle status of the purchase order.
Supplier}>
The supplier the order was placed with.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
[SupplierContact!]!} required>
The contact people at this supplier.
DateTime!} required>
When the record was created.
The ISO 4217 currency code the supplier transacts in.
The id of this supplier.
The supplier's typical lead time, in days.
The supplier's name.
The supplier's phone number.
Product vendor names associated with this supplier.
PurchaseOrderConnection!} required>
Purchase orders placed with this supplier.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_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`.
DateTime!} required>
When the record was last updated.
The supplier's website URL.
A note shared with the supplier.
Free-form tags applied to the purchase order.
DateTime!} required>
When the record was last updated.
PageInfo!} required>
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
```graphql theme={null}
query {
purchaseOrders(
after: "..."
before: "..."
first: 10
last: 10
orderBy: CREATED_AT
reverse: true
status: CANCELLED
supplierId: "..."
) {
nodes {
closedAt
createdAt
id
note
orderedAt
poNumber
referenceNumber
status
# ...
}
pageInfo {
hasNextPage
endCursor
}
}
}
```