Choose a version:

urlRedirect

query

Returns a UrlRedirect resource by ID.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the UrlRedirect to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to UrlRedirectUrlRedirect

•UrlRedirect

The URL redirect for the online store.

Anchor to idid •ID! non-null: The ID of the URL redirect.
Anchor to pathpath •String! non-null: The old path to be redirected from. When the user visits this path, they will be redirected to the target location.
Anchor to targettarget •String! non-null: The target location where the user will be redirected to.

Was this section helpful?

Examples

Retrieves a single redirect

Query

query UrlRedirect($id: ID!) {
  urlRedirect(id: $id) {
    id
    path
    target
  }
}

Variables

{
  "id": "gid://shopify/UrlRedirect/905192165"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query UrlRedirect($id: ID!) { urlRedirect(id: $id) { id path target } }",
 "variables": {
    "id": "gid://shopify/UrlRedirect/905192165"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query UrlRedirect($id: ID!) {
    urlRedirect(id: $id) {
      id
      path
      target
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/UrlRedirect/905192165"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 UrlRedirect($id: ID!) {
    urlRedirect(id: $id) {
      id
      path
      target
    }
  }
QUERY

variables = {
  "id": "gid://shopify/UrlRedirect/905192165"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query UrlRedirect($id: ID!) {
      urlRedirect(id: $id) {
        id
        path
        target
      }
    }`,
    "variables": {
        "id": "gid://shopify/UrlRedirect/905192165"
    },
  },
});

Response

{
  "urlRedirect": {
    "id": "gid://shopify/UrlRedirect/905192165",
    "path": "/about",
    "target": "/pages/aboutus"
  }
}

Retrieves a single redirect

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

query UrlRedirect($id: ID!) {

urlRedirect(id: $id) {

path

target

}

}`,

{

variables: {

"id": "gid://shopify/UrlRedirect/905192165"

);

const json = await response.json();

return json.data;

}

GQL

query UrlRedirect($id: ID!) {
  urlRedirect(id: $id) {
    id
    path
    target
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query UrlRedirect($id: ID!) { urlRedirect(id: $id) { id path target } }",
 "variables": {
    "id": "gid://shopify/UrlRedirect/905192165"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query UrlRedirect($id: ID!) {
    urlRedirect(id: $id) {
      id
      path
      target
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/UrlRedirect/905192165"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query UrlRedirect($id: ID!) {
      urlRedirect(id: $id) {
        id
        path
        target
      }
    }`,
    "variables": {
        "id": "gid://shopify/UrlRedirect/905192165"
    },
  },
});

Ruby

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 UrlRedirect($id: ID!) {
    urlRedirect(id: $id) {
      id
      path
      target
    }
  }
QUERY

variables = {
  "id": "gid://shopify/UrlRedirect/905192165"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/UrlRedirect/905192165"

}

Response

JSON

{

"urlRedirect": {

"id": "gid://shopify/UrlRedirect/905192165",

"path": "/about",

"target": "/pages/aboutus"

}