inventory_write
Arguments
The allocation to apply.
Show fields
Show fields
ID!
required
The inbound shipment whose items to set.
required
Replaces the order’s current allocations on this shipment. A product left out, or given a quantity of 0, is returned to the order as unallocated. Send an empty list to return all of them.
ID!
required
The purchase order those items are allocated from. A shipment can carry units for more than one order, and only this order’s allocations are changed.
Returns
A shipment of inventory arriving at a location, fulfilling one or more purchase orders.
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
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 shipment line item.
required
How this line item is packed.
The product received on this line item.Requires:
products_readThe purchase order this received item was ordered on, if any.Requires:
inventory_readInt!
required
The quantity expected on this line item.
Int!
required
The quantity received for 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 shipment is arriving at.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
The payment terms agreed for the shipment.
required
Purchase orders this shipment fulfills.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 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.
Example
mutation {
updateInboundShipmentItems(input: { ... }) {
actualArrivalDate
carrier
createdAt
estimatedArrivalDate
freightType
id
items {
nodes {
createdAt
damagedQuantity
id
packingMode
quantity
receivedQuantity
updatedAt
}
pageInfo { hasNextPage endCursor }
}
paymentTerms
# ...
}
}