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

Patch Orders API

Place, retrieve, place, and cancel carbon credit and removal orders.

Patch Orders API is one of 4 APIs that Patch 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, API documentation, rate-limit docs, and 5 JSON Schemas.

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

Requests are made against a single base URL, https://api.patch.io.

7 operations 5 paths 21 schemas 2 DELETE2 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2
Base URL
https://api.patch.io/
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Patch Orders API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (bearer_auth).

  • bearerAuth — API key bearer token issued from the Patch dashboard. Sandbox and live keys are separated.
  • bearer_auth — Bearer token API key obtained from the Patch dashboard. Use test keys for sandbox and production keys for live orders.

Paths & Operations 7

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

Orders 7

Place, retrieve, place, and cancel carbon credit and removal orders.

GET
/v1/orders
List Orders
retrieveOrders 3 params → 200401
POST
/v1/orders
Create An Order
createOrder body → 200400401
GET
/v1/orders/{id}
Retrieve An Order
retrieveOrder 1 param → 200401404
DELETE
/v1/orders/{id}
Deletes a draft order
delete_order 2 params → 200401404
DELETE
/v1/orders/{uid}
Delete An Order
deleteOrder 1 param → 200401404
PATCH
/v1/orders/{id}/place
Place An Order
placeOrder 1 param → 200400401404
PATCH
/v1/orders/{id}/cancel
Cancel An Order
cancelOrder 1 param → 200400401404

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Order (13 properties), Order_2 (13 properties), CreateOrderRequest (11 properties), CreateOrderRequest_2 (11 properties). Each schema is shown below with its type and property counts.

CreateOrderRequest
object
11 properties
OrderIssuedTo
object
End beneficiary that credits should be issued and attributed to.
2 properties
Meta
object
Pagination and response metadata block returned on list endpoints.
2 properties
ErrorResponse
object
4 properties
Order
object
13 properties
OrderResponse
object
4 properties
OrderLineItemProject
object
2 properties
DeleteOrderResponse
object
4 properties
OrderLineItem
object
9 properties
OrderListResponse
object
4 properties
CreateOrderRequest_2
object
Request body for creating a new order
11 properties
OrderIssuedTo_2
object
Entity to whom the carbon credits are issued
2 properties
MetaIndexObject
object
Pagination metadata
3 properties
ErrorResponse_2
object
API error response
2 properties
Order_2
object
A carbon offset order
13 properties
OrderResponse_2
object
API response wrapping an Order
3 properties
PlaceOrderRequest
object
Optional request body for placing an order
1 property
OrderLineItemProject_2
object
Project reference within an order line item
2 properties
DeleteOrderResponse_2
object
API response confirming order deletion
3 properties
OrderLineItem_2
object
An individual line item within an order
9 properties
OrderListResponse_2
object
API response wrapping a list of Orders
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

patch-io-orders-api-openapi.yml Raw ↑

Other APIs Patch publishes across the network.

Patch Order Line Items API
Patch Projects API
Patch Technology Types API
Where this information came from

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