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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Frayt

FRAYT Client API

REST API (v2.2) for FRAYT's on-demand and scheduled delivery marketplace. Price a delivery with the match-estimate endpoints, authorize an estimate into a Match, retrieve and update a Match, update a stop to add a driver tip, and cancel a Match. OAuth 2.0 client-credentials issues the bearer token every other call requires. Webhook callbacks (match_update) are declared inline in the OpenAPI so subscribers receive the full Match payload on every state transition.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 5 operations across 3 paths, and defines 30 schemas. It is described by OpenAPI 3.0.0, at version 2.2.

Requests are made against a single base URL, https://api.frayt.com.

5 operations 3 paths 30 schemas 1 DELETE1 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.2
Base URL
https://api.frayt.com/api/v2.2/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

FRAYT Client API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (authorization).

Paths & Operations 5

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

matches 5
POST
/api/v2.2/matches
Create an authorized match
FraytElixirWeb.API.V2x2.MatchController.create body → 201401422
DELETE
/api/v2.2/matches/{id}
Cancel Match
FraytElixirWeb.API.V2x2.MatchController.delete 1 param body → 200400401403404
GET
/api/v2.2/matches/{id}
Get Match
FraytElixirWeb.API.V2x2.MatchController.show 1 param → 200401403404
PATCH
/api/v2.2/matches/{id}
Update Match
FraytElixirWeb.API.V2x2.MatchController.update 1 param body → 200400401403404
PATCH
/api/v2.2/matches/{match_id}/stops/{stop_id}
Update Driver Tip
FraytElixirWeb.API.V2x2.MatchStopController.update 2 params body → 200401403404422

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Match (54 properties), MatchStopResponse (37 properties), MatchStop (37 properties), MatchRequest (26 properties). Each schema is shown below with its type and property counts.

Accessorial
object
An add-on service for a shipment
1 property
Address
object
A Goecoded address
12 properties
AddressRequest
object
A Goecoded address
10 properties 7 required
Bad Request
object
There is an issue with you request
2 properties
Barcode Reading
object
5 properties
CancelMatchRequest
object
DELETE body for canceling a Match
1 property
Contact
object
A contact
4 properties 1 required
Driver
object
A Driver
9 properties
Forbidden
object
Invalid/expired credentials were provided or permissions are insufficient
2 properties
Invalid Parameters
object
Error response when invalid paramaters are passed
1 property
Label
object
A label containing a format and a value used for generating a barcode or QR code.
2 properties
Match
object
A Match
54 properties
MatchRequest
object
POST body for creating a Match
26 properties 3 required
MatchResponse
object
Response schema showing all stops
1 property
MatchStop
object
A Stop on a Match
37 properties 2 required
MatchStopItem
object
An Item to be delivered to a stop
16 properties
MatchStopResponse
object
Response schema showing the stop
37 properties
New MatchStop
object
A Stop on a Match
19 properties 2 required
NewMatchStopItem
object
An Item to be delivered to a stop
14 properties 3 required
Not Found
object
Unable to find resource
2 properties
RestrictedUpdateMatchRequest
object
PATCH body for updating a Match that has not been picked up yet. To update the following fields, you must cancel the match and create a new one: vehicleclass,…
22 properties
SLA
object
SLA schema showing the pickup or delivery windows for a Match
4 properties
StateTransition
object
Details regarding a record's transition from one state to another
6 properties
Stop Timeframe
object
Timeframes for a stop
2 properties
Timeframe
object
Timeframe for a stop
6 properties
Unauthorized
object
No credentials were provided
2 properties
Unprocessible Entity
object
Error response when problematic params are passed
2 properties
Update MatchStop
object
Body for updating a Match Stop.
20 properties
UpdateDriverTip
object
PATCH body for updating the driver tip at a given stop.
1 property 1 required
UpdateMatchStopItem
object
An Item to be delivered to a stop
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

frayt-matches-openapi.yml Raw ↑
#Last Mile Delivery#Logistics#Couriers#Delivery#Shipping#Freight#Routing#Webhook#Authentication
← Back to F APIs
API Details
ID
frayt:frayt-client-api
Base URL
https://api.frayt.com/api/v2.2/
Docs
https://www.frayt.com/frayt-api
Provider
Frayt
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=frayt-frayt-client-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/frayt-frayt-client-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of FRAYT Client 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.