How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Phorest Purchases API

Point-of-sale purchases, stock adjustments, and till balances.

Phorest Purchases API is one of 14 APIs that Phorest publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Purchases. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://api-gateway-eu.phorest.com/third-party-api-server/api/business, https://api-gateway-us.phorest.com/third-party-api-server/api/business, https://platform.phorest.com/third-party-api-server/api/business.

5 operations 5 paths 5 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api-gateway-eu.phorest.com/third-party-api-server/api/business
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Phorest Purchases API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Username is global/{email}, using the email address Phorest associated with the granted API access. Password is the API password issued by Phorest support.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Purchases 5

Point-of-sale purchases, stock adjustments, and till balances.

GET
/{businessId}/branch/{branchId}/inventorytransaction
List inventory transactions
getInventoryTransactions 4 params → 200
POST
/{businessId}/branch/{branchId}/stock/adjustment
Perform a stock adjustment
performStockAdjustment 2 params body → 204400404429500
POST
/{businessId}/branch/{branchId}/purchase
Create a purchase
createPurchase 2 params body → 201400404429500
GET
/{businessId}/branch/{branchId}/till/{tillId}/balance
Retrieve a till balance
getTillBalance 4 params → 200404
GET
/{businessId}/branch/{branchId}/salefee
List sale fees
getSaleFeeList 5 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are InventoryTransaction (5 properties), PurchaseInput (4 properties), SaleFee (4 properties), TillBalance (4 properties). Each schema is shown below with its type and property counts.

Purchase
TillBalance
object
4 properties
SaleFee
object
4 properties
PurchaseInput
object
4 properties 3 required
InventoryTransaction
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

phorest-purchases-api-openapi.yml Raw ↑

Other APIs Phorest publishes across the network.

Phorest Appointments API
Phorest Bookings API
Phorest Branches API
Phorest Clients API
Phorest Courses API
Phorest Leads API
Phorest Loyalty API
Phorest Products API
Phorest Reporting API
Phorest Reviews API
Phorest Services API
Phorest Staff API
Where this information came from

This is an independent, third-party profile of Phorest Purchases API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.