Inventory
Requires access scope. Also: The user must have permission to view purchase orders. The shop must have access to the physical inventory feature preview.
A purchase order represents an agreement from a merchant to buy goods or services from a supplier. While the agreement is captured on the merchant's side as a purchase order, it’s recorded as a sales order on the supplier side.
This object is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
This object is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note: This object is available only in the unstable API version and to development stores that have enabled the <a href="https://shopify.dev/changelog/physical-inventory-feature-preview">Physical inventory feature preview</a>.
Anchor to FieldsFields
- archivedAt (DateTime)
- currency (CurrencyCode!)
- dateCreated (DateTime!)
- destination (LocationSnapshot)
- id (ID!)
- lineItems (InventoryPurchaseOrderLineItemConnection!)
- name (String!)
- orderedAt (DateTime)
- origin (InventorySupplierSnapshot)
- referenceName (String)
- status (InventoryPurchaseOrderStatus!)
- Anchor to archivedAtarchived•Date
At Time The date and time the purchase order was archived.
- Anchor to currencycurrency•Currency
Code! non-null The currency for the purchase order's cost values. The shop's currency will be used if one isn't provided during creation.
- Anchor to dateCreateddate•Date
Created Time! non-null The date and time the purchase order was placed.
- Anchor to destinationdestination•Location
Snapshot The target containing the destination location of the purchase order.
- •ID!non-null
A globally-unique ID.
- Anchor to lineItemsline•Inventory
Items Purchase Order Line Item Connection! non-null A list of the purchase order's line items.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to lineItemIdline•ID
Item Id ID of the purchase order line item.
- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Purchase
Key Order Line Item Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- Anchor to namename•String!non-null
The name of the purchase order.
- Anchor to orderedAtordered•Date
At Time The date and time the purchase order was confirmed with the supplier.
- Anchor to originorigin•Inventory
Supplier Snapshot The supplier snapshot where the purchase order originates from.
- Anchor to referenceNamereference•String
Name An external reference name for the purchase order.
- Anchor to statusstatus•Inventory
Purchase Order Status! non-null The current status of the inventory purchase order.
Anchor to QueriesQueries
- inventoryPurchaseOrder (InventoryPurchaseOrder)
- inventoryPurchaseOrders (InventoryPurchaseOrderConnection!)
- •query
Returns an
object by ID.NoteThis query is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note:This query is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note: This query is available only in the unstable API version and to development stores that have enabled the <a href="https://shopify.dev/changelog/physical-inventory-feature-preview">Physical inventory feature preview</a>.
- •ID!required
The ID of the inventory purchase order.
Arguments
- •ID!
- •query
Returns a paginated list of purchase orders.
NoteThis query is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note:This query is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note: This query is available only in the unstable API version and to development stores that have enabled the <a href="https://shopify.dev/changelog/physical-inventory-feature-preview">Physical inventory feature preview</a>.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Arguments