{
  "opencollection": "1.0.0",
  "info": {
    "name": "BigCommerce Abandoned Cart Emails Coupons API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Auth-Token",
      "value": "{{X-Auth-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Coupons",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "BigCommerce Get All Coupons",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/coupons",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Optional filter param. `/api/v2/coupons?id={value}`"
              },
              {
                "name": "code",
                "value": "",
                "type": "query",
                "description": "Optional filter param `/api/v2/coupons?code={value}`"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Optional filter param `/api/v2/coupons?name={value}`"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "|Type|\n|-|\n|`per_item_discount`|\n|`percentage_discount`|\n|`per_total_discount`|\n|`shipping_discount`|\n|`free_shipping`|\n|`promotion`|"
              },
              {
                "name": "min_id",
                "value": "",
                "type": "query",
                "description": "Optional filter param `/api/v2/coupons?min_id={value}`"
              },
              {
                "name": "max_id",
                "value": "",
                "type": "query",
                "description": "Optional filter param`/api/v2/coupons?max_id={value}`"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Number of pages `/api/v2/coupons?page={number}`"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Count per page `/api/v2/coupons?limit={count}`"
              },
              {
                "name": "exclude_type",
                "value": "",
                "type": "query",
                "description": "|Type|\n|-|\n|`per_item_discount`|\n|`percentage_discount`|\n|`per_total_discount`|\n|`shipping_discount`|\n|`free_shipping`|\n|`promotion`|"
              }
            ]
          },
          "docs": "Returns a list of *Coupons*. Default sorting is by coupon/discount id, from lowest to highest. You can pass in optional filter parameters. We recommended using `?min_id=x&limit=y` to paginate through a large set of data because it offers better performance.\n\n## Usage Notes\n\nAvailable types for `type` and `exclude_type` filters:\n\n|Type|\n|-|\n|`per_item_discount`|\n|`percentage_discount`|\n|`per_total_discount`|\n|`shipping_discount`|\n|`free_shipping`|\n|`promotion`|\n\nCoupons with `type=promotion` will"
        },
        {
          "info": {
            "name": "BigCommerce Create a New Coupon",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/coupons",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a *Coupon*.\n\n**Required Fields**\n*   `name`\n*   `code`\n*   `type`\n*   `amount`\n*   `applies_to`\n\n**Read Only Fields**\n*   `id`\n*   `num_uses`\n\n**Notes**\n\nThe coupon type can be one of the following:\n\n*   `per_item_discount`\n*   `per_total_discount`\n*   `shipping_discount`\n*   `free_shipping`\n*   `percentage_discount`\n\nLegacy coupon codes only work with the store's default currency. Applying a coupon with any other currency other than the store's default will result in the error: \"Coupons"
        },
        {
          "info": {
            "name": "BigCommerce Delete All Coupons",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/coupons",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id:in",
                "value": "",
                "type": "query",
                "description": "Optional param to identify a comma separated list of ids for coupons to delete in a batch. `/api/v2/coupons?id:in=1,2,3`"
              }
            ]
          },
          "docs": "## Usage Notes\n* Deleting a coupon via this endpoint will delete the coupon but not the promotion it is attached to\n"
        },
        {
          "info": {
            "name": "BigCommerce Get a Count of Coupons",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/coupons/count",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ]
          },
          "docs": "Returns a count of all *Coupons* in the store."
        },
        {
          "info": {
            "name": "BigCommerce Update a Coupon",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/coupons/:id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the coupon."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a *Coupon*.\n\n\n**Read Only Fields**\n\n* `id`\n* `num_uses`\n* `date_created`\n\n**Notes**\n\nIf the `applies_to` value is cleared, you can restore it to the coupon by reapplying the `applies_to` value in a new `PUT` request."
        },
        {
          "info": {
            "name": "BigCommerce Delete a Coupon",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/coupons/:id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the coupon."
              }
            ]
          },
          "docs": "Deletes a *Coupon*."
        }
      ]
    }
  ],
  "bundled": true
}