Admin API: retrieve list of available shipping methods

Retired Boards Appdev Functions

Topic summary

Core Issue:
Developers are seeking ways to retrieve available shipping methods via Shopify’s Admin API to display them in third-party apps, similar to the checkout interface. The initial poster successfully obtained names and prices using the admin/api/2024-10/shipping_zones.json endpoint but needs additional details like shipping method IDs and delivery times.

Solutions Discussed:

  • GraphQL Query Approach: One user shared a working GraphQL query using deliveryProfiles that retrieves shipping method definitions including IDs and names (“Standard” and “Express”).
  • Cart API Integration: Another developer working on a shipping discount app explained retrieving delivery options from the Cart GraphQL API, which returns handles and titles but not full method details.
  • Workaround Suggested: Match shipping method names from the Admin API query with handles from the Cart API’s deliveryOptions to filter and display appropriate options to users.

Current Status:
The discussion remains open with partial solutions. Developers can query method names/IDs via GraphQL but face challenges connecting Admin API data with Cart API handles for complete implementation.

Summarized with AI on November 9. AI used: claude-sonnet-4-5-20250929.
1

Is there a way I can get a list of currently available shipping methods so I can display them to the customer inside a 3rd party app? Very similar to what checkout does.

image.png
image.png604×270 6.7 KB

I was only able to get a names and prices so far. I’m using

GET /admin/api/2022-04/shipping_zones.json

endpoint.

image.png
image.png305×162 3.45 KB

I’d love to know is there a way I can also get a shipping time information using Admin API? And what’s the purpose of id property? Can I use it during Order creation (also using Admin API)?

2

Hi. How did it go? Could you find a way?
I’m facing same issue

3

QUERY;

query {
deliveryProfiles(first: 10) {
edges {
node {
profileLocationGroups {
locationGroupZones(first: 5) {
edges {
node {
methodDefinitions(first: 5) {
edges {
node {
id
name
}
}
}
}
}
}
}
}
}
}
}
RESPONSE:

{
“data”: {
“deliveryProfiles”: {
“edges”: [
{
“node”: {
“profileLocationGroups”: [
{
“locationGroupZones”: {
“edges”: [
{
“node”: {
“methodDefinitions”: {
“edges”: [
{
“node”: {
“id”: “gid://shopify/DeliveryMethodDefinition/778642817312”,
“name”: “Standard”
}
},
{
“node”: {
“id”: “gid://shopify/DeliveryMethodDefinition/778642850080”,
“name”: “Express”
}
}
]
}
}
}
]
}
}
]
}
}
]
}
},
“extensions”: {
“cost”: {
“requestedQueryCost”: 442,
“actualQueryCost”: 11,
“throttleStatus”: {
“maximumAvailable”: 1000.0,
“currentlyAvailable”: 989,
“restoreRate”: 50.0
}
}
}
}

1 Like
4

Hi! A question. I’m trying to build a shipping discount app using Shopify functions and shipping discount API. When I query cart graphQL API for delivery methods, I get this response:

{
        "id": "gid://shopify/CartDeliveryGroup/0",        "deliveryOptions": [          {
            "handle": "16c3896838b1c095431f263d073856c9-73a2bf35e295daaa5f6254f4ae9788b8",            "title": "Standard"
          },
          {
            "handle": "16c3896838b1c095431f263d073856c9-aea3f94d72fdf702e20871d1b8918f56",            "title": "Express"
          }
        ],
        "selectedDeliveryOption": {          "handle": "16c3896838b1c095431f263d073856c9-73a2bf35e295daaa5f6254f4ae9788b8",          "title": "Standard"
        }
      }

To apply the discount I use targets.deliveryOptions.handle . But how I can get this deliveryOption handle from the admin API( to surface the available options for user in the UI)?

When I’m executing your query I only get id and name, no handle.

1 Like
5

You can show the names of your shipping methods by using the query above and then pass the names to the function and filter out the handles with the same name.
Like This code:

const selectedShippingOption =
    input?.cart?.deliveryGroups[0]?.selectedDeliveryOption;

  const getPayMethod = input?.paymentMethods.find((method) => method?.name.toLocaleLowerCase().includes("cash on delivery"));

  if (selectedShippingOption?.title?.toLocaleLowerCase().includes("express")) {
    return {
      operations: [
        {
          hide: {
            paymentMethodId: getPayMethod?.id || '',
          }
        }
      ]
    }
  }