{
  "opencollection": "1.0.0",
  "info": {
    "name": "BigCommerce Abandoned Cart Emails Subscribers API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Auth-Token",
      "value": "{{X-Auth-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Subscribers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "BigCommerce Get Subscribers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribers",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Filter items by email.\n"
              },
              {
                "name": "first_name",
                "value": "",
                "type": "query",
                "description": "Filter items by first_name.\n"
              },
              {
                "name": "last_name",
                "value": "",
                "type": "query",
                "description": "Filter items by last_name.\n"
              },
              {
                "name": "source",
                "value": "",
                "type": "query",
                "description": "Filter items by source.\n"
              },
              {
                "name": "order_id",
                "value": "",
                "type": "query",
                "description": "Filter items by order_id.\n"
              },
              {
                "name": "date_created",
                "value": "",
                "type": "query",
                "description": "Filter items by date_created.\n"
              },
              {
                "name": "date_modified",
                "value": "",
                "type": "query",
                "description": "Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2018-06-15`"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Specifies the page number in a limited (paginated) list of products."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Controls the number of items per page in a limited (paginated) list of products."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Filter items by id."
              }
            ]
          },
          "docs": "Returns a list of *Subscribers*. Optional filter parameters can be passed in."
        },
        {
          "info": {
            "name": "BigCommerce Create a Subscriber",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribers",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a *Subscriber*.\n\n**Required Fields**\n* email\n\n**Read Only Fields**\n* id"
        },
        {
          "info": {
            "name": "BigCommerce Delete Subscribers",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribers",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Filter items by email.\n"
              },
              {
                "name": "first_name",
                "value": "",
                "type": "query",
                "description": "Filter items by first_name.\n"
              },
              {
                "name": "last_name",
                "value": "",
                "type": "query",
                "description": "Filter items by last_name.\n"
              },
              {
                "name": "source",
                "value": "",
                "type": "query",
                "description": "Filter items by source.\n"
              },
              {
                "name": "order_id",
                "value": "",
                "type": "query",
                "description": "Filter items by order_id.\n"
              },
              {
                "name": "date_created",
                "value": "",
                "type": "query",
                "description": "Filter items by date_created.\n"
              },
              {
                "name": "date_modified",
                "value": "",
                "type": "query",
                "description": "Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2018-06-15`"
              }
            ]
          },
          "docs": "By default, it deletes all *Subscribers*. A filter should be added to avoid deleting all subscribers in a store."
        },
        {
          "info": {
            "name": "BigCommerce Get a Subscriber",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribers/:subscriber_id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subscriber_id",
                "value": "",
                "type": "path",
                "description": "The ID of the `Subscriber` requested.\n"
              }
            ]
          },
          "docs": "Returns a *Subscriber*."
        },
        {
          "info": {
            "name": "BigCommerce Update a Subscriber",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribers/:subscriber_id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subscriber_id",
                "value": "",
                "type": "path",
                "description": "The ID of the `Subscriber` requested.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a *Subscriber*.\n\n**Read Only Fields**\n* id"
        },
        {
          "info": {
            "name": "BigCommerce Delete a Subscriber",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribers/:subscriber_id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subscriber_id",
                "value": "",
                "type": "path",
                "description": "The ID of the `Subscriber` requested.\n"
              }
            ]
          },
          "docs": "Deletes a *Subscriber*."
        }
      ]
    }
  ],
  "bundled": true
}