inventory_read
Arguments
ID!
required
The id of the supplier to fetch.
Returns
A vendor a merchant buys inventory from, with contacts and purchase orders.
Show fields
Show fields
required
String
The ISO 4217 currency code the supplier transacts in.
ID!
required
The id of this supplier.
Int
The supplier’s typical lead time, in days.
String!
required
The supplier’s name.
String
The supplier’s phone number.
[String!]!
required
Product vendor names associated with this supplier.
required
Purchase orders placed with this supplier.Requires:
inventory_readShow fields
Show fields
ArgumentsFields
String
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.String
Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Int
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.required
The list of edges (each a node plus its pagination
cursor).Show fields
Show fields
String!
required
Opaque cursor for this item; pass to
after/before to page from here.required
The item at this edge.
required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
ID!
required
The id of this purchase order.
required
A paginated list of the order’s line items.Requires:
inventory_readShow fields
Show fields
Arguments
String
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.String
Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Int
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.The location the order’s inventory is destined for.Requires:
locations_readString
An internal note on the purchase order.
String!
required
The merchant-facing purchase order number.
String
An external reference for the purchase order.
required
Inbound shipments fulfilling this purchase order.Requires:
inventory_readShow fields
Show fields
Arguments
String
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.String
Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Int
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.required
The current lifecycle status of the purchase order.
The supplier the order was placed with.Requires:
inventory_readString
A note shared with the supplier.
[String!]!
required
Free-form tags applied to the purchase order.
Pagination metadata for the current page.
Show fields
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.String
The supplier’s website URL.
Example
query {
supplier(id: "...") {
createdAt
currency
id
leadTimeDays
name
phone
productVendors
purchaseOrders {
nodes {
closedAt
createdAt
id
note
orderedAt
poNumber
referenceNumber
status
# ...
}
pageInfo {
hasNextPage
endCursor
}
}
# ...
}
}