Choose a version:

urlRedirectCreate

mutation

Requires write_online_store_navigation access scope.

Creates a UrlRedirect object.

Arguments

Anchor to urlRedirecturlRedirect •UrlRedirectInput! required: The fields to use when creating the redirect.

Was this section helpful?

Anchor to UrlRedirectCreatePayload returnsUrlRedirectCreatePayload returns

Anchor to urlRedirecturlRedirect •UrlRedirect: The created redirect.
Anchor to userErrorsuserErrors •[UrlRedirectUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Creates a redirect
urlRedirectCreate reference

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

mutation UrlRedirectCreate($urlRedirect: UrlRedirectInput!) {

urlRedirectCreate(urlRedirect: $urlRedirect) {

urlRedirect {

path

target

}

userErrors {

field

message

}

}`,

{

variables: {

"urlRedirect": {

"path": "/thepath",

"target": "/thetarget"

}

);

const data = await response.json();

mutation UrlRedirectCreate($urlRedirect: UrlRedirectInput!) {
  urlRedirectCreate(urlRedirect: $urlRedirect) {
    urlRedirect {
      id
      path
      target
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UrlRedirectCreate($urlRedirect: UrlRedirectInput!) { urlRedirectCreate(urlRedirect: $urlRedirect) { urlRedirect { id path target } userErrors { field message } } }",
 "variables": {
    "urlRedirect": {
      "path": "/thepath",
      "target": "/thetarget"
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation UrlRedirectCreate($urlRedirect: UrlRedirectInput!) {
    urlRedirectCreate(urlRedirect: $urlRedirect) {
      urlRedirect {
        id
        path
        target
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "urlRedirect": {
        "path": "/thepath",
        "target": "/thetarget"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation UrlRedirectCreate($urlRedirect: UrlRedirectInput!) {
      urlRedirectCreate(urlRedirect: $urlRedirect) {
        urlRedirect {
          id
          path
          target
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "urlRedirect": {
        "path": "/thepath",
        "target": "/thetarget"
      }
    },
  },
});

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
  mutation UrlRedirectCreate($urlRedirect: UrlRedirectInput!) {
    urlRedirectCreate(urlRedirect: $urlRedirect) {
      urlRedirect {
        id
        path
        target
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "urlRedirect": {
    "path": "/thepath",
    "target": "/thetarget"
  }
}

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

Input variables

JSON

{

"urlRedirect": {

"path": "/thepath",

"target": "/thetarget"

}

Response

JSON

{

"urlRedirectCreate": {

"urlRedirect": {

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

"path": "/thepath",

"target": "/thetarget"

"userErrors": []

}