Shopify Redirect API

The Redirect API from Shopify — 12 operation(s) for redirect.

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /admin/api/2020-01/redirects.json Create a URL redirect (API 2020-01) · Shopify Creates A Redirect #
Ask an LLM
“Can I send shoppers from an old store URL to a new one using the 2020-01 API?”
“What does creating a redirect look like on version 2020-01?”
Tell an agent
Create a store URL redirect through the 2020-01 API version.
Add a new path redirect using release 2020-01.
GET /admin/api/2020-01/redirects/{redirect_id}.json Get one redirect (API 2020-01) · Shopify Retrieves A Single Redirect #
Ask an LLM
“Where does a given redirect point, checked on API version 2020-01?”
“Can the 2020-01 single-redirect lookup return just some fields?”
Tell an agent
Show redirect {redirect_id} from the 2020-01 API.
Look up redirect {redirect_id} on 2020-01 returning only {fields}.
POST /admin/api/2020-04/redirects.json Create a URL redirect (API 2020-04) · Shopify Creates A Redirect #
Ask an LLM
“How do I forward a retired product URL to a new page with the 2020-04 release?”
“Is creating store redirects supported in API version 2020-04?”
Tell an agent
Set up a new URL redirect via version 2020-04.
Using the 2020-04 release, add a redirect for my online store.
GET /admin/api/2020-04/redirects/{redirect_id}.json Get one redirect (API 2020-04) · Shopify Retrieves A Single Redirect #
Ask an LLM
“What target path is a specific redirect sending traffic to under 2020-04?”
“Which fields can I limit a single redirect to in release 2020-04?”
Tell an agent
Fetch redirect {redirect_id} through version 2020-04.
Retrieve only {fields} of redirect {redirect_id} on the 2020-04 API.
POST /admin/api/2020-07/redirects.json Create a URL redirect (API 2020-07) · Shopify Creates A Redirect #
Ask an LLM
“Can I add a storefront redirect when my app is pinned to 2020-07?”
“What's needed to make a new redirect with API version 2020-07?”
Tell an agent
Make a redirect for a moved page with the 2020-07 API.
Create one online store redirect on release 2020-07.
GET /admin/api/2020-07/redirects/{redirect_id}.json Get one redirect (API 2020-07) · Shopify Retrieves A Single Redirect #
Ask an LLM
“How can I inspect one redirect's path and target on the 2020-07 release?”
“Does 2020-07 let me request selected fields for a single redirect?”
Tell an agent
Get redirect {redirect_id} using API version 2020-07.
On 2020-07, return the {fields} of redirect {redirect_id}.
POST /admin/api/2020-10/redirects.json Create a URL redirect (API 2020-10) · Shopify Creates A Redirect #
Ask an LLM
“How do I redirect an old storefront URL to a new location in Shopify?”
“Can the current 2020-10 API create a redirect for my online store?”
Tell an agent
Create a URL redirect in my store with the 2020-10 API.
Add a redirect so an outdated link lands on a new page, version 2020-10.
GET /admin/api/2020-10/redirects/{redirect_id}.json Get one redirect (API 2020-10) · Shopify Retrieves A Single Redirect #
Ask an LLM
“What does an existing redirect point to, using the 2020-10 API?”
“Can I fetch only certain fields of one redirect on version 2020-10?”
Tell an agent
Retrieve redirect {redirect_id} with API 2020-10.
Show just {fields} for redirect {redirect_id} on release 2020-10.
POST /admin/api/2021-01/redirects.json Create a URL redirect (API 2021-01) · Shopify Creates A Redirect #
Ask an LLM
“Is it possible to set up a new redirect via the 2021-01 release?”
“What happens when I create a redirect with API version 2021-01?”
Tell an agent
Create a storefront redirect through release 2021-01.
Register a new URL redirect with the 2021-01 API version.
GET /admin/api/2021-01/redirects/{redirect_id}.json Get one redirect (API 2021-01) · Shopify Retrieves A Single Redirect #
Ask an LLM
“Where is one particular redirect sending visitors, per the 2021-01 API?”
“Can a 2021-01 redirect lookup be narrowed to specific fields?”
Tell an agent
Look up redirect {redirect_id} via the 2021-01 release.
Fetch {fields} only from redirect {redirect_id}, API 2021-01.
POST /admin/api/unstable/redirects.json Create a URL redirect (unstable API) · Shopify Creates A Redirect #
Ask an LLM
“Can I create a redirect against the unstable API version?”
“What does the unstable release expect when adding a URL redirect?”
Tell an agent
Create a redirect using the unstable API.
Add an online store redirect on the unstable version.
GET /admin/api/unstable/redirects/{redirect_id}.json Get one redirect (unstable API) · Shopify Retrieves A Single Redirect #
Ask an LLM
“How do I read a single redirect from the unstable API version?”
“Which fields of one redirect can the unstable release return on request?”
Tell an agent
Get redirect {redirect_id} from the unstable API.
Using the unstable version, show {fields} of redirect {redirect_id}.

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/shopify-redirect-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

