{
  "opencollection": "1.0.0",
  "info": {
    "name": "ready2order Public Account Token Coupon API",
    "version": "R2-2026.30.2"
  },
  "items": [
    {
      "info": {
        "name": "Coupon",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List coupons",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ready2order.com/v1/coupons",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page you want to display"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items per page"
              },
              {
                "name": "identifier",
                "value": "",
                "type": "query",
                "description": "Identifier/Code of coupon"
              },
              {
                "name": "trainingMode",
                "value": "",
                "type": "query",
                "description": "Trainingmode"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns a paginated list of coupons. Filter by `identifier` to look up a coupon by its code (e.g. scanned from a barcode)."
        },
        {
          "info": {
            "name": "Create a coupon",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ready2order.com/v1/coupons",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Creates a new coupon. `coupon_identifier` is auto-generated as an EAN-13 code if omitted. Set `coupon_purpose` to \"single\" or \"multi\" to control when VAT is due: at issuance or at redemption."
        },
        {
          "info": {
            "name": "Get a coupon",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ready2order.com/v1/coupons/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Coupon ID to find"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns a single coupon by its ID, including its current balance in coupon_value."
        },
        {
          "info": {
            "name": "Update a coupon",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.ready2order.com/v1/coupons/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Coupon ID to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Updates coupon metadata such as name, validity dates, category, or customer assignment. To adjust the balance, use the charge or redeem endpoints instead."
        },
        {
          "info": {
            "name": "Delete a coupon",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.ready2order.com/v1/coupons/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Coupon ID to delete"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Deletes a coupon."
        },
        {
          "info": {
            "name": "Charge a coupon",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ready2order.com/v1/coupons/:id/charge",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Coupon ID to charge"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Adds value to an existing coupon's balance, for example when a customer tops up a voucher card."
        },
        {
          "info": {
            "name": "Redeem a coupon",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ready2order.com/v1/coupons/:id/redeem",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Coupon ID to redeem"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Deducts the specified value from the coupon's balance. Partial redemptions are supported. Returns the updated coupon with the new balance in `coupon_value`."
        }
      ]
    }
  ],
  "bundled": true
}