Royalmail ChannelShipper & Royal Mail Public API

Name: ChannelShipper & Royal Mail Public API
Brand: ChannelShipper & Royal Mail Public API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsEmail DeliveryapiKey9 EndpointsREST

For Agents

Install Jentic One Beta

Connect the ChannelShipper & Royal Mail Public API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ChannelShipper & Royal Mail Public API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Froyalmail.com%2Froyalmail" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Froyalmail.com%2Froyalmail" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with ChannelShipper & Royal Mail Public API.

Create orders

Retrieve pageable list of orders

Set order status

Delete orders

GET STARTED

Start building with ChannelShipper & Royal Mail Public API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use ChannelShipper & Royal Mail Public API for, with concrete tasks.

★ Communications Operations

Use the ChannelShipper & Royal Mail Public API to perform communications operations programmatically. The API provides 9 endpoints covering core functionality including create orders, retrieve pageable list of orders, retrieve pageable list of orders with details.

Call POST /orders to create orders

Automated Rate Limits Management

Automate rate limits operations by combining multiple ChannelShipper & Royal Mail Public API endpoints. Agents can retrieve pageable list of orders and then retrieve pageable list of orders with details in a single workflow.

Call GET /orders to retrieve pageable list of orders, then verify the result

AI Agent Integration via Jentic

AI agents discover and call ChannelShipper & Royal Mail Public API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Search Jentic for 'create orders', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

9 endpoints — import your orders, retrieve your orders and generate labels.

METHOD

PATH

DESCRIPTION

POST

/orders

Create orders

GET

/orders

Retrieve pageable list of orders

GET

/orders/full

Retrieve pageable list of orders with details

PUT

/orders/status

Set order status

GET

/orders/{orderIdentifiers}

Retrieve specific orders

DELETE

/orders/{orderIdentifiers}

Delete orders

GET

/orders/{orderIdentifiers}/full

Retrieve details of the specific orders

GET

/orders/{orderIdentifiers}/label

Return a single PDF file with generated label and/or associated document(s)

POST

/orders

Create orders

GET

/orders

Retrieve pageable list of orders

GET

/orders/full

Retrieve pageable list of orders with details

PUT

/orders/status

Set order status

GET

/orders/{orderIdentifiers}

Retrieve specific orders

DELETE

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the ChannelShipper and Royal Mail Public API by hand means passing your key in the Authorization header and building your own pagination and status handling across the orders collection. Through Jentic you install once, import the ChannelShipper and Royal Mail Public API from the API Directory, store the key once, and your agent calls it.

Permission scoping

This API puts the order identifiers in the URL path (/orders/{orderIdentifiers}), so a rule can pin your agent to specific orders: it can read those orders and nothing else. You choose the operations it may call, so order deletion and status changes are not included unless you add them.

Credential isolation

Your Royal Mail API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'create shipping orders' or 'check an order's status', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using ChannelShipper & Royal Mail Public API through Jentic.

What authentication does the ChannelShipper & Royal Mail Public API use?

The ChannelShipper & Royal Mail Public API uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

Can I create orders with the ChannelShipper & Royal Mail Public API?

Yes. Use the POST /orders endpoint. The API returns structured JSON responses that agents can parse and act on directly.

What are the rate limits for the ChannelShipper & Royal Mail Public API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

How do I create orders through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create orders'. Jentic returns the matching ChannelShipper & Royal Mail Public API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

How many endpoints does the ChannelShipper & Royal Mail Public API have?

The ChannelShipper & Royal Mail Public API exposes 9 endpoints covering rate limits, version, orders operations.

Can I limit what my agent is allowed to do with the Royal Mail Click and Drop API?

Yes. Because Jentic One is self-hosted, you decide which operations your agent may call, so you can grant read access through GET /orders and GET /orders/{orderIdentifiers} while withholding POST /orders, PUT /orders/status, and DELETE /orders/{orderIdentifiers}. Since the order identifiers sit in the URL path, your own rules can pin the agent to specific orders, letting it read those and nothing else. Order deletion and status changes stay out of reach unless you explicitly add them.

Royalmail ChannelShipper & Royal Mail Public API

Connect the ChannelShipper & Royal Mail Public API to your agent

Capabilities

Start building with ChannelShipper & Royal Mail Public API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs