openapi: 3.1.0
info:
  title: 'Admin Content: Store Content Redirects'
  version: 1.0.0
paths:
  /stores/{store_hash}/v3/storefront/redirects:
    get:
      operationId: getRedirects
      summary: List Redirects
      description: Returns a collection of the store's 301 redirects across all sites.
      tags:
        - redirects
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: site_id
          in: query
          description: Filters items by site ID.
          required: false
          schema:
            type: integer
        - name: id:in
          in: query
          description: Filters items by redirect ID. Also accepts comma-separated values to filter for multiple redirects.
          required: false
          schema:
            type: array
            items:
              type: integer
        - name: id:min
          in: query
          description: Filters items by minimum redirect ID.
          required: false
          schema:
            type: integer
        - name: id:max
          in: query
          description: Filters items by maximum redirect ID.
          required: false
          schema:
            type: integer
        - name: limit
          in: query
          description: Controls the number of items to return per page.
          required: false
          schema:
            type: integer
        - name: page
          in: query
          description: Specifies the page number in a limited (paginated) list of items. Used to paginate large collections.
          required: false
          schema:
            type: integer
        - name: sort
          in: query
          description: >
            Field name to sort by. Since redirect IDs increment when new redirects are added, you can sort by ID to
            return results in redirect create date order.
          required: false
          schema:
            $ref: '#/components/schemas/StorefrontRedirectsGetParametersSort'
        - name: direction
          in: query
          description: Sort direction. Acceptable values are `asc`, `desc`.
          required: false
          schema:
            $ref: '#/components/schemas/StorefrontRedirectsGetParametersDirection'
        - name: include
          in: query
          description: Indicates whether to include redirect sub-resources. Only `to_url` is supported.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/StorefrontRedirectsGetParametersIncludeSchemaItems'
        - name: keyword
          in: query
          description: >-
            Filters redirects by the specified keyword. Will only search from the beginning of a URL path. For example,
            `blue` will match `/blue` and `/blue-shirt` ,  **not** `/royal-blue-shirt`.
          required: false
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            | Content | modify | `store_v2_content` |

            | Content | read-only | `store_v2_content_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Redirects_getRedirects_Response_200'
    put:
      operationId: upsertRedirects
      summary: Upsert Redirects
      description: Upserts new redirect data across all storefronts.
      tags:
        - redirects
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            | Content | modify | `store_v2_content` |

            | Content | read-only | `store_v2_content_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Redirects_upsertRedirects_Response_201'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/301RedirectUpsert'
    delete:
      operationId: deleteRedirects
      summary: Delete Redirects
      description: Deletes redirects.
      tags:
        - redirects
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: id:in
          in: query
          description: A comma-separated list of redirect IDs to delete explicitly.
          required: true
          schema:
            type: array
            items:
              type: integer
        - name: site_id
          in: query
          description: To delete all redirects for a given site, provide the site ID.
          required: false
          schema:
            type: integer
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            | Content | modify | `store_v2_content` |

            | Content | read-only | `store_v2_content_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
  /stores/{store_hash}/v3/storefront/redirects/imex/jobs:
    get:
      operationId: getRedirectImportExportJobs
      summary: List Redirect Import-Export Jobs
      description: Returns a collection of the storeʼs 301 redirects across all sites.
      tags:
        - importExport
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: id
          in: query
          description: Filters results by redirect import-export job ID.
          required: false
          schema:
            type: string
            format: uuid
        - name: type
          in: query
          description: Filters results by the type of the redirect import-export job.
          required: false
          schema:
            $ref: '#/components/schemas/ImportExportJobType'
        - name: status
          in: query
          description: Filters results by the status of the Redirect Import-Export job.
          required: false
          schema:
            $ref: '#/components/schemas/ImportExportJobStatus'
        - name: limit
          in: query
          description: Determines the number of items returned per page. The default is 10 items per page.
          required: false
          schema:
            type: integer
            default: 10
        - name: page
          in: query
          description: >-
            Specifies the page number to return when the number of items returned exceeds the page limit. Used to
            paginate large collections.
          required: false
          schema:
            type: integer
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            | Content | modify | `store_v2_content` |

            | Content | read-only | `store_v2_content_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Import-Export_getRedirectImportExportJobs_Response_200'
  /stores/{store_hash}/v3/storefront/redirects/imex/export:
    post:
      operationId: createRedirectExportJob
      summary: Create Redirects Export Job
      description: Creates a new 301 Redirects export job.
      tags:
        - importExport
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            | Content | modify | `store_v2_content` |

            | Content | read-only | `store_v2_content_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Import-Export_createRedirectExportJob_Response_201'
        '409':
          description: No Redirects in your store meet the criteria in your request.
          content:
            application/json:
              schema:
                description: Any type
        '429':
          description: Your store already has an active Redirects import or export job running.
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        description: Data necessary to create a new 301 Redirects export job.
        content:
          application/json:
            schema:
              type: object
              properties:
                site_id:
                  type:
                    - integer
                    - 'null'
                  default: null
                  description: >-
                    The site ID for which you wish to export redirects. If no site ID is provided, the request exports
                    all redirects for all sites.
                redirect_ids:
                  type: array
                  items:
                    type: integer
                  default: []
                  description: >-
                    A list of the redirect IDs you wish to export. If no redirect IDs are provided, the request exports
                    all redirects for the given site selection.
                include_dynamic_target_urls:
                  type: boolean
                  default: false
                  description: >-
                    If true, the exported CSV will contain an additional read-only column containing the target URL for
                    dynamic redirects.
  /stores/{store_hash}/v3/storefront/redirects/imex/import:
    post:
      operationId: createRedirectImportJob
      summary: Create Redirects Import Job
      description: Creates a new 301 Redirects import job.
      tags:
        - importExport
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            | Content | modify | `store_v2_content` |

            | Content | read-only | `store_v2_content_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Import-Export_createRedirectImportJob_Response_201'
        '400':
          description: The provided form data was invalid or the file is not a CSV.
          content:
            application/json:
              schema:
                description: Any type
        '413':
          description: The provided file is too large. The maximum file size is 20MB.
          content:
            application/json:
              schema:
                description: Any type
        '429':
          description: Your store already has an active Redirects import or export job running.
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                import_file:
                  type: string
                  format: binary
                  description: |-
                    A CSV file containing a list of Redirects to be imported.

                    The headers must be defined as follows:

                    `Domain,Old Path,Manual URL/Path,Dynamic Target Type,Dynamic Target ID`

                    Not every line will have a value for every column.
              required:
                - import_file
  /stores/{store_hash}/v3/storefront/redirects/imex/export/{uuid}/events:
    get:
      operationId: getRedirectExportEvents
      summary: Open Redirect Export Event Stream
      description: Opens an event stream to receive live updates from an export job.
      tags:
        - importExport
      parameters:
        - name: uuid
          in: path
          description: The import-export job identifier.
          required: true
          schema:
            type: string
            format: uuid
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            | Content | modify | `store_v2_content` |

            | Content | read-only | `store_v2_content_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: Stream of export events. The `data` attribute is stringified JSON.
          content:
            text/event-stream:
              schema:
                type: string
        '404':
          description: The provided export job ID does not exist.
          content:
            application/json:
              schema:
                description: Any type
  /stores/{store_hash}/v3/storefront/redirects/imex/import/{uuid}/events:
    get:
      operationId: getRedirectImportEvents
      summary: Open Redirect Import Event Stream
      description: Opens an event stream to receive live updates from an import job.
      tags:
        - importExport
      parameters:
        - name: uuid
          in: path
          description: The import-export job identifier.
          required: true
          schema:
            type: string
            format: uuid
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            | Content | modify | `store_v2_content` |

            | Content | read-only | `store_v2_content_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: Stream of import events. The `data` attribute is stringified JSON.
          content:
            text/event-stream:
              schema:
                type: string
        '404':
          description: The provided import job ID does not exist.
          content:
            application/json:
              schema:
                description: Any type
  /stores/{store_hash}/v3/storefront/redirects/imex/export/{uuid}/download:
    get:
      operationId: getRedirectExportDownload
      summary: Download Redirect Export
      description: Downloads the CSV file containing the results of an export job.
      tags:
        - importExport
      parameters:
        - name: uuid
          in: path
          description: The import-export job identifier.
          required: true
          schema:
            type: string
            format: uuid
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            | Content | modify | `store_v2_content` |

            | Content | read-only | `store_v2_content_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The exported Redirects in CSV format
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          description: The requested export download does not exist.
          content:
            application/json:
              schema:
                description: Any type
servers:
  - url: https://api.bigcommerce.com
    description: https://api.bigcommerce.com
components:
  schemas:
    StorefrontRedirectsGetParametersSort:
      type: string
      enum:
        - from_path
        - type
        - site_id
        - id
      title: StorefrontRedirectsGetParametersSort
    StorefrontRedirectsGetParametersDirection:
      type: string
      enum:
        - asc
        - desc
      title: StorefrontRedirectsGetParametersDirection
    StorefrontRedirectsGetParametersIncludeSchemaItems:
      type: string
      enum:
        - to_url
      title: StorefrontRedirectsGetParametersIncludeSchemaItems
    RedirectToType:
      type: string
      enum:
        - product
        - brand
        - category
        - page
        - post
        - url
      title: RedirectToType
    RedirectTo:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/RedirectToType'
        entity_id:
          type: integer
        url:
          type: string
      title: RedirectTo
    301RedirectRead:
      type: object
      properties:
        id:
          type: integer
        site_id:
          type: integer
        from_path:
          type: string
        to:
          $ref: '#/components/schemas/RedirectTo'
        to_url:
          type: string
          format: uri
          description: Full destination URL for the redirect. Must be explicitly included via URL parameter.
      description: Full detail of a Redirect, optionally including the full destination URL.
      title: 301RedirectRead
    MetaPaginationObjectPaginationLinks:
      type: object
      properties:
        next:
          type: string
        current:
          type: string
      title: MetaPaginationObjectPaginationLinks
    MetaPaginationObjectPagination:
      type: object
      properties:
        total:
          type: integer
        count:
          type: integer
        per_page:
          type: integer
        current_page:
          type: integer
        total_pages:
          type: integer
        links:
          $ref: '#/components/schemas/MetaPaginationObjectPaginationLinks'
      title: MetaPaginationObjectPagination
    MetaPaginationObject:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/MetaPaginationObjectPagination'
      title: MetaPaginationObject
    Redirects_getRedirects_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/301RedirectRead'
        meta:
          $ref: '#/components/schemas/MetaPaginationObject'
      title: Redirects_getRedirects_Response_200
    301RedirectUpsert:
      type: object
      properties:
        from_path:
          type: string
        site_id:
          type: integer
        to:
          $ref: '#/components/schemas/RedirectTo'
      required:
        - from_path
        - site_id
      description: >-
        Data necessary to create or update a redirect. If there’s a conflict on the from_path and site_id, the redirect
        will be overwritten with new data.
      title: 301RedirectUpsert
    Redirects_upsertRedirects_Response_201:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/301RedirectRead'
        meta:
          $ref: '#/components/schemas/MetaPaginationObject'
      title: Redirects_upsertRedirects_Response_201
    ImportExportJobType:
      type: string
      enum:
        - import
        - export
      title: ImportExportJobType
    ImportExportJobStatus:
      type: string
      enum:
        - new
        - working
        - complete
        - aborted
        - failed
      title: ImportExportJobStatus
    ImportErrorsItems:
      type: object
      properties:
        row:
          type: integer
          description: The row in the import CSV where the error occurred.
        message:
          type: string
      description: Detail of an error that occurred during an import job.
      title: ImportErrorsItems
    ImportErrors:
      type: array
      items:
        $ref: '#/components/schemas/ImportErrorsItems'
      title: ImportErrors
    301RedirectImportExportJobRead:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The Import-Export job ID.
        type:
          $ref: '#/components/schemas/ImportExportJobType'
        status:
          $ref: '#/components/schemas/ImportExportJobStatus'
        completed_items:
          type: integer
          description: The number of items that were successfully imported or exported.
        failed_items:
          type: integer
          description: The number of items that were not successfully imported or exported.
        total_items:
          type: integer
          description: The number of items in the import or export job.
        errors:
          $ref: '#/components/schemas/ImportErrors'
        created_at:
          type: string
          format: date-time
          description: >-
            The date-time that the import-export job was created, formatted as an
            [RFC-3339](https://www.ietf.org/rfc/rfc3339.txt) string.
        completed_at:
          type: string
          format: date-time
          description: >-
            The date-time that the import-export job was completed, formatted as an
            [RFC-3339](https://www.ietf.org/rfc/rfc3339.txt) string.
      description: Full detail of a Redirect Import-Export job.
      title: 301RedirectImportExportJobRead
    Import-Export_getRedirectImportExportJobs_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/301RedirectImportExportJobRead'
        meta:
          $ref: '#/components/schemas/MetaPaginationObject'
      title: Import-Export_getRedirectImportExportJobs_Response_200
    Import-Export_createRedirectExportJob_Response_201:
      type: object
      properties:
        id:
          type: string
      title: Import-Export_createRedirectExportJob_Response_201
    Import-Export_createRedirectImportJob_Response_201:
      type: object
      properties:
        id:
          type: string
      title: Import-Export_createRedirectImportJob_Response_201
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        ### OAuth scopes


        | UI Name | Permission | Parameter |

        |:--------|:-----------|:----------|

        | Content | modify | `store_v2_content` |

        | Content | read-only | `store_v2_content_read_only` |


        ### Authentication header


        | Header | Argument | Description |

        |:-------|:---------|:------------|

        | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to
        API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


        ### Further reading


        For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example
        Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


        For more about BigCommerce OAuth scopes, see our [Guide to API
        Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


        For a list of API status codes, see [API Status
        Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
