urlResolver query

A merchant can reconfigure (rewrite) the URL to any product, category, or CMS page. When the rewrite goes into effect, any links that point to the previous URL are redirected to the new address.

The urlResolver query returns the canonical URL for a specified product, category, or CMS page. An external app can render a page by a URL without any prior knowledge about the landing page.

Syntax

{urlResolver(url: String!): EntityUrl}

Example usage

URL resolver for a product

The following query returns information about the URL containing joust-duffle-bag.html for a product.

Request:

1
2
3
4
5
6
7
8
{
  urlResolver(url: "joust-duffle-bag.html") {
    id
    relative_url
    redirectCode
    type
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
{
  "data": {
    "urlResolver": {
      "id": 1,
      "relative_url": "catalog/product/view/id/1",
      "redirectCode": 0,
      "type": "PRODUCT"
    }
  }
}

URL resolver for a category

The following query returns information about the URL containing gear/bags.html for category page.

Request:

1
2
3
4
5
6
7
8
{
  urlResolver(url: "gear/bags.html") {
    id
    relative_url
    redirectCode
    type
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
{
  "data": {
    "urlResolver": {
      "id": 4,
      "relative_url": "gear/bags.html",
      "redirectCode": 0,
      "type": "CATEGORY"
    }
  }
}

URL resolver for a CMS page

The following query returns information about the URL containing no-route for a CMS page.

Request:

1
2
3
4
5
6
7
8
{
  urlResolver(url: "no-route") {
    id
    relative_url
    redirectCode
    type
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
{
  "data": {
    "urlResolver": {
      "id": 1,
      "relative_url": "no-route",
      "redirectCode": 0,
      "type": "CMS_PAGE"
    }
  }
}

Input attributes

The urlResolver query contains the following attribute.

Output attributes

The EntityUrl output object contains the id, relative_url, and type attributes.

Related topics

Products endpoint

Errors