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
Reach

Reach Order API

Manage a Order within Reach.

Documentation Provider Profile APIs.io OpenAPI GitHub

Reach Order API is one of 6 APIs that Reach publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification and 5 JSON Schemas.

This API exposes 7 operations across 6 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.sandbox.withreach.com, https://api.withreach.com.

7 operations 6 paths 21 schemas 1 DELETE3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.withreach.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Reach Order API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth).

Paths & Operations 7

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

Order 7

Manage a Order within Reach.

POST
/v1/orders
Create a new order
createOrder body → 200201400401403415500
GET
/v1/orders/{OrderId}
Retrieve an Order
retrieveOrder 1 param → 200400401403404500
DELETE
/v1/orders/{OrderId}/cancel
Cancel an Order
cancelOrder 1 param → 204400401403404409500
POST
/v1/orders/{OrderId}/capture
Capture an Order
captureOrder 1 param → 200400401403404409500
POST
/v1/orders/{OrderId}/refunds
Issue a refund against an order
createRefund 1 param body → 200400401403404409500
GET
/v1/orders/{OrderId}/refunds
Retrieve a list of refunds for a given order id
getRefundList 1 param → 200400401403500
GET
/v1/orders/{OrderId}/refunds/{RefundId}
Retrieve a refund by id for a given order id
getRefundById 2 params → 200400401403404500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Order (28 properties), BillingProfile (9 properties), Display (8 properties), Payment (6 properties). Each schema is shown below with its type and property counts.

Expiry
object
Card expiry information
2 properties
Times
object
Gives times of various order state transitions
3 properties
Discount
object
A merchant-supplied discount on the entire order. The amount will be subtracted from TotalAmount
2 properties 2 required
Error
object
3 properties 2 required
Order
object
A Reach order, representing a payment attempt. See https://docs.withreach.com/docs/states-and-events for information on the order lifecycle. If created by a se…
28 properties 3 required
Card
object
Payment details for Card type. Must be supplied if Payment.Type is CARD
4 properties
BillingProfile
object
Billing details associated with the payment. Some fields may be required or optional depending on the Country in BillingProfile.Address. See: https://docs.with…
9 properties 5 required
ShippingDetails
object
Customer's shipping details. This is required if physical goods are shipped along with the order.
6 properties 7 required
Item
object
A line item, representing one or more digital or physical goods that a user is paying for.
3 properties 3 required
CaptureResultResource
object
1 property 1 required
Action
object
If additional action must be taken to proceed with a request, this object contains information about the required action.
3 properties
Refund
object
5 properties
Offline
object
Offline payment information.
Display
object
A freeform JSON object which, in the context of the specified request, gives the necessary information for a consumer to proceed. See https://docs.withreach.co…
8 properties
Meta
object
Any optional metadata to be included. Can be a simple reference ID or some complex object containing multiple values, as long as it is valid JSON.
Address
object
A shipping or billing address
5 properties 3 required
FieldErrors
object
3 properties 3 required
Paypal
object
Payment details specific to PayPal.
1 property
Ideal
object
Payment details specific to iDeal.
1 property
Payment
object
Object representing the payment information for an order
6 properties
Online
object
Contains payment details for Online payment types.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

withreach-order-api-openapi.yml Raw ↑

Other APIs Reach publishes across the network.

Transaction Details API
AE Profile APIs.io
Reach GET API
AE Profile APIs.io
Reach POST API
AE Profile APIs.io
Reach Quote API
AE Profile APIs.io
Reach Session API
AE Profile APIs.io
#Order
← Back to R APIs
API Details
ID
withreach:withreach-order-api
Base URL
https://api.withreach.com
Docs
https://docs.withreach.com/docs/checkout-api.md
Provider
Reach
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=withreach-order-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/withreach-order-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 Reach Order 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.