{
  "opencollection": "1.0.0",
  "info": {
    "name": "BigCommerce Abandoned Cart Emails Channels API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Auth-Token",
      "value": "{{X-Auth-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Channels",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "BigCommerce Get All Channels",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Channels subresources that can be included in the response."
              },
              {
                "name": "available",
                "value": "",
                "type": "query",
                "description": "Filter items based on whether the channel is currently available for integration. Setting this query parameter to `true` will return channels with the status of `prelaunch`, `active` , `inactive`, and `connected`. Setting this query parameter to `false` will return channels with the status of `disconnected`, `archived`, `deleted`, and `terminated`."
              },
              {
                "name": "status:in",
                "value": "",
                "type": "query",
                "description": "Filter items by a comma-separated list of statuses."
              },
              {
                "name": "type:in",
                "value": "",
                "type": "query",
                "description": "Filter items by a comma-separated list of types."
              },
              {
                "name": "platform:in",
                "value": "",
                "type": "query",
                "description": "Filter items by a comma-separated list of platforms. For a list of supported platforms, see [Platform](/docs/rest-management/channels#platform)."
              },
              {
                "name": "date_created",
                "value": "",
                "type": "query",
                "description": "Filter items by date_created. For example, `date_created=2019-09-04T00:00:00`, `date_created=2019-09-04`, or `date_created=1567573200`"
              },
              {
                "name": "date_created:min",
                "value": "",
                "type": "query",
                "description": "Filter items by minimum date_created. For example, `date_created:min=2019-09-04T00:00:00`, `date_created:min=2019-09-04`, or `date_created:min=1567573200`"
              },
              {
                "name": "date_created:max",
                "value": "",
                "type": "query",
                "description": "Filter items by maximum date_created. For example, `date_created:max=2019-09-04T00:00:00`, `date_created:max=2019-09-04`, or `date_created:max=1567573200`"
              },
              {
                "name": "date_modified",
                "value": "",
                "type": "query",
                "description": "Filter items by date_modified. For example, `date_modified=2019-09-04T00:00:00`, `date_modified=2019-09-04`, or `date_modified=1567573200`"
              },
              {
                "name": "date_modified:min",
                "value": "",
                "type": "query",
                "description": "Filter items by minimum date_modified. For example, `date_modified:min=2019-09-04T00:00:00`, `date_modified:min=2019-09-04`, or `date_modified:min=1567573200`"
              },
              {
                "name": "date_modified:max",
                "value": "",
                "type": "query",
                "description": "Filter items by maximum date_modified. For example, `date_modified:max=2019-09-04T00:00:00`, `date_modified:max=2019-09-04`, or `date_modified:max=1567573200`"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Controls the number of items per page for paginated responses."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Specifies the page number for a paginated response."
              }
            ]
          },
          "docs": "Returns a list of *Channels*.\n\nWill always return the default BigCommerce storefront with an ID of `1`. This storefront is created by default when you provision a BigCommerce store."
        },
        {
          "info": {
            "name": "BigCommerce Create a Channel",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a *Channel*."
        },
        {
          "info": {
            "name": "BigCommerce Get a Channel",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels/:channel_id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "channel_id",
                "value": "",
                "type": "path",
                "description": "The ID of a channel."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Channels subresources that can be included in the response."
              }
            ]
          },
          "docs": "Returns a *Channel*. Channel ID `1` returns the default BigCommerce storefront."
        },
        {
          "info": {
            "name": "BigCommerce Update a Channel",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/channels/:channel_id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "channel_id",
                "value": "",
                "type": "path",
                "description": "The ID of a channel."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a *Channel*.\n\n## Updatable Fields\n\nThe following fields can be updated.\n* `name`\n* `external_id`\n* `status`\n* `is_listable_from_ui`\n* `is_visible`\n* `config_meta`\n\n\n> #### Note\n> * Partial updates are supported. In most cases, if a field that *cannot* be updated is passed in, the API **will not** respond with an error. It returns a 200 response with the object, in which you will see the field(s) were not updated.\n> * `platform` and `type` cannot be updated after a channel is created.\n> *"
        }
      ]
    }
  ],
  "bundled": true
}