ChannelShipper & Royal Mail Public API

royalmail · Commerce

Commerce No Auth Free & Open ecommerce

Import your orders, retrieve your orders and generate labels.

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Retrieve pageable list of orders

Retrieve pageable list of orders

https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders?pageSize=25&endDateTime=example&startDateTime=example&continuationToken=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders?pageSize=25&endDateTime=example&startDateTime=example&continuationToken=example"

import requests
params = {
    "pageSize": "25",
    "endDateTime": "example",
    "startDateTime": "example",
    "continuationToken": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders');
url.searchParams.set('pageSize', '25');
url.searchParams.set('endDateTime', 'example');
url.searchParams.set('startDateTime', 'example');
url.searchParams.set('continuationToken', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders")
	q := baseURL.Query()
	q.Set("pageSize", "25")
	q.Set("endDateTime", "example")
	q.Set("startDateTime", "example")
	q.Set("continuationToken", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders")
uri.query = URI.encode_www_form({
  "pageSize" => "25",
  "endDateTime" => "example",
  "startDateTime" => "example",
  "continuationToken" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders?" . http_build_query([
    "pageSize" => "25",
    "endDateTime" => "example",
    "startDateTime" => "example",
    "continuationToken" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get API version details.

Get API version details.

https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/version

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/version"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/version",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/version';

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/version"
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/version")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/version";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Retrieve pageable list of orders with details

Reserved for ChannelShipper customers only - please visit ChannelShipper.com for more information

https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders/full?pageSize=25&endDateTime=example&startDateTime=example&continuationToken=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders/full?pageSize=25&endDateTime=example&startDateTime=example&continuationToken=example"

import requests
params = {
    "pageSize": "25",
    "endDateTime": "example",
    "startDateTime": "example",
    "continuationToken": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders/full",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders/full');
url.searchParams.set('pageSize', '25');
url.searchParams.set('endDateTime', 'example');
url.searchParams.set('startDateTime', 'example');
url.searchParams.set('continuationToken', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders/full")
	q := baseURL.Query()
	q.Set("pageSize", "25")
	q.Set("endDateTime", "example")
	q.Set("startDateTime", "example")
	q.Set("continuationToken", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders/full")
uri.query = URI.encode_www_form({
  "pageSize" => "25",
  "endDateTime" => "example",
  "startDateTime" => "example",
  "continuationToken" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/royalmail.com/click-and-drop/1.0.0/orders/full?" . http_build_query([
    "pageSize" => "25",
    "endDateTime" => "example",
    "startDateTime" => "example",
    "continuationToken" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with ChannelShipper & Royal Mail Public API?

ChannelShipper & Royal Mail Public API is a Commerce API. Developers commonly use commerce APIs for:

syncing product catalogues and inventory levels
building price comparison and deal-finder tools
processing orders and tracking shipments
managing customer wishlists and reviews
automating abandoned-cart and promotional emails

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. ChannelShipper & Royal Mail Public API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