Royal Mail Manifests API
The Manifests API from Royal Mail — 3 operation(s) for manifests.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/royal-mail-manifests-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: ChannelShipper & Royal Mail Public Labels Manifests API
description: Import your orders, retrieve your orders and generate labels.
version: 1.0.0
servers:
- url: /api/v1
tags:
- name: Manifests
paths:
/manifests:
post:
tags:
- Manifests
summary: Manifest eligible orders
description: 'Manifest all orders in ''Label Generated'' and ''Despatched'' statuses and return manifest paperwork where possible.
'
operationId: ManifestEligibleAsync
responses:
'201':
description: The Manifest all eligible orders request was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestOrdersResponse'
'202':
description: The Manifest eligible orders request was successful but PDF is not yet available.
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestOrdersResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestErrorsResponse'
'401':
description: Unauthorized
'403':
description: Forbidden (Feature not available)
'404':
description: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestErrorsResponse'
security:
- Bearer: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestEligibleOrdersRequest'
/manifests/retry/{manifestIdentifier}:
post:
tags:
- Manifests
summary: Retry manifest
description: Retry a manifest operation if the eligible orders were not able to be successfully processed.
operationId: RetryManifestAsync
parameters:
- $ref: '#/components/parameters/manifestIdentifier'
responses:
'201':
description: The Retry Manifest request was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestOrdersResponse'
'202':
description: The retry request was successfully processed but documentation is not yet available.
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestOrdersResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestErrorsResponse'
'401':
description: Unauthorized
'403':
description: Forbidden (Feature not available)
'404':
description: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestErrorsResponse'
security:
- Bearer: []
/manifests/{manifestIdentifier}:
get:
tags:
- Manifests
summary: Get manifest
description: Retrieve manifest paperwork for a previously successful manifest eligible orders call.
operationId: GetManifestAsync
parameters:
- $ref: '#/components/parameters/manifestIdentifier'
responses:
'200':
description: The Get Manifest request was successfully processed.
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestDetailsResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestErrorsResponse'
'401':
description: Unauthorized
'403':
description: Forbidden (Feature not available)
'404':
description: Not Found
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ManifestErrorsResponse'
security:
- Bearer: []
components:
schemas:
ManifestDetailsResponse:
type: object
required:
- manifestNumber
properties:
manifestNumber:
type: number
status:
type: string
enum:
- In Progress
- Completed
- Failed
documentPdf:
type: string
description: manifest in format base64 string
ManifestOrdersResponse:
type: object
required:
- manifestNumber
properties:
manifestNumber:
type: number
documentPdf:
type: string
description: manifest in format base64 string
ManifestErrorsResponse:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/ManifestErrorsErrorDetailsResponse'
ManifestEligibleOrdersRequest:
type: object
properties:
carrierName:
type: string
description: The name of the carrier to manifest orders for.
ManifestErrorsErrorDetailsResponse:
type: object
properties:
code:
type: string
description:
type: string
parameters:
manifestIdentifier:
in: path
name: manifestIdentifier
required: true
description: The manifest number returned from the initial manifest eligible orders endpoint call
schema:
type: integer
securitySchemes:
Bearer:
type: apiKey
description: Authorization header using the Bearer scheme. Enter 'Bearer [space] and then your token.
name: Authorization
in: header