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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/royal-mail-labels-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.

GitHub Google LinkedIn

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 API
  description: Import your orders, retrieve your orders and generate labels.
  version: 1.0.0
servers:
- url: /api/v1
tags:
- name: Labels
paths:
  /orders/{orderIdentifiers}/label:
    get:
      tags:
      - Labels
      summary: Return a single PDF file with generated label and/or associated document(s)
      description: 'Reserved for OBA customers only.


        The account "Label format" settings page will control the page format settings used to print the postage label

        and associated documents.

        '
      operationId: GetOrdersLabelAsync
      parameters:
      - $ref: '#/components/parameters/orderIdentifiers'
      - $ref: '#/components/parameters/documentType'
      - $ref: '#/components/parameters/includeReturnsLabel'
      - $ref: '#/components/parameters/includeCN'
      responses:
        '200':
          description: Return the PDF file with labels
          content:
            application/pdf:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request (Request has missing or invalid parameters and cannot be parsed)
          content:
            application/pdf:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrderErrorResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrderErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden (Feature available for OBA accounts only)
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - Bearer: []
components:
  parameters:
    includeReturnsLabel:
      in: query
      name: includeReturnsLabel
      required: false
      description: Include returns label. Required when documentType is set to 'postageLabel'.
      schema:
        type: boolean
    orderIdentifiers:
      in: path
      name: orderIdentifiers
      required: true
      description: One or several Order Identifiers or Order References separated by semicolon. The maximum number of identifiers is 100.
      schema:
        type: string
    includeCN:
      in: query
      name: includeCN
      required: false
      description: Include CN22/CN23 with label.
      schema:
        type: boolean
    documentType:
      in: query
      name: documentType
      required: true
      description: Document generation mode.
      schema:
        type: string
        enum:
        - postageLabel
        - despatchNote
        - CN22
        - CN23
  schemas:
    ErrorResponse:
      required:
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: string
    OrderErrorResponse:
      type: object
      properties:
        accountOrderNumber:
          type: integer
        channelOrderReference:
          type: string
        code:
          type: string
        message:
          type: string
  securitySchemes:
    Bearer:
      type: apiKey
      description: Authorization header using the Bearer scheme. Enter 'Bearer [space] and then your token.
      name: Authorization
      in: header