> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# updatePurchaseOrder
> Update a purchase order. Returns null if no purchase order with that id is owned by the caller. Changing `items` re-syncs the order's inbound shipments: on an order with exactly one shipment the lines mirror through, and on one with several new lines are left unassigned. Throws a 409 CONFLICT error (with an extension code of PURCHASE_ORDER_NOT_EDITABLE, PURCHASE_ORDER_ITEM_HAS_RECEIPTS, or PURCHASE_ORDER_NUMBER_TAKEN) if the change conflicts with the order's current state.
**Required scopes:** [`inventory_write`](/docs/api-reference/v3/reference/scopes#scope-inventory_write)
## Arguments
The id of the purchase order to update.
UpdatePurchaseOrderInput!} required>
The fields to change on the purchase order.
[UpdatePurchaseOrderItemInput!]}>
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.
The product being ordered.
How many units to order. Must not be negative.
MoneyInput}>
Total tax for this line. Must use the order's currency. Defaults to zero.
MoneyInput}>
Cost per unit. Must use the order's currency. Defaults to zero.
The location the ordered inventory is destined for. Send null to clear.
An internal note on the purchase order. Send null to clear.
Date}>
The date the order was placed with the supplier. Send null to clear.
Your own purchase order number. Cannot be cleared.
An external reference for the purchase order. Send null to clear.
The supplier the order is placed with. Send null to clear.
A note shared with the supplier. Send null to clear.
Replaces the order's tags. Send an empty list to clear them.
## Returns
PurchaseOrder}>
An order placed with a supplier to restock inventory.
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`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
PurchaseOrderItem!} required>
The item at this edge.
[PurchaseOrderItem!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
DateTime!} required>
When the record was created.
The quantity received damaged for this line item.
The id of this line item.
Product}>
The product this line item orders.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
The quantity ordered for this line item.
The quantity received so far against this line item.
Money}>
The total tax charged on this line item.
Money}>
The cost per unit for this line item.
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.
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.
InventoryItemConnection!} required>
Traceable inventory units at this warehouse.
**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**
[InventoryItemEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[InventoryItem!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
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`.
**Fields**
[LocationInventoryLevelEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[LocationInventoryLevel!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
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".
StorageLocationConnection!} required>
Bins and other storage locations within this warehouse.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_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**
[StorageLocationEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[StorageLocation!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
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`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
InboundShipment!} required>
The item at this edge.
[InboundShipment!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
Date}>
The date the shipment actually arrived.
The carrier transporting the shipment.
DateTime!} required>
When the record was created.
Money}>
The duty cost incurred for the shipment.
Date}>
The estimated date the shipment will arrive.
Money}>
The cost of freight for the shipment.
The type of freight used for the shipment.
The id of this inbound shipment.
InboundShipmentItemConnection!} required>
A paginated list of the shipment'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 shipment is arriving at.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
The payment terms agreed for the shipment.
PurchaseOrderConnection!} required>
Purchase orders this shipment fulfills.
**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 carrier's identifier for the shipment.
InboundShipmentStatus!} required>
The current status of the shipment.
The shipment's tracking number.
A URL to track the shipment.
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.
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 contact's email address.
The id of this contact.
The contact's name.
The contact's phone number.
DateTime!} required>
When the record was last updated.
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`.
**Fields**
[PurchaseOrderEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[PurchaseOrder!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
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.
## Example
```graphql theme={null}
mutation {
updatePurchaseOrder(id: "...", input: { ... }) {
closedAt
createdAt
id
items {
nodes {
createdAt
damagedQuantity
id
quantity
receivedQuantity
updatedAt
}
pageInfo { hasNextPage endCursor }
}
note
orderedAt
poNumber
referenceNumber
# ...
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.