purchaseOrders

List purchase orders, optionally filtered by supplier or status.

Required scopes: inventory_read

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

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

last · Int

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

orderBy · PurchaseOrderSortKey

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

status · PurchaseOrderStatus

Only return purchase orders with this status.

supplierId · ID

Only return purchase orders for this supplier.

Returns

purchaseOrders · PurchaseOrderConnection! · required

A paginated list of PurchaseOrder items.

Show fields

edges · [PurchaseOrderEdge!]! · required

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

Show fields

cursor · String! · required

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

node · PurchaseOrder! · required

The item at this edge.

Show fields

closedAt · DateTime

When the purchase order was closed.

createdAt · DateTime! · required

When the record was created.

id · ID! · required

The id of this purchase order.

items · PurchaseOrderItemConnection! · required

A paginated list of the order’s line items.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

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

last · Int

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

location · Location

The location the order’s inventory is destined for.

Requires: locations_read

note · String

An internal note on the purchase order.

orderedAt · Date

The date the order was placed with the supplier.

poNumber · String! · required

The merchant-facing purchase order number.

referenceNumber · String

An external reference for the purchase order.

shipments · InboundShipmentConnection! · required

Inbound shipments fulfilling this purchase order.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

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

last · Int

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

status · PurchaseOrderStatus! · required

The current lifecycle status of the purchase order.

supplier · Supplier

The supplier the order was placed with.

Requires: inventory_read

supplierNote · String

A note shared with the supplier.

tags · [String!]! · required

Free-form tags applied to the purchase order.

updatedAt · DateTime! · required

When the record was last updated.

nodes · [PurchaseOrder!]! · required

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

Show fields

closedAt · DateTime

When the purchase order was closed.

createdAt · DateTime! · required

When the record was created.

id · ID! · required

The id of this purchase order.

items · PurchaseOrderItemConnection! · required

A paginated list of the order’s line items.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

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

last · Int

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

Fields

edges · [PurchaseOrderItemEdge!]! · required

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

nodes · [PurchaseOrderItem!]! · required

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

pageInfo · PageInfo! · required

Pagination metadata for the current page.

location · Location

The location the order’s inventory is destined for.

Requires: locations_read

Show fields

city · String

The city of the location’s address.

company · String

The company name associated with the location.

countryCode · String

The country code, e.g. “US”.

createdAt · DateTime! · required

When the record was created.

id · ID! · required

The id of this location.

inventoryLevels · LocationInventoryLevelConnection! · required

Per-product inventory levels held at this location.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

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

last · Int

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

name · String! · required

The location’s display name.

phone · String

The contact phone number for the location.

postalCode · String

The postal or ZIP code, e.g. “84101”.

stateCode · String

The state or province code, e.g. “UT”.

street1 · String

The first line of the street address.

street2 · String

The second line of the street address.

updatedAt · DateTime! · required

When the record was last updated.

note · String

An internal note on the purchase order.

orderedAt · Date

The date the order was placed with the supplier.

poNumber · String! · required

The merchant-facing purchase order number.

referenceNumber · String

An external reference for the purchase order.

shipments · InboundShipmentConnection! · required

Inbound shipments fulfilling this purchase order.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

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

last · Int

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

Fields

edges · [InboundShipmentEdge!]! · required

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

nodes · [InboundShipment!]! · required

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

pageInfo · PageInfo! · required

Pagination metadata for the current page.

status · PurchaseOrderStatus! · required

The current lifecycle status of the purchase order.

supplier · Supplier

The supplier the order was placed with.

Requires: inventory_read

Show fields

contacts · [SupplierContact!]! · required

The contact people at this supplier.

createdAt · DateTime! · required

When the record was created.

currency · String

The ISO 4217 currency code the supplier transacts in.

id · ID! · required

The id of this supplier.

leadTimeDays · Int

The supplier’s typical lead time, in days.

name · String! · required

The supplier’s name.

phone · String

The supplier’s phone number.

productVendors · [String!]! · required

Product vendor names associated with this supplier.

purchaseOrders · PurchaseOrderConnection! · required

Purchase orders placed with this supplier.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

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

last · Int

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

updatedAt · DateTime! · required

When the record was last updated.

website · String

The supplier’s website URL.

supplierNote · String

A note shared with the supplier.

tags · [String!]! · required

Free-form tags applied to the purchase order.

updatedAt · DateTime! · required

When the record was last updated.

pageInfo · PageInfo! · required

Pagination metadata for the current page.

Show 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

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
    }
  }
}