{
  "opencollection": "1.0.0",
  "info": {
    "name": "Phorest Third-Party Appointments Purchases API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Purchases",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List inventory transactions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/inventorytransaction",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "branchId",
                "value": "",
                "type": "path",
                "description": "The Phorest branch (location) identifier."
              },
              {
                "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 inventory transactions (stock movements) for a branch. Confirmed: developer.phorest.com/reference/getinventorytransactions."
        },
        {
          "info": {
            "name": "Perform a stock adjustment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/stock/adjustment",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "branchId",
                "value": "",
                "type": "path",
                "description": "The Phorest branch (location) identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Manually adjusts stock quantities for one or more products by barcode. Confirmed: developer.phorest.com/reference/performstockadjustment."
        },
        {
          "info": {
            "name": "Create a purchase",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/purchase",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "branchId",
                "value": "",
                "type": "path",
                "description": "The Phorest branch (location) identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Records a point-of-sale purchase (appointments, products, courses, and/or vouchers) against a client, automatically updating stock. Also emits a purchase event onto a partner-provisioned AWS SQS queue per Phorest's public sqs-sample reference project. Confirmed: developer.phorest.com/reference/createpurchase."
        },
        {
          "info": {
            "name": "Retrieve a till balance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/till/:tillId/balance",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "branchId",
                "value": "",
                "type": "path",
                "description": "The Phorest branch (location) identifier."
              },
              {
                "name": "tillId",
                "value": "",
                "type": "path"
              },
              {
                "name": "includeIntegratedPayments",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves the till balance for a branch till, optionally including integrated-payment balances. Confirmed: developer.phorest.com/reference/gettillbalance."
        },
        {
          "info": {
            "name": "List sale fees",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/salefee",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "branchId",
                "value": "",
                "type": "path",
                "description": "The Phorest branch (location) identifier."
              },
              {
                "name": "includeArchived",
                "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 configured sale fees (e.g. card-processing or service fees) for a branch. Confirmed: developer.phorest.com/reference/getsalefeelist."
        }
      ]
    }
  ],
  "bundled": true
}