Choose a version:

urlRedirect

query

Returns a redirect resource by ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

UrlRedirect

•

UrlRedirect

The URL redirect for the online store.

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

Was this section helpful?

Retrieves a single redirect

Open in GraphiQL

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 data = await response.json();

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

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 UrlRedirect($id: ID!) { urlRedirect(id: $id) { id path target } }",
 "variables": {
    "id": "gid://shopify/UrlRedirect/905192165"
  }
}'

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 data = await response.json();

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"
    },
  },
});

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"

}