shopify-redirect-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Shopify Redirect API
  description: Explore Shopify's API reference and templating documentation. Shopify provides a range of software tools, app templates, example apps, and libraries to accelerate your development process. The Admin API lets you build apps and integrations that extend and enhance the Shopify admin.
  version: 2020-10
tags:
- name: Redirect
paths:
  /admin/api/2020-01/redirects.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    path: /ipod
                    target: /pages/itunes
                summary: Create a redirect
              example2:
                value:
                  redirect:
                    path: http://www.apple.com/forums
                    target: http://forums.apple.com
                summary: Create a redirect using a full URL for the path, which will be saved as an absolute path without a domain
              example3:
                value:
                  redirect:
                    body: foobar
                summary: Creating a redirect without a path or target fails and returns an error
      summary: Shopify Creates A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-2020-01
      parameters: []
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_create_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/redirects/{redirect_id}.json:
    get:
      summary: Shopify Retrieves A Single Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2020-01
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/redirects.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    path: /ipod
                    target: /pages/itunes
                summary: Create a redirect
              example2:
                value:
                  redirect:
                    path: http://www.apple.com/forums
                    target: http://forums.apple.com
                summary: Create a redirect using a full URL for the path, which will be saved as an absolute path without a domain
              example3:
                value:
                  redirect:
                    body: foobar
                summary: Creating a redirect without a path or target fails and returns an error
      summary: Shopify Creates A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-2020-04
      parameters: []
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_create_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/redirects/{redirect_id}.json:
    get:
      summary: Shopify Retrieves A Single Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2020-04
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/redirects.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    path: /ipod
                    target: /pages/itunes
                summary: Create a redirect
              example2:
                value:
                  redirect:
                    path: http://www.apple.com/forums
                    target: http://forums.apple.com
                summary: Create a redirect using a full URL for the path, which will be saved as an absolute path without a domain
              example3:
                value:
                  redirect:
                    body: foobar
                summary: Creating a redirect without a path or target fails and returns an error
      summary: Shopify Creates A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-2020-07
      parameters: []
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_create_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/redirects/{redirect_id}.json:
    get:
      summary: Shopify Retrieves A Single Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2020-07
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/redirects.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    path: /ipod
                    target: /pages/itunes
                summary: Create a redirect
              example2:
                value:
                  redirect:
                    path: http://www.apple.com/forums
                    target: http://forums.apple.com
                summary: Create a redirect using a full URL for the path, which will be saved as an absolute path without a domain
              example3:
                value:
                  redirect:
                    body: foobar
                summary: Creating a redirect without a path or target fails and returns an error
      summary: Shopify Creates A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-2020-10
      parameters: []
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: create_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/redirects/{redirect_id}.json:
    get:
      summary: Shopify Retrieves A Single Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2020-10
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: get_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/redirects.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    path: /ipod
                    target: /pages/itunes
                summary: Create a redirect
              example2:
                value:
                  redirect:
                    path: http://www.apple.com/forums
                    target: http://forums.apple.com
                summary: Create a redirect using a full URL for the path, which will be saved as an absolute path without a domain
              example3:
                value:
                  redirect:
                    body: foobar
                summary: Creating a redirect without a path or target fails and returns an error
      summary: Shopify Creates A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-2021-01
      parameters: []
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_create_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/redirects/{redirect_id}.json:
    get:
      summary: Shopify Retrieves A Single Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-2021-01
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/redirects.json:
    post:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    path: /ipod
                    target: /pages/itunes
                summary: Create a redirect
              example2:
                value:
                  redirect:
                    path: http://www.apple.com/forums
                    target: http://forums.apple.com
                summary: Create a redirect using a full URL for the path, which will be saved as an absolute path without a domain
              example3:
                value:
                  redirect:
                    body: foobar
                summary: Creating a redirect without a path or target fails and returns an error
      summary: Shopify Creates A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#create-unstable
      parameters: []
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_create_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/redirects/{redirect_id}.json:
    get:
      summary: Shopify Retrieves A Single Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#show-unstable
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true