inventoryShipments

Returns a paginated list of InventoryShipment objects. Supports filtering by barcode (e.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the inventoryShipments action (under Inventory).
Fill in the fields below, then reference the result from later steps as {{inventoryshipments.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query InventoryShipments($first: Int, $after: String, $last: Int, $before: String, $sortKey: InventoryShipmentSortKeys, $query: String) {
  inventoryShipments(
    first: $first
    after: $after
    last: $last
    before: $before
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        barcode
        dateCreated
        dateReceived
        dateShipped
        id
        lineItemTotalQuantity
        name
        status
        totalAcceptedQuantity
        totalReceivedQuantity
        totalRejectedQuantity
        tracking
      }
    }
    nodes {
      barcode
      dateCreated
      dateReceived
      dateShipped
      id
      lineItemTotalQuantity
      name
      status
      totalAcceptedQuantity
      totalReceivedQuantity
      totalRejectedQuantity
      tracking {
        arrivesAt
        company
        trackingNumber
        trackingUrl
      }
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

sortKeystring

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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofIDSTATUS

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | barcode | string | | destination_id | id | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | status | string | | tracking_number | string | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "sortKey": "ID",
  "query": "string"
}

Response

Read the result with {{inventoryshipments.response.data.data.inventoryShipments}}. If the API returns errors, the step fails and they are at {{inventoryshipments.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

barcodeobject

dateCreatedobject

dateReceivedobject

dateShippedobject

idobject

lineItemTotalQuantityobject

nameobject

statusobject

totalAcceptedQuantityobject

totalReceivedQuantityobject

totalRejectedQuantityobject

trackingobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?