returnableFulfillments

Query returnable fulfillments with cursor paging.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the returnableFulfillments action (under Returnable).
Fill in the fields below, then reference the result from later steps as {{returnablefulfillments.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 ReturnableFulfillments($orderId: ID!, $first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean) {
  returnableFulfillments(
    orderId: $orderId
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
  ) {
    edges {
      cursor
      node {
        fulfillment
        id
      }
    }
    nodes {
      fulfillment {
        createdAt
        deliveredAt
        displayStatus
        estimatedDeliveryAt
        id
        inTransitAt
        legacyResourceId
        location
        name
        order
        originAddress
        requiresShipping
        service
        shippingLabel
        status
        totalQuantity
        updatedAt
      }
      id
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

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

orderIdstringrequired

Order ID that will scope all returnable fulfillments.

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).

reverseboolean

Reverse the order of the underlying list.

json

{
  "orderId": "string",
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false
}

Response

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

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

fulfillmentobject

idobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?