{
  "opencollection": "1.0.0",
  "info": {
    "name": "Phorest Third-Party Appointments Vouchers API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Vouchers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List vouchers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/voucher",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "clientId",
                "value": "",
                "type": "query"
              },
              {
                "name": "serialNumber",
                "value": "",
                "type": "query"
              },
              {
                "name": "includeUsed",
                "value": "",
                "type": "query"
              },
              {
                "name": "updated_from",
                "value": "",
                "type": "query"
              },
              {
                "name": "updated_to",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Records per page. Max 100, defaults to 20."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Zero-indexed page number. Defaults to 0."
              }
            ]
          },
          "docs": "Lists gift vouchers for a business, filterable by client, serial number, and update time. Confirmed: developer.phorest.com/reference/getvouchers."
        },
        {
          "info": {
            "name": "Create a voucher",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/voucher",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a gift voucher for a business. Confirmed: developer.phorest.com/reference/createvoucher."
        },
        {
          "info": {
            "name": "Retrieve a voucher",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/voucher/:voucherId",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "voucherId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a single voucher by ID. Confirmed: developer.phorest.com/reference/getvoucher."
        },
        {
          "info": {
            "name": "Update a voucher's balance",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/voucher/:voucherId",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "voucherId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a voucher's remaining balance. Confirmed: developer.phorest.com/reference/updatevoucherbalance."
        }
      ]
    }
  ],
  "bundled": true
}