deliveryProfiles

Returns a paginated list of DeliveryProfile objects for the shop. Delivery profiles group Product and ProductVariant objects that share shipping rates and zones.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the deliveryProfiles action (under Delivery).
Fill in the fields below, then reference the result from later steps as {{deliveryprofiles.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 DeliveryProfiles($merchantOwnedOnly: Boolean, $first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean) {
  deliveryProfiles(
    merchantOwnedOnly: $merchantOwnedOnly
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
  ) {
    edges {
      cursor
      node {
        activeMethodDefinitionsCount
        coversAllItems
        default
        id
        locationsWithoutRatesCount
        name
        originLocationCount
        productVariantsCount
        productVariantsCountV2
        unassignedLocations
        version
        zoneCountryCount
      }
    }
    nodes {
      activeMethodDefinitionsCount
      coversAllItems
      default
      id
      locationsWithoutRatesCount
      name
      originLocationCount
      productVariantsCount {
        count
        precision
      }
      productVariantsCountV2 {
        capped
        count
      }
      unassignedLocations {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      version
      zoneCountryCount
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

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

merchantOwnedOnlyboolean

If `true`, returns only delivery profiles that were created by the merchant.

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

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

Response

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

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

activeMethodDefinitionsCountobject

coversAllItemsobject

defaultobject

idobject

locationsWithoutRatesCountobject

nameobject

originLocationCountobject

productVariantsCountobject

productVariantsCountV2object

unassignedLocationsobject

versionobject

zoneCountryCountobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?