Choose a version:

inventoryPurchaseOrders

query

Requires read_inventory_purchase_orders access scope. Also: The user must have permission to view purchase orders. The shop must have access to the physical inventory feature preview.

Returns a paginated list of purchase orders.

Note

This query is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.

Anchor to Arguments

InventoryPurchaseOrderConnection arguments

•InventoryPurchaseOrderConnection!

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 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 id •id: Filter by id range.
Anchor to status •string

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[InventoryPurchaseOrderEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[InventoryPurchaseOrder!]! non-null: A list of nodes that are contained in InventoryPurchaseOrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Examples

Retrieve a list of purchase orders

Description

Retrieve a paginated list of inventory purchase orders. For each order, `destination` is a point-in-time snapshot of the location (with `destination.location` linking to the current live Location), and `origin.supplier` returns the supplier's current live details. This query is part of the [physical inventory feature preview](https://shopify.dev/changelog/physical-inventory-feature-preview).

Query

query InventoryPurchaseOrders {
  inventoryPurchaseOrders(first: 10) {
    edges {
      node {
        id
        name
        status
        referenceName
        currency
        orderedAt
        origin {
          supplier {
            name
          }
        }
        destination {
          name
          location {
            id
            name
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query InventoryPurchaseOrders { inventoryPurchaseOrders(first: 10) { edges { node { id name status referenceName currency orderedAt origin { supplier { name } } destination { name location { id name } } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query InventoryPurchaseOrders {
    inventoryPurchaseOrders(first: 10) {
      edges {
        node {
          id
          name
          status
          referenceName
          currency
          orderedAt
          origin {
            supplier {
              name
            }
          }
          destination {
            name
            location {
              id
              name
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query InventoryPurchaseOrders {
    inventoryPurchaseOrders(first: 10) {
      edges {
        node {
          id
          name
          status
          referenceName
          currency
          orderedAt
          origin {
            supplier {
              name
            }
          }
          destination {
            name
            location {
              id
              name
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query InventoryPurchaseOrders {
    inventoryPurchaseOrders(first: 10) {
      edges {
        node {
          id
          name
          status
          referenceName
          currency
          orderedAt
          origin {
            supplier {
              name
            }
          }
          destination {
            name
            location {
              id
              name
            }
          }
        }
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query InventoryPurchaseOrders {
  inventoryPurchaseOrders(first: 10) {
    edges {
      node {
        id
        name
        status
        referenceName
        currency
        orderedAt
        origin {
          supplier {
            name
          }
        }
        destination {
          name
          location {
            id
            name
          }
        }
      }
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query InventoryPurchaseOrders {
        inventoryPurchaseOrders(first: 10) {
          edges {
            node {
              id
              name
              status
              referenceName
              currency
              orderedAt
              origin {
                supplier {
                  name
                }
              }
              destination {
                name
                location {
                  id
                  name
                }
              }
            }
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "inventoryPurchaseOrders": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/33768857",
          "name": "PO-1007",
          "status": "ORDERED",
          "referenceName": "SNOWDEVIL-ERP-700",
          "currency": "CAD",
          "orderedAt": "2019-08-19T00:00:00Z",
          "origin": {
            "supplier": {
              "name": "Vans"
            }
          },
          "destination": {
            "name": "Shipping Origin",
            "location": {
              "id": "gid://shopify/Location/124656943",
              "name": "Shipping Origin"
            }
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/84602181",
          "name": "PO-1006",
          "status": "ORDERED",
          "referenceName": "SNOWDEVIL-ERP-600",
          "currency": "CAD",
          "orderedAt": "2019-08-19T00:00:00Z",
          "origin": {
            "supplier": {
              "name": "Vans"
            }
          },
          "destination": {
            "name": "Shipping Origin",
            "location": {
              "id": "gid://shopify/Location/124656943",
              "name": "Shipping Origin"
            }
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/364859477",
          "name": "PO-1003",
          "status": "DRAFT",
          "referenceName": "SNOWDEVIL-ERP-300",
          "currency": "CAD",
          "orderedAt": null,
          "origin": {
            "supplier": {
              "name": "Vans"
            }
          },
          "destination": {
            "name": "Ottawa Store",
            "location": {
              "id": "gid://shopify/Location/346779380",
              "name": "Ottawa Store"
            }
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/433489660",
          "name": "PO-1003",
          "status": "ORDERED",
          "referenceName": "SNOWDEVIL-ERP-300",
          "currency": "CAD",
          "orderedAt": "2019-08-19T00:00:00Z",
          "origin": {
            "supplier": {
              "name": "Vans"
            }
          },
          "destination": {
            "name": "Ottawa Store",
            "location": {
              "id": "gid://shopify/Location/346779380",
              "name": "Ottawa Store"
            }
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/601383758",
          "name": "PO-1009",
          "status": "ORDERED",
          "referenceName": "SNOWDEVIL-ERP-800",
          "currency": "CAD",
          "orderedAt": "2019-08-19T00:00:00Z",
          "origin": {
            "supplier": {
              "name": "Vans"
            }
          },
          "destination": {
            "name": "Ottawa Store",
            "location": {
              "id": "gid://shopify/Location/346779380",
              "name": "Ottawa Store"
            }
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/654585014",
          "name": "PO-1004",
          "status": "ORDERED",
          "referenceName": "SNOWDEVIL-ERP-520",
          "currency": "CAD",
          "orderedAt": "2019-08-20T00:00:00Z",
          "origin": {
            "supplier": {
              "name": "Vans"
            }
          },
          "destination": {
            "name": "Ottawa Store",
            "location": {
              "id": "gid://shopify/Location/346779380",
              "name": "Ottawa Store"
            }
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/678439359",
          "name": "PO-1008",
          "status": "ORDERED",
          "referenceName": "SNOWDEVIL-ERP-700",
          "currency": "CAD",
          "orderedAt": "2019-08-19T00:00:00Z",
          "origin": {
            "supplier": {
              "name": "Vans"
            }
          },
          "destination": {
            "name": "Ottawa Store",
            "location": {
              "id": "gid://shopify/Location/346779380",
              "name": "Ottawa Store"
            }
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/709964655",
          "name": "PO-1005",
          "status": "ORDERED",
          "referenceName": "SNOWDEVIL-ERP-520",
          "currency": "CAD",
          "orderedAt": "2019-08-20T00:00:00Z",
          "origin": {
            "supplier": {
              "name": "Vans"
            }
          },
          "destination": {
            "name": "Ottawa Store",
            "location": {
              "id": "gid://shopify/Location/346779380",
              "name": "Ottawa Store"
            }
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/884380239",
          "name": "PO-1001",
          "status": "ORDERED",
          "referenceName": "SNOWDEVIL-ERP-420",
          "currency": "CAD",
          "orderedAt": "2019-08-20T00:00:00Z",
          "origin": {
            "supplier": {
              "name": "Vans"
            }
          },
          "destination": {
            "name": "Ottawa Store",
            "location": {
              "id": "gid://shopify/Location/346779380",
              "name": "Ottawa Store"
            }
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/990182149",
          "name": "PO-1002",
          "status": "DRAFT",
          "referenceName": "SNOWDEVIL-ERP-400",
          "currency": "CAD",
          "orderedAt": null,
          "origin": {
            "supplier": {
              "name": "Vans"
            }
          },
          "destination": {
            "name": "Ottawa Store",
            "location": {
              "id": "gid://shopify/Location/346779380",
              "name": "Ottawa Store"
            }
          }
        }
      }
    ]
  }
}

Retrieve purchase orders filtered by status

Description

Filter inventory purchase orders by `status` with the `query` argument. This example returns only orders whose status is `ORDERED` (use `status:draft` for draft orders, or `status:draft,ordered` for both). This query is part of the [physical inventory feature preview](https://shopify.dev/changelog/physical-inventory-feature-preview).

Query

query InventoryPurchaseOrders {
  inventoryPurchaseOrders(first: 10, query: "status:ordered") {
    edges {
      node {
        id
        name
        status
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query InventoryPurchaseOrders { inventoryPurchaseOrders(first: 10, query: \"status:ordered\") { edges { node { id name status } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query InventoryPurchaseOrders {
    inventoryPurchaseOrders(first: 10, query: "status:ordered") {
      edges {
        node {
          id
          name
          status
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query InventoryPurchaseOrders {
    inventoryPurchaseOrders(first: 10, query: "status:ordered") {
      edges {
        node {
          id
          name
          status
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query InventoryPurchaseOrders {
    inventoryPurchaseOrders(first: 10, query: "status:ordered") {
      edges {
        node {
          id
          name
          status
        }
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query InventoryPurchaseOrders {
  inventoryPurchaseOrders(first: 10, query: "status:ordered") {
    edges {
      node {
        id
        name
        status
      }
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query InventoryPurchaseOrders {
        inventoryPurchaseOrders(first: 10, query: "status:ordered") {
          edges {
            node {
              id
              name
              status
            }
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "inventoryPurchaseOrders": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/33768857",
          "name": "PO-1007",
          "status": "ORDERED"
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/84602181",
          "name": "PO-1006",
          "status": "ORDERED"
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/433489660",
          "name": "PO-1003",
          "status": "ORDERED"
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/601383758",
          "name": "PO-1009",
          "status": "ORDERED"
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/654585014",
          "name": "PO-1004",
          "status": "ORDERED"
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/678439359",
          "name": "PO-1008",
          "status": "ORDERED"
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/709964655",
          "name": "PO-1005",
          "status": "ORDERED"
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryPurchaseOrder/884380239",
          "name": "PO-1001",
          "status": "ORDERED"
        }
      }
    ]
  }
}

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query InventoryPurchaseOrders {

inventoryPurchaseOrders(first: 10) {

edges {

node {

name

status

referenceName

currency

orderedAt

origin {

supplier {

name

}

destination {

name

location {

name

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query InventoryPurchaseOrders {
  inventoryPurchaseOrders(first: 10) {
    edges {
      node {
        id
        name
        status
        referenceName
        currency
        orderedAt
        origin {
          supplier {
            name
          }
        }
        destination {
          name
          location {
            id
            name
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query InventoryPurchaseOrders { inventoryPurchaseOrders(first: 10) { edges { node { id name status referenceName currency orderedAt origin { supplier { name } } destination { name location { id name } } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query InventoryPurchaseOrders {
    inventoryPurchaseOrders(first: 10) {
      edges {
        node {
          id
          name
          status
          referenceName
          currency
          orderedAt
          origin {
            supplier {
              name
            }
          }
          destination {
            name
            location {
              id
              name
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query InventoryPurchaseOrders {
    inventoryPurchaseOrders(first: 10) {
      edges {
        node {
          id
          name
          status
          referenceName
          currency
          orderedAt
          origin {
            supplier {
              name
            }
          }
          destination {
            name
            location {
              id
              name
            }
          }
        }
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query InventoryPurchaseOrders {
    inventoryPurchaseOrders(first: 10) {
      edges {
        node {
          id
          name
          status
          referenceName
          currency
          orderedAt
          origin {
            supplier {
              name
            }
          }
          destination {
            name
            location {
              id
              name
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Shopify CLI

shopify app execute \
--query \
'query InventoryPurchaseOrders {
  inventoryPurchaseOrders(first: 10) {
    edges {
      node {
        id
        name
        status
        referenceName
        currency
        orderedAt
        origin {
          supplier {
            name
          }
        }
        destination {
          name
          location {
            id
            name
          }
        }
      }
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query InventoryPurchaseOrders {
        inventoryPurchaseOrders(first: 10) {
          edges {
            node {
              id
              name
              status
              referenceName
              currency
              orderedAt
              origin {
                supplier {
                  name
                }
              }
              destination {
                name
                location {
                  id
                  name
                }
              }
            }
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

JSON

{

"inventoryPurchaseOrders": {

"edges": [

{

"node": {

"id": "gid://shopify/InventoryPurchaseOrder/33768857",

"name": "PO-1007",

"status": "ORDERED",

"referenceName": "SNOWDEVIL-ERP-700",

"currency": "CAD",

"orderedAt": "2019-08-19T00:00:00Z",

"origin": {

"supplier": {

"name": "Vans"

}

"destination": {

"name": "Shipping Origin",

"location": {

"id": "gid://shopify/Location/124656943",

"name": "Shipping Origin"

}

{

"node": {

"id": "gid://shopify/InventoryPurchaseOrder/84602181",

"name": "PO-1006",

"status": "ORDERED",

"referenceName": "SNOWDEVIL-ERP-600",

"currency": "CAD",

"orderedAt": "2019-08-19T00:00:00Z",

"origin": {

"supplier": {

"name": "Vans"