Choose a version:

deliveryProfiles

query

Returns a list of saved delivery profiles.

DeliveryProfileConnection arguments

•DeliveryProfileConnection!

after

•String

The elements that come after the specified cursor.

before

•String

The elements that come before the specified cursor.

first

•Int

The first n elements from the paginated list.

last

•Int

The last n elements from the paginated list.

merchantOwnedOnly

•Boolean

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

query

•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 default •boolean: Filter by the delivery profile default status.
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to name •string
Anchor to updated_at •time

reverse

•BooleanDefault:false

Reverse the order of the underlying list.

sortKey

•DeliveryProfileSortKeysDefault:ID

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.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[DeliveryProfileEdge!]!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 •[DeliveryProfile!]!non-null: A list of nodes that are contained in DeliveryProfileEdge. 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?

Receive a list of all ShippingZones

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query DeliveryZoneList {

deliveryProfiles(first: 10) {

edges {

node {

profileLocationGroups {

locationGroup {

}

locationGroupZones(first: 10) {

edges {

node {

zone {

name

countries {

code {

countryCode

restOfWorld

}

provinces {

name

code

}

methodDefinitions(first: 10) {

edges {

node {

active

description

methodConditions {

field

operator

conditionCriteria {

__typename

... on MoneyV2 {

amount

currencyCode

}

... on Weight {

unit

value

}

}`,

);

const data = await response.json();

query DeliveryZoneList {
  deliveryProfiles(first: 10) {
    edges {
      node {
        id
        profileLocationGroups {
          locationGroup {
            id
          }
          locationGroupZones(first: 10) {
            edges {
              node {
                zone {
                  id
                  name
                  countries {
                    code {
                      countryCode
                      restOfWorld
                    }
                    provinces {
                      name
                      code
                    }
                  }
                }
                methodDefinitions(first: 10) {
                  edges {
                    node {
                      id
                      active
                      description
                      methodConditions {
                        field
                        operator
                        conditionCriteria {
                          __typename
                          ... on MoneyV2 {
                            amount
                            currencyCode
                          }
                          ... on Weight {
                            unit
                            value
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

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 DeliveryZoneList { deliveryProfiles(first: 10) { edges { node { id profileLocationGroups { locationGroup { id } locationGroupZones(first: 10) { edges { node { zone { id name countries { code { countryCode restOfWorld } provinces { name code } } } methodDefinitions(first: 10) { edges { node { id active description methodConditions { field operator conditionCriteria { __typename ... on MoneyV2 { amount currencyCode } ... on Weight { unit value } } } } } } } } } } } } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query DeliveryZoneList {
    deliveryProfiles(first: 10) {
      edges {
        node {
          id
          profileLocationGroups {
            locationGroup {
              id
            }
            locationGroupZones(first: 10) {
              edges {
                node {
                  zone {
                    id
                    name
                    countries {
                      code {
                        countryCode
                        restOfWorld
                      }
                      provinces {
                        name
                        code
                      }
                    }
                  }
                  methodDefinitions(first: 10) {
                    edges {
                      node {
                        id
                        active
                        description
                        methodConditions {
                          field
                          operator
                          conditionCriteria {
                            __typename
                            ... on MoneyV2 {
                              amount
                              currencyCode
                            }
                            ... on Weight {
                              unit
                              value
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query DeliveryZoneList {
    deliveryProfiles(first: 10) {
      edges {
        node {
          id
          profileLocationGroups {
            locationGroup {
              id
            }
            locationGroupZones(first: 10) {
              edges {
                node {
                  zone {
                    id
                    name
                    countries {
                      code {
                        countryCode
                        restOfWorld
                      }
                      provinces {
                        name
                        code
                      }
                    }
                  }
                  methodDefinitions(first: 10) {
                    edges {
                      node {
                        id
                        active
                        description
                        methodConditions {
                          field
                          operator
                          conditionCriteria {
                            __typename
                            ... on MoneyV2 {
                              amount
                              currencyCode
                            }
                            ... on Weight {
                              unit
                              value
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }`,
});

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 DeliveryZoneList {
    deliveryProfiles(first: 10) {
      edges {
        node {
          id
          profileLocationGroups {
            locationGroup {
              id
            }
            locationGroupZones(first: 10) {
              edges {
                node {
                  zone {
                    id
                    name
                    countries {
                      code {
                        countryCode
                        restOfWorld
                      }
                      provinces {
                        name
                        code
                      }
                    }
                  }
                  methodDefinitions(first: 10) {
                    edges {
                      node {
                        id
                        active
                        description
                        methodConditions {
                          field
                          operator
                          conditionCriteria {
                            __typename
                            ... on MoneyV2 {
                              amount
                              currencyCode
                            }
                            ... on Weight {
                              unit
                              value
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"deliveryProfiles": {

"edges": [

{

"node": {

"id": "gid://shopify/DeliveryProfile/28404419",

"profileLocationGroups": [

{

"locationGroup": {

"id": "gid://shopify/DeliveryLocationGroup/42565096"

"locationGroupZones": {

"edges": [

{

"node": {

"zone": {

"id": "gid://shopify/DeliveryZone/600655460",

"name": "Ottawa South",

"countries": [

{

"code": {

"countryCode": "CA",

"restOfWorld": false

"provinces": [

{

"name": "Ontario",

"code": "ON"

}

]

}

]

"methodDefinitions": {

"edges": []

}