Shopify Redirect API

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

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

shopify-redirect-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Shopify Admin REST About Redirect API
  description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date.
  version: 2025-01
  contact:
    name: Shopify
    url: https://shopify.dev/docs/api/admin-rest
    email: api@shopify.com
  license:
    name: Shopify API Terms
    url: https://www.shopify.com/legal/api-terms
  x-date: '2026-03-04'
servers:
- url: https://{store}.myshopify.com/admin/api/2025-01
  description: Shopify Admin REST API
  variables:
    store:
      default: my-store
      description: The Shopify store subdomain
security:
- AccessToken: []
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
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    id: 668809255
                    path: /tiger
                summary: Update the path URI of a redirect
              example2:
                value:
                  redirect:
                    id: 950115854
                    path: /powermac
                    target: /pages/macpro
                summary: Update both the path and target URIs of a redirect
      summary: Shopify Updates An Existing Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-2020-01
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_update_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-2020-01
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_delete_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
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    id: 668809255
                    path: /tiger
                summary: Update the path URI of a redirect
              example2:
                value:
                  redirect:
                    id: 950115854
                    path: /powermac
                    target: /pages/macpro
                summary: Update both the path and target URIs of a redirect
      summary: Shopify Updates An Existing Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-2020-04
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_update_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-2020-04
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_delete_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
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    id: 668809255
                    path: /tiger
                summary: Update the path URI of a redirect
              example2:
                value:
                  redirect:
                    id: 950115854
                    path: /powermac
                    target: /pages/macpro
                summary: Update both the path and target URIs of a redirect
      summary: Shopify Updates An Existing Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-2020-07
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_update_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-2020-07
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_delete_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
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    id: 668809255
                    path: /tiger
                summary: Update the path URI of a redirect
              example2:
                value:
                  redirect:
                    id: 950115854
                    path: /powermac
                    target: /pages/macpro
                summary: Update both the path and target URIs of a redirect
      summary: Shopify Updates An Existing Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-2020-10
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: update_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-2020-10
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: delete_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
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    id: 668809255
                    path: /tiger
                summary: Update the path URI of a redirect
              example2:
                value:
                  redirect:
                    id: 950115854
                    path: /powermac
                    target: /pages/macpro
                summary: Update both the path and target URIs of a redirect
      summary: Shopify Updates An Existing Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-2021-01
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_update_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-2021-01
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_delete_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
    put:
      requestBody:
        content:
          application/json:
            schema: {}
            examples:
              example1:
                value:
                  redirect:
                    id: 668809255
                    path: /tiger
                summary: Update the path URI of a redirect
              example2:
                value:
                  redirect:
                    id: 950115854
                    path: /powermac
                    target: /pages/macpro
                summary: Update both the path and target URIs of a redirect
      summary: Shopify Updates An Existing Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#update-unstable
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_update_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
    delete:
      summary: Shopify Deletes A Redirect
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#destroy-unstable
      parameters:
      - in: path
        name: redirect_id
        required: true
        schema:
          type: string
        description: redirect_id
      tags:
      - Redirect
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_delete_redirects_param_redirect_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth