{
  "opencollection": "1.0.0",
  "info": {
    "name": "BigCommerce Abandoned Cart Emails Redirects API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Auth-Token",
      "value": "{{X-Auth-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Redirects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "BigCommerce Get All Redirects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/redirects",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Filter param."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Filter param."
              }
            ]
          },
          "docs": "Returns a list all *Redirect URLs*. \n\n> #### Warning\n> **Deprecated**\n> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.\n> * To get redirect URLs, use Redirects V3ʼs [Get redirects](/docs/rest-management/redirects#get-redirects) endpoint."
        },
        {
          "info": {
            "name": "BigCommerce Create a Redirect",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/redirects",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a *Redirect URL*.\n\n**Required Fields**\n*   path\n*   forward\n\n**Read Only**\n*   url\n\n\n> #### Warning\n> **Deprecated**\n> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.\n> * To upsert new redirect data, use Redirects V3ʼs [Upsert redirects](/docs/rest-management/redirects#upsert-redirects) endpoint."
        },
        {
          "info": {
            "name": "BigCommerce Delete All Redirects",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/redirects",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ]
          },
          "docs": "By default, it deletes all *Redirect URLs* in a store. \n\n\n> #### Warning\n> **Deprecated**\n> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.\n> * To delete redirect URLs, use Redirects V3ʼs [Delete redirects](/docs/rest-management/redirects#delete-redirects) endpoint."
        },
        {
          "info": {
            "name": "BigCommerce Get a Redirect",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/redirects/:id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the redirect URL."
              }
            ]
          },
          "docs": "Returns a single *Redirect URL*.\n\n> #### Warning\n> **Deprecated** \n> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.\n> * To get a redirect URL, use Redirects V3ʼs [Get redirects](/docs/rest-management/redirects#get-redirects) endpoint."
        },
        {
          "info": {
            "name": "BigCommerce Update a Redirect",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/redirects/:id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the redirect URL."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a *Redirect URL*.\n\n**Required Fields**\n*   path\n*   forward\n\n**Read Only Fields**\n*   url\n\n\n> #### Warning\n> **Deprecated**\n> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.\n> * To update redirect data, use Redirects V3ʼs [Upsert redirects](/docs/rest-management/redirects#upsert-redirects) endpoint."
        },
        {
          "info": {
            "name": "BigCommerce Delete a Redirect",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/redirects/:id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the redirect URL."
              }
            ]
          },
          "docs": "Deletes a *Redirect URL*.\n\n> #### Warning\n> **Deprecated** \n> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.\n> * To delete a redirect URL, use Redirects V3ʼs [Delete redirects](/docs/rest-management/redirects#delete-redirects) endpoint."
        },
        {
          "info": {
            "name": "BigCommerce Get a Count of Redirects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/redirects/count",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ]
          },
          "docs": "Gets a count of *Redirect URLs* in a store.\n\n> #### Warning\n> **Deprecated**\n> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.\n> * To get a count of redirects, use the `meta` object data returned with the Redirects V3ʼs [Get redirects](/docs/rest-management/redirects#get-redirects) endpoint."
        },
        {
          "info": {
            "name": "BigCommerce Get Redirects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/redirects",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "query",
                "description": "Filters items by `site_id`."
              },
              {
                "name": "id:in",
                "value": "",
                "type": "query",
                "description": "Filters items by redirect `id`. Also accepts comma-separated values to filter for multiple redirects."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Controls the number of items to return per page."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Specifies the page number in a limited (paginated) list of items. Used to paginate large collections."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Field name to sort by. Note: Since redirect `id` increments when new redirects are added, you can use that field to sort by redirect create date.\n"
              },
              {
                "name": "direction",
                "value": "",
                "type": "query",
                "description": "Sort direction. Acceptable values are `asc`, `desc`."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Indicates whether to include redirect sub-resources. Only `to_url` is supported."
              },
              {
                "name": "keyword",
                "value": "",
                "type": "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`."
              }
            ]
          },
          "docs": "Returns a collection of the store's 301 redirects across all sites."
        },
        {
          "info": {
            "name": "BigCommerce Upsert Redirects",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/redirects",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Upserts new redirect data across all storefronts."
        },
        {
          "info": {
            "name": "BigCommerce Delete Redirects",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/redirects",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id:in",
                "value": "",
                "type": "query",
                "description": "List of Redirect IDs to delete explicitly."
              },
              {
                "name": "site_id",
                "value": "",
                "type": "query",
                "description": "Site ID provided to delete all redirects for a given Site."
              }
            ]
          },
          "docs": "Deletes redirects."
        }
      ]
    }
  ],
  "bundled": true
}