inventory_write
Arguments
ID!
required
The id of the purchase order to update.
required
The fields to change on the purchase order.
Show fields
Show fields
Replaces the order’s line items, matched by product. Omit to leave them unchanged. Any product not listed is removed from the order, which fails if that line has received stock. Must not be empty — an order always has at least one item.
Show fields
Show fields
ID!
required
The product being ordered.
Int!
required
How many units to order. Must not be negative.
Total tax for this line. Must use the order’s currency. Defaults to zero.
Cost per unit. Must use the order’s currency. Defaults to zero.
ID
The location the ordered inventory is destined for. Send null to clear.
String
An internal note on the purchase order. Send null to clear.
String
Your own purchase order number. Cannot be cleared.
String
An external reference for the purchase order. Send null to clear.
ID
The supplier the order is placed with. Send null to clear.
String
A note shared with the supplier. Send null to clear.
[String!]
Replaces the order’s tags. Send an empty list to clear them.
Returns
An order placed with a supplier to restock inventory.
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
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
Int!
required
The quantity received damaged for this line item.
ID!
required
The id of this line item.
The product this line item orders.Requires:
products_readInt!
required
The quantity ordered for this line item.
Int!
required
The quantity received so far against this line item.
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.The location the order’s inventory is destined for.Requires:
locations_readShow fields
Show fields
String
The city of the location’s address.
String
The company name associated with the location.
String
The country code, e.g. “US”.
ID!
required
The id of this location.
required
Traceable inventory units at this warehouse.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).required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Per-product inventory levels held at this location.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).required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.String!
required
The location’s display name.
String
The contact phone number for the location.
String
The postal or ZIP code, e.g. “84101”.
String
The state or province code, e.g. “UT”.
required
Bins and other storage locations within this warehouse.Requires:
locations_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).required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.String
The first line of the street address.
String
The second line of the street address.
String
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
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
String
The carrier transporting the shipment.
String
The type of freight used for the shipment.
ID!
required
The id of this inbound shipment.
required
A paginated list of the shipment’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 shipment is arriving at.Requires:
locations_readString
The payment terms agreed for the shipment.
required
Purchase orders this shipment fulfills.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.String
The carrier’s identifier for the shipment.
required
The current status of the shipment.
String
The shipment’s tracking number.
String
A URL to track the shipment.
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.required
The current lifecycle status of the purchase order.
The supplier the order was placed with.Requires:
inventory_readShow 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).required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.String
The supplier’s website URL.
String
A note shared with the supplier.
[String!]!
required
Free-form tags applied to the purchase order.
Example
mutation {
updatePurchaseOrder(id: "...", input: { ... }) {
closedAt
createdAt
id
items {
nodes {
createdAt
damagedQuantity
id
quantity
receivedQuantity
updatedAt
}
pageInfo { hasNextPage endCursor }
}
note
orderedAt
poNumber
referenceNumber
# ...
}
}