Shopify Redirects API

The Redirects API from Shopify — 12 operation(s) for redirects.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

shopify-redirects-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Shopify Admin REST About Redirects 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: Redirects
paths:
  /admin/api/2020-01/redirects.json:
    get:
      summary: Shopify Retrieves A List Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-01
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: path
        description: Show redirects with a given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Show redirects with a given target.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/redirects/count.json:
    get:
      summary: Shopify Retrieves A Count Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-01
      parameters:
      - in: query
        name: path
        description: Count redirects with given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Count redirects with given target.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_redirects_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/redirects.json:
    get:
      summary: Shopify Retrieves A List Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-04
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: path
        description: Show redirects with a given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Show redirects with a given target.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/redirects/count.json:
    get:
      summary: Shopify Retrieves A Count Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-04
      parameters:
      - in: query
        name: path
        description: Count redirects with given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Count redirects with given target.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_redirects_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/redirects.json:
    get:
      summary: Shopify Retrieves A List Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-07
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: path
        description: Show redirects with a given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Show redirects with a given target.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/redirects/count.json:
    get:
      summary: Shopify Retrieves A Count Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-07
      parameters:
      - in: query
        name: path
        description: Count redirects with given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Count redirects with given target.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_redirects_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/redirects.json:
    get:
      summary: Shopify Retrieves A List Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2020-10
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: path
        description: Show redirects with a given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Show redirects with a given target.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: get_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/redirects/count.json:
    get:
      summary: Shopify Retrieves A Count Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2020-10
      parameters:
      - in: query
        name: path
        description: Count redirects with given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Count redirects with given target.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: get_redirects_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/redirects.json:
    get:
      summary: Shopify Retrieves A List Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-2021-01
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: path
        description: Show redirects with a given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Show redirects with a given target.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/redirects/count.json:
    get:
      summary: Shopify Retrieves A Count Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-2021-01
      parameters:
      - in: query
        name: path
        description: Count redirects with given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Count redirects with given target.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_redirects_count
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/redirects.json:
    get:
      summary: Shopify Retrieves A List Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#index-unstable
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: since_id
        description: Restrict results to after the specified ID.
        schema: {}
        required: false
      - in: query
        name: path
        description: Show redirects with a given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Show redirects with a given target.
        schema: {}
        required: false
      - in: query
        name: fields
        description: Show only certain fields, specified by a comma-separated list of field names.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_redirects
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/redirects/count.json:
    get:
      summary: Shopify Retrieves A Count Of Url Redirects
      description: https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect#count-unstable
      parameters:
      - in: query
        name: path
        description: Count redirects with given path.
        schema: {}
        required: false
      - in: query
        name: target
        description: Count redirects with given target.
        schema: {}
        required: false
      tags:
      - Redirects
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_redirects_count
      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