mageworx/module-seoredirects-graph-ql

N/A

1.2.0 2023-02-22 09:42 UTC

Requires

• magento/framework: >=103.0.2 < 104
• magento/module-url-rewrite-graph-ql: >= 100.4.2 < 101
• mageworx/module-seoredirects: >= 2.6.1

OSL-3.0, AFL-3.0

README

GraphQL API module for Mageworx Magento 2 SEO Suite Ultimate extension.

Installation

1) Copy-to-paste method

• Download this module and upload it to the app/code/MageWorx/SeoRedirectsGraphQl directory (create "SeoRedirectsGraphQl" first if missing)

2) Installation using composer (from packagist)

• Execute the following command: composer require mageworx/module-seoredirects-graph-ql

How to use

SeoRedirectsGraphQl module modifies the current values of the existing Output attributes for urlResolver query and for routes query if there is at least 1 Mageworx redirect for the 'requested URL' entity.

This module is compatible with:

• redirects for deleted products
• custom redirects with Request Entity Type and Target Entity Type equal to Product, Category or CMS Page

urlResolver query

For example, urlResolver query has the following syntax:

{urlResolver(url: String!): EntityUrl}

Request:

{
  urlResolver(url: "savvy-shoulder-tote.html") {
    id
    relative_url
    redirectCode
    type
  }
}

Response:

{
  "data": {
    "urlResolver": {
      "id": 2047,
      "relative_url": "erika-running-short.html",
      "redirectCode": 301,
      "type": "PRODUCT"
    }
  }
}

routes query

For example, route query has the following syntax:

{route(url: String!): RoutableInterface}

Request:

{
  route(url: "savvy-shoulder-tote.html") {
    relative_url
    redirect_code
    type
  }
}

Response:

{
  "data": {
    "route": {
      "relative_url": "erika-running-short.html",
      "redirect_code": 301,
      "type": "PRODUCT"
    }
  }
}