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

Royal Mail Orders API

The Orders API from Royal Mail — 5 operation(s) for orders.

Royal Mail Orders API is one of 10 APIs that Royal Mail publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, /api/v1.

7 operations 5 paths 38 schemas 1 DELETE4 GET1 POST1 PUT

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.royalmail.net/shipping/v2
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Royal Mail Orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer).

  • Bearer — Authorization header using the Bearer scheme. Enter 'Bearer [space] and then your token.

Paths & Operations 7

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

Orders 7
GET
/orders/{orderIdentifiers}
Retrieve specific orders
GetSpecificOrdersAsync 1 param → 200400401404500
DELETE
/orders/{orderIdentifiers}
Delete orders
DeleteOrdersAsync 1 param → 200400401403404500
PUT
/orders/status
Set order status
UpdateOrdersStatusAsync body → 200400401404500
GET
/orders/{orderIdentifiers}/full
Retrieve details of the specific orders
GetSpecificOrdersWithDetailsAsync 1 param → 200400401403404500
GET
/orders
Retrieve pageable list of orders
GetOrdersAsync 4 params → 200400401404500
POST
/orders
Create orders
CreateOrdersAsync body → 200400401500
GET
/orders/full
Retrieve pageable list of orders with details
GetOrdersWithDetailsAsync 4 params → 200400401403404500

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are GetOrderDetailsResource (34 properties), CreateOrderRequest (24 properties), PostageDetailsRequest (18 properties), ProductItemRequest (16 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
3 properties 1 required
ProductItemRequest
object
16 properties 1 required
GetOrderInfoResource
object
9 properties 2 required
CreateOrderErrorResponse
object
3 properties
CreatePackagesResponse
object
2 properties
Importer
object
15 properties
CreateOrderLabelErrorResponse
object
2 properties
DeletedOrderInfo
object
3 properties
GetOrdersDetailsResponse
object
2 properties
CreateOrderRequest
object
24 properties 5 required
GetTagDetailsResult
object
2 properties
DimensionsRequest
object
3 properties 3 required
BillingDetailsRequest
object
3 properties
ShipmentPackageRequest
object
5 properties 2 required
OrderUpdateError
object
5 properties
UpdateOrderStatusResponse
object
2 properties
GetShippingDetailsResult
object
13 properties 1 required
UpdatedOrderInfo
object
3 properties
OrderFieldResponse
object
2 properties
RecipientDetailsRequest
object
4 properties
PostageDetailsRequest
object
18 properties
GetOrderDetailsResource
object
34 properties 9 required
CreateOrderResponse
object
12 properties 2 required
GetOrdersResponse
object
2 properties
OrderErrorResponse
object
4 properties
SenderDetailsRequest
object
3 properties
DeleteOrdersResource
object
2 properties
CreateOrdersResponse
object
4 properties
GetOrderLineResult
object
6 properties 1 required
OrderErrorInfo
object
4 properties
FailedOrderResponse
object
2 properties
CreateOrdersRequest
object
1 property 1 required
AddressRequest
object
9 properties 3 required
GetPostalDetailsResult
object
13 properties
TagRequest
object
2 properties
UpdateOrdersStatusRequest
object
1 property
UpdateOrderStatusRequest
object
7 properties
LabelGenerationRequest
object
Reserved for OBA customers only.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

royal-mail-orders-api-openapi.yml Raw ↑

Other APIs Royal Mail publishes across the network.

Royal Mail API Shipping V2 (REST)
Royal Mail Tracking V2 (REST)
Royal Mail Barcode Allocation V1 (REST)
Royal Mail Local Collect V3 (REST)
Royal Mail Delivery Office Finder V1 (REST)
Royal Mail Labels API
Royal Mail Manifests API
Royal Mail Returns API
Royal Mail Version API
Where this information came from

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