Skip to main content
Anchor to inventoryPurchaseOrder

inventoryPurchaseOrder

query

Requires read_inventory_purchase_orders access scope. Also: The user must have permission to view purchase orders.

Returns an InventoryPurchaseOrder object by ID.

Anchor to Arguments

Arguments

Anchor to idid
•ID!
required

The ID of the inventory purchase order.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to InventoryPurchaseOrderInventoryPurchaseOrder
•InventoryPurchaseOrder

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.

Show fields
Anchor to archivedAtarchivedAt
•DateTime

The date and time the purchase order was archived.

Anchor to currencycurrency
•CurrencyCode!
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.

Show enum values
Anchor to dateCreateddateCreated
•DateTime!
non-null

The date and time the purchase order was placed.

Anchor to destinationdestination
•LocationSnapshot

The target containing the destination location of the purchase order.

Show fields
Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to lineItemslineItems
•InventoryPurchaseOrderLineItemConnection!
non-null

A list of the purchase order's line items.

Show fields

Arguments

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 n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to lineItemIdlineItemId
•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.

Show filters
Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to incoming_quantity
•integer
Anchor to supplier_sku
•string
Anchor to title
•string
Anchor to unit_cost
•float
Anchor to variant_id
•id
Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•PurchaseOrderLineItemSortKeys
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.

Show enum values
Anchor to namename
•String!
non-null

The name of the purchase order.

Anchor to orderedAtorderedAt
•DateTime

The date and time the purchase order was confirmed with the supplier.

Anchor to originorigin
•InventorySupplierSnapshot

The supplier snapshot where the purchase order originates from.

Show fields
Anchor to statusstatus
•InventoryPurchaseOrderStatus!
non-null

The current status of the inventory purchase order.

Show enum values
Anchor to transferstransfers
•InventoryTransferConnection!
non-null

The inventory transfers linked to this purchase order.

Show fields

Arguments

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 n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Was this section helpful?