Royalmail

ChannelShipper & Royal Mail Public API

Import your orders, retrieve your orders and generate labels.

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Import your orders, retrieve your orders and generate labels.

Endpoints 12

Version

  • GETGet API version details./version

Orders

  • GETRetrieve pageable list of orders/orders?pageSize=25&startDateTime=2024-01-01T00:00:00Z&endDateTime=2024-01-01T00:00:00Z&continuationToken=string
  • POSTCreate orders/orders
  • GETRetrieve pageable list of orders with details/orders/full?pageSize=25&startDateTime=2024-01-01T00:00:00Z&endDateTime=2024-01-01T00:00:00Z&continuationToken=string<b>Reserved for ChannelShipper customers only - please visit <a href="https://channelshipper.com/" target="_self">ChannelShipper.com</a> for more…
  • PUTSet order status/orders/status
  • GETRetrieve specific orders/orders/:orderIdentifiers
  • DELETEDelete orders/orders/:orderIdentifiers<b>Reserved for ChannelShipper customers only - please visit <a href="https://channelshipper.com/" target="_self">ChannelShipper.com</a> for more…
  • GETRetrieve details of the specific orders/orders/:orderIdentifiers/full<b>Reserved for ChannelShipper customers only - please visit <a href="https://channelshipper.com/" target="_self">ChannelShipper.com</a> for more…

Labels

  • GETReturn a single PDF file with generated label and/or associated document(s)/orders/:orderIdentifiers/label?documentType=postageLabel&includeReturnsLabel=true&includeCN=true<b>Reserved for OBA customers only</b> The account "Label format" settings page will control the page format settings used to print the postage label and…

Manifests

  • POSTManifest orders/manifestsFor more information on how to manifest orders using the API, including examples of different use-cases please visit either the <a…
  • GETRetrieve manifest status and documentation/manifests/:manifestGuid
  • POSTRetry failed manifest/manifests/:manifestGuid/retryRequest will result in a 400 response if called within 30 mins of a previously failed manifest or retry attempt.

API details

Authentication
An API key in the Authorization header
Operations
12 operations on 10 pathsGET 7POST 3PUT 1DELETE 1
Main resources
Orders 7Manifests 3Labels 1Version 1
Response formats
application/json
Description format
Swagger 2.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the ChannelShipper & Royal Mail Public API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the ChannelShipper & Royal Mail Public API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get API version details.” (GET /version), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the ChannelShipper & Royal Mail Public API?

Import your orders, retrieve your orders and generate labels. It is listed under E-commerce and has 12 endpoints.

Who publishes the ChannelShipper & Royal Mail Public API?

It is listed from Royalmail's public API description (an OpenAPI document), not published by Royalmail on Swastik Codes. Anyone who controls royalmail.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the ChannelShipper & Royal Mail Public API?

With an API key in the Authorization header.

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

12 operations on 10 paths (7 GET, 3 POST, 1 PUT, 1 DELETE). The largest groups are Orders, Manifests, Labels, Version.

Is forking the ChannelShipper & Royal Mail Public API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.