deliveryPromiseParticipants

Query delivery promise participants with cursor paging.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the deliveryPromiseParticipants action (under Delivery).
Fill in the fields below, then reference the result from later steps as {{deliverypromiseparticipants.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 DeliveryPromiseParticipants($ownerIds: [ID!], $brandedPromiseHandle: String!, $first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean) {
  deliveryPromiseParticipants(
    ownerIds: $ownerIds
    brandedPromiseHandle: $brandedPromiseHandle
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
  ) {
    edges {
      cursor
      node {
        id
        owner
        ownerType
      }
    }
    nodes {
      id
      owner
      ownerType
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

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

ownerIdsarray<string>

The product variant ID to filter by.

brandedPromiseHandlestringrequired

The branded promise handle to filter by.

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

{
  "brandedPromiseHandle": "string",
  "ownerIds": [
    "string"
  ],
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false
}

Response

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

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

idobject

ownerobject

ownerTypeobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?