openapi: 3.1.0
info:
  title: 'Admin Content: Store Content'
  version: 1.0.0
paths:
  /stores/{store_hash}/v2/blog/posts:
    get:
      operationId: getBlogPosts
      summary: List Blog Posts
      description: Returns all *Blog Posts*. Default sorting is by published_date, beginning with the most recent post.
      tags:
        - blogPosts
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: is_published
          in: query
          description: Filter param.
          required: false
          schema:
            type: boolean
        - name: url
          in: query
          description: Filter param. Value must be URL encoded.
          required: false
          schema:
            type: string
        - name: tag
          in: query
          description: Filter param.
          required: false
          schema:
            type: string
        - name: published_date
          in: query
          description: Filter param.
          required: false
          schema:
            type: string
            format: date-time
        - name: page
          in: query
          description: Filter param.
          required: false
          schema:
            type: integer
        - name: limit
          in: query
          description: Filter param.
          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:
                type: array
                items:
                  $ref: '#/components/schemas/blogPost_Full'
    post:
      operationId: createBlogPosts
      summary: Create Blog Post
      description: >-
        Creates a *Blog Post*.


        **Required Fields**

        *   `title`

        *   `body`


        **Notes**


        * When including `published_date` in a request, supply it as a flat date string (not an object) in valid <a
        href="http://tools.ietf.org/html/rfc2822#section-3.3" target="_blank">RFC 2822</a>. The following example
        request includes a `published_date` in RFC 2822 format.

        * Blog posts default to draft status. To publish blog posts to the storefront, set the `is_published` property
        to `true`.

        * If a custom URL is not provided, the post’s URL will be generated based on the value of `title`.
      tags:
        - blogPosts
      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:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blogPost_Base_Res'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/blogPost_Base_Post'
    delete:
      operationId: deleteBlogPosts
      summary: Delete Blog Posts
      description: Deletes a page of `Blog Posts`.
      tags:
        - blogPosts
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: Filter param.
          required: false
          schema:
            type: integer
        - name: limit
          in: query
          description: Filter param.
          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: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
  /stores/{store_hash}/v2/blog/posts/{id}:
    get:
      operationId: getBlogPost
      summary: Get Blog Post
      description: Returns a single *Blog Post*.
      tags:
        - blogPosts
      parameters:
        - name: id
          in: path
          description: ID of the blog post.
          required: true
          schema:
            type: integer
        - 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: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blogPost_Full'
    put:
      operationId: updateBlogPost
      summary: Update Blog Post
      description: >-
        Updates a *Blog Post*.


        **Notes**


        * To include `published_date` in a request, provide a flat date string (not an object) in valid <a
        href="http://tools.ietf.org/html/rfc2822#section-3.3" target="_blank">RFC 2822</a>. The following example
        request includes a `published_date` in RFC 2822 format.


        * Blog posts default to draft status. To publish blog posts to the storefront, set the `is_published` property
        to `true`.
      tags:
        - blogPosts
      parameters:
        - name: id
          in: path
          description: ID of the blog post.
          required: true
          schema:
            type: integer
        - 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: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blogPost_Base_Res'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/blogPost_Base_Post'
    delete:
      operationId: deleteBlogPost
      summary: Delete Blog Post
      description: Deletes a *Blog Post*.
      tags:
        - blogPosts
      parameters:
        - name: id
          in: path
          description: ID of the blog post.
          required: true
          schema:
            type: integer
        - 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:
        '204':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
  /stores/{store_hash}/v2/blog/posts/count:
    get:
      operationId: getBlogPostsCount
      summary: Get Count of Blog Posts
      description: Returns a count of all *Blog Posts*.
      tags:
        - blogPosts
      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:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/count_Response'
  /stores/{store_hash}/v2/blog/tags:
    get:
      operationId: getBlogTags
      summary: List Blog Tags
      description: Returns a list of *Blog Tags*.
      tags:
        - blogTags
      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:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/blogTags'
  /stores/{store_hash}/v2/pages:
    get:
      operationId: getPages
      summary: List Pages (deprecated)
      description: >
        Returns a list of *Pages*. Default sorting is by auto-generated ID from oldest to newest.


        > #### Warning

        > **Deprecated**

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To get one or more pages, use Pages V3ʼs [Get
        pages](/developer/api-reference/rest/admin/content/pages/get-pages) endpoint. To get a single page, use Pages
        V3ʼs [Get a page](/developer/api-reference/rest/admin/content/pages/get-page) endpoint.
      tags:
        - pages
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: Filter param.
          required: false
          schema:
            type: number
            format: double
        - name: limit
          in: query
          description: Filter param.
          required: false
          schema:
            type: number
            format: double
        - 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:
                type: array
                items:
                  $ref: '#/components/schemas/page_Full'
    post:
      operationId: createPage
      summary: Create Page (deprecated)
      description: >-
        Creates a *Page*. The request payload limit is 1MB.


        **Required Fields**

        *   `type`

        *   `name`

        *   `link` (for a page of `type: link`)

        *   `body` (for a page of `type: raw`)


        **Read Only Fields**

        *   `id`


        ## Content Type


        The default value for `content_type` is `text/html`; however, if `page_type` is set to `raw`, `content_type` can
        be changed to `text/javascript` or `application/json`. Updating this field lets you place a JavaScript or a JSON
        file in the root directory.


        > #### Warning

        > **Deprecated**

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To create one or more pages, use Pages V3ʼs [Create
        pages](/developer/api-reference/rest/admin/content/pages/create-pages) endpoint.
      tags:
        - pages
      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:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/page_Full'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/page_Base'
  /stores/{store_hash}/v2/pages/{id}:
    get:
      operationId: getPage
      summary: Get Page (deprecated)
      description: >
        Returns a *Page*. 


        > #### Warning

        > **Deprecated**

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To get a single page, use Pages V3ʼs [Get a
        page](/developer/api-reference/rest/admin/content/pages/get-page) endpoint.
      tags:
        - pages
      parameters:
        - name: id
          in: path
          description: ID of the page.
          required: true
          schema:
            type: integer
        - 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: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/page_Full'
    put:
      operationId: updatePage
      summary: Update Page (deprecated)
      description: >-
        Updates a *Page*. The request payload limit is 1MB.



        **Read Only Fields**

        * id


        > #### Warning

        > **Deprecated**

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To update multiple pages, use Pages V3ʼs [Update
        pages](/developer/api-reference/rest/admin/content/pages/update-pages) endpoint. To update a single page, use
        Pages V3ʼs [Update a page](/developer/api-reference/rest/admin/content/pages/update-page) endpoint.

        > * Updating the channel ID for a page is not supported.
      tags:
        - pages
      parameters:
        - name: id
          in: path
          description: ID of the page.
          required: true
          schema:
            type: integer
        - 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: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/page_Full'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/page_Full'
    delete:
      operationId: deletePage
      summary: Delete Page (deprecated)
      description: >
        Deletes a *Page*.


        > #### Warning

        > **Deprecated**

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To delete multiple pages, use Pages V3ʼs [Delete
        pages](/developer/api-reference/rest/admin/content/pages/delete-pages) endpoint. To delete a single page, use
        Pages V3ʼs [Delete a page](/developer/api-reference/rest/admin/content/pages/delete-page) endpoint.
      tags:
        - pages
      parameters:
        - name: id
          in: path
          description: ID of the page.
          required: true
          schema:
            type: integer
        - 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:
        '204':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
  /stores/{store_hash}/v2/redirects:
    get:
      operationId: getRedirects
      summary: List Redirects
      description: >-
        Returns a list all *Redirect URLs*. 


        > #### Warning

        > **Deprecated**

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To get redirect URLs, use Redirects V3ʼs [Get
        redirects](/developer/api-reference/rest/admin/management/redirects/get-redirects) endpoint.
      tags:
        - redirects
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: Filter param.
          required: false
          schema:
            type: integer
        - name: limit
          in: query
          description: Filter param.
          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:
                type: array
                items:
                  $ref: '#/components/schemas/redirect'
    post:
      operationId: createRedirect
      summary: Create Redirect
      description: >-
        Creates a *Redirect URL*.


        **Required Fields**

        *   path

        *   forward


        **Read Only**

        *   url



        > #### Warning

        > **Deprecated**

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To upsert new redirect data, use Redirects V3ʼs [Upsert
        redirects](/developer/api-reference/rest/admin/management/redirects/upsert-redirects) endpoint.
      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:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/redirect'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/redirect'
    delete:
      operationId: deleteRedirects
      summary: Delete All Redirects
      description: >-
        By default, it deletes all *Redirect URLs* in a store. 



        > #### Warning

        > **Deprecated**

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To delete redirect URLs, use Redirects V3ʼs [Delete
        redirects](/developer/api-reference/rest/admin/management/redirects/delete-redirects) endpoint.
      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:
        '204':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
  /stores/{store_hash}/v2/redirects/{id}:
    get:
      operationId: getRedirect
      summary: Get Redirect
      description: >-
        Returns a single *Redirect URL*.


        > #### Warning

        > **Deprecated** 

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To get a redirect URL, use Redirects V3ʼs [Get
        redirects](/developer/api-reference/rest/admin/management/redirects/get-redirects) endpoint.
      tags:
        - redirects
      parameters:
        - name: id
          in: path
          description: ID of the redirect URL.
          required: true
          schema:
            type: integer
        - 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: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/redirect'
    put:
      operationId: updateRedirect
      summary: Update Redirect
      description: >-
        Updates a *Redirect URL*.


        **Required Fields**

        *   path

        *   forward


        **Read Only Fields**

        *   url



        > #### Warning

        > **Deprecated**

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To update redirect data, use Redirects V3ʼs [Upsert
        redirects](/developer/api-reference/rest/admin/management/redirects/upsert-redirects) endpoint.
      tags:
        - redirects
      parameters:
        - name: id
          in: path
          description: ID of the redirect URL.
          required: true
          schema:
            type: integer
        - 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: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/redirect'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: Numeric ID of the redirect.
                path:
                  type: string
                  description: The path from which to redirect.
                forward:
                  $ref: '#/components/schemas/RedirectsIdPutRequestBodyContentApplicationJsonSchemaForward'
                url:
                  type: string
                  description: URL of the redirect. READ-ONLY.
              required:
                - path
                - forward
    delete:
      operationId: deleteRedirect
      summary: Delete Redirect
      description: >-
        Deletes a *Redirect URL*.


        > #### Warning

        > **Deprecated** 

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To delete a redirect URL, use Redirects V3ʼs [Delete
        redirects](/developer/api-reference/rest/admin/management/redirects/delete-redirects) endpoint.
      tags:
        - redirects
      parameters:
        - name: id
          in: path
          description: ID of the redirect URL.
          required: true
          schema:
            type: integer
        - 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:
        '204':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
  /stores/{store_hash}/v2/redirects/count:
    get:
      operationId: getRedirectsCount
      summary: Get Count of Redirects
      description: >-
        Gets a count of *Redirect URLs* in a store.


        > #### Warning

        > **Deprecated**

        > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future
        version.

        > * To get a count of redirects, use the `meta` object data returned with the Redirects V3ʼs [Get
        redirects](/developer/api-reference/rest/admin/management/redirects/get-redirects) endpoint.
      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:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/count_Response'
servers:
  - url: https://api.bigcommerce.com
    description: https://api.bigcommerce.com
components:
  schemas:
    publishedDate:
      type: object
      properties:
        timezone_type:
          type: integer
        date:
          type: string
          format: date-time
        timezone:
          type: string
      title: publishedDate
    blogPost_Full:
      type: object
      properties:
        title:
          type: string
          description: Title of this blog post.
        url:
          type: string
          description: URL for the public blog post.
        preview_url:
          type: string
          description: URL to preview the blog post. READ-ONLY.
        body:
          type: string
          description: Text body of the blog post.
        tags:
          type: array
          items:
            type: string
          description: Tags to characterize the blog post.
        summary:
          type: string
          description: Summary of the blog post. READ-ONLY.
        is_published:
          type: boolean
          default: false
          description: >-
            Whether the blog post is published. If you want the post to be or remain published following the request,
            you must set the field explicitly to true, even if the blog post was already published prior to the request.
        published_date:
          $ref: '#/components/schemas/publishedDate'
        published_date_iso8601:
          type: string
          description: Published date in `ISO 8601` format.
        meta_description:
          type:
            - string
            - 'null'
          description: Description text for this blog post’s `<meta/>` element.
        meta_keywords:
          type:
            - string
            - 'null'
          description: Keywords for this blog post’s `<meta/>` element.
        author:
          type:
            - string
            - 'null'
          description: Name of the blog post’s author.
        thumbnail_path:
          type:
            - string
            - 'null'
          description: >-
            Local path to a thumbnail uploaded to `/product_images/` using
            [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV).
        id:
          type: integer
          description: ID of this blog post. READ-ONLY.
      title: blogPost_Full
    blogPost_Base_Post:
      type: object
      properties:
        title:
          type: string
          description: Title of this blog post.
        url:
          type: string
          description: URL for the public blog post.
        body:
          type: string
          description: Text body of the blog post.
        tags:
          type: array
          items:
            type: string
          description: Tags to characterize the blog post.
        is_published:
          type: boolean
          default: false
          description: >-
            Whether the blog post is published. If you want the post to be or remain published following the request,
            you must set the field explicitly to true, even if the blog post was already published prior to the request.
        meta_description:
          type: string
          description: Description text for this blog post’s `<meta/>` element.
        meta_keywords:
          type: string
          description: Keywords for this blog post’s `<meta/>` element.
        author:
          type: string
          description: Name of the blog post’s author.
        thumbnail_path:
          type: string
          description: >-
            Local path to a thumbnail uploaded to `/product_images/` using
            [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV).
        published_date:
          type: string
      required:
        - title
        - body
      description: blogPost base for POST requests
      title: blogPost_Base_Post
    blogPost_Base_Res:
      type: object
      properties:
        title:
          type: string
          description: Title of this blog post.
        url:
          type: string
          description: URL for the public blog post.
        preview_url:
          type: string
          description: URL to preview the blog post. READ-ONLY.
        body:
          type: string
          description: Text body of the blog post.
        tags:
          type: array
          items:
            type: string
          description: Tags to characterize the blog post.
        summary:
          type: string
          description: Summary of the blog post. READ-ONLY.
        is_published:
          type: boolean
          default: false
          description: >-
            Whether the blog post is published. If you want the post to be or remain published following the request,
            you must set the field explicitly to true, even if the blog post was already published prior to the request.
        published_date:
          $ref: '#/components/schemas/publishedDate'
        published_date_iso8601:
          type: string
          description: Published date in `ISO 8601` format.
        meta_description:
          type:
            - string
            - 'null'
          description: Description text for this blog post’s `<meta/>` element.
        meta_keywords:
          type:
            - string
            - 'null'
          description: Keywords for this blog post’s `<meta/>` element.
        author:
          type:
            - string
            - 'null'
          description: Name of the blog post’s author.
        thumbnail_path:
          type:
            - string
            - 'null'
          description: >-
            Local path to a thumbnail uploaded to `/product_images/` using
            [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV).
      description: blog post base response
      title: blogPost_Base_Res
    count_Response:
      type: object
      properties:
        count:
          type: number
          format: double
      title: count_Response
    BlogTagsItems:
      type: object
      properties:
        tag:
          type: string
        post_ids:
          type: array
          items:
            type: integer
      title: BlogTagsItems
    blogTags:
      type: array
      items:
        $ref: '#/components/schemas/BlogTagsItems'
      title: blogTags
    PageBaseResType:
      type: string
      enum:
        - page
        - contact_form
        - raw
        - link
      description: |
        `page`: free-text page
        `link`: link to another web address
        `contact_form`: When the store’s contact form is used
      title: PageBaseResType
    PageBaseResContentType:
      type: string
      enum:
        - application/json
        - text/javascript
        - text/html
      title: PageBaseResContentType
    page_Full:
      type: object
      properties:
        channel_id:
          type: number
          format: double
          description: Channel ID.
        name:
          type: string
          description: Page name, as displayed on the storefront.
        meta_title:
          type: string
          description: Text specified for this page's `<title>` element. If empty, the value of the name property is used.
        email:
          type: string
          description: Where the page’s type is a contact form, the email address that receives messages sent using the form.
        body:
          type: string
          description: >-
            HTML or variable that populates this page’s `<body>` element, in default/desktop view. Required in POST if
            page type is `raw`.
        is_visible:
          type: boolean
          description: If true, this page appears in the storefront navigation menu.
        parent_id:
          type: integer
          description: ID of any parent Web page.
        sort_order:
          type: integer
          description: Order in which this page should display on the storefront. (Lower integers specify earlier display.)
        meta_keywords:
          type: string
          description: Comma-separated list of SEO-relevant keywords to include in the page's `<meta/>` element.
        type:
          $ref: '#/components/schemas/PageBaseResType'
          description: |
            `page`: free-text page
            `link`: link to another web address
            `contact_form`: When the store’s contact form is used
        contact_fields:
          type: string
          description: >-
            Where the page’s type is a contact form - object whose members are the fields enabled (in the control panel)
            for storefront display. Possible members are:`fullname` - full name of the customer submitting the form;
            `phone` - customer’s phone number, as submitted on the form; `companyname`- customer’s submitted company
            name; `orderno`- customer’s submitted order number; `rma` - customer’s submitted RMA (Return Merchandise
            Authorization) number.
        meta_description:
          type: string
          description: >-
            Description contained within this page’s `<meta/>` element. HTML to use for this page’s body when viewed in
            the mobile template.
        is_homepage:
          type: boolean
          description: If true, this page is the storefront’s home page.
        layout_file:
          type: string
          description: Layout template for this page. This field is writable only for stores with a Blueprint theme applied.
        is_customers_only:
          type: boolean
          description: If true, this page is for customers only.
        search_keywords:
          type: string
          description: Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
        has_mobile_version:
          type: boolean
          description: If true, this page has a mobile version. (For Blueprint themes only)
        mobile_body:
          type: string
          description: HTML to use for this page’s body when viewed in the mobile template (deprecated - Blueprint only).
        content_type:
          $ref: '#/components/schemas/PageBaseResContentType'
        url:
          type: string
          description: Relative URL on the storefront for this page.
        link:
          type: string
          description: If page type is `link`, this field is returned.
        id:
          type: integer
          description: ID of the page. Read-Only.
      title: page_Full
    PageBaseType:
      type: string
      enum:
        - page
        - contact_form
        - raw
        - link
      description: |
        `page`: free-text page
        `link`: link to another web address
        `contact_form`: When the store’s contact form is used
      title: PageBaseType
    PageBaseContentType:
      type: string
      enum:
        - application/json
        - text/javascript
        - text/html
      title: PageBaseContentType
    page_Base:
      type: object
      properties:
        channel_id:
          type: number
          format: double
          description: channel ID
        name:
          type: string
          description: Page name, as displayed on the storefront.
        meta_title:
          type: string
          description: Text specified for this page’s `<title>` element. If empty, the value of the name property is used.
        body:
          type: string
          description: >-
            HTML or variable that populates this page’s `<body>` element, in default/desktop view. Required in POST if
            page type is `raw`.
        is_visible:
          type: boolean
          description: If true, this page appears in the storefront’s navigation menu.
        parent_id:
          type: integer
          description: ID of any parent Web page.
        sort_order:
          type: integer
          description: Order in which this page should display on the storefront. (Lower integers specify earlier display.)
        meta_keywords:
          type: string
          description: Comma-separated list of SEO-relevant keywords to include in the page’s `<meta/>` element.
        type:
          $ref: '#/components/schemas/PageBaseType'
          description: |
            `page`: free-text page
            `link`: link to another web address
            `contact_form`: When the store’s contact form is used
        meta_description:
          type: string
          description: Description contained within this page’s `<meta/>` element.
        is_homepage:
          type: boolean
          description: If true, this page is the storefront’s home page.
        is_customers_only:
          type: boolean
          description: If true, this page is for customers only.
        search_keywords:
          type: string
          description: Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
        has_mobile_version:
          type: boolean
          description: If true, this page has a mobile version. (For Blueprint themes only)
        mobile_body:
          type: string
          description: HTML to use for this page’s body when viewed in the mobile template (deprecated - Blueprint themes only).
        contact_fields:
          type: string
          description: >-
            Where the page’s type is a contact form: object whose members are the fields enabled (in the control panel)
            for storefront display. Possible members are:`fullname`: full name of the customer submitting the form;
            `phone`: customer’s phone number, as submitted on the form; `companyname`: customer’s submitted company
            name; `orderno`: customer’s submitted order number; `rma`: customer’s submitted RMA (Return Merchandise
            Authorization) number.
        email:
          type: string
          description: Where the page’s type is a contact form, the email address that receives messages sent using the form.
        url:
          type: string
          description: Relative URL on the storefront for this page.
        layout_file:
          type: string
          description: Layout template for this page. This field is writable only for stores with a Blueprint theme applied.
        link:
          type: string
          description: If page type is `link` this field is returned. Required in  POST to create a `link` page.
        content_type:
          $ref: '#/components/schemas/PageBaseContentType'
      required:
        - name
        - body
        - type
      title: page_Base
    forward:
      type: object
      properties:
        type:
          type: string
          description: >-
            The type of redirect. If it is a `manual` redirect then type will always be manual. Dynamic redirects will
            have the type of the page. Such as product or category.
        ref:
          type: integer
          description: >-
            Reference of the redirect. Dynamic redirects will have the category or product number. Manual redirects will
            have the url that is being directed to.
      title: forward
    redirect:
      type: object
      properties:
        id:
          type: integer
          description: Numeric ID of the redirect.
        path:
          type: string
          description: The path from which to redirect.
        forward:
          $ref: '#/components/schemas/forward'
        url:
          type: string
          description: URL of the redirect. READ-ONLY.
      required:
        - path
        - forward
      title: redirect
    RedirectsIdPutRequestBodyContentApplicationJsonSchemaForward:
      type: object
      properties:
        type:
          type: string
          description: >
            The type of redirect. If it is a manual redirect then type will always be manual. Dynamic redirects will
            have the type of the page. Such as product or category.
        ref:
          type: string
          description: >-
            Reference of the redirect. Dynamic redirects will have the category or product number. Manual redirects will
            have the url that is being directed to.
      title: RedirectsIdPutRequestBodyContentApplicationJsonSchemaForward
  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).
