logo

Web Tracking API for Developers (1.0.0)

Download OpenAPI specification:Download

E-mail: contact@example.com URL: http://example.com/contact License: Internal Terms of Service

Web Tracking API for Developers.

Universal Postal Union International Bureau Weltpoststrasse 4 3000 Bern 15 Switzerland

Introduction

The Web Tracking API is a web service giving access to the IPS functionality for tracking one or more mail items.

Web Tracking API

Tracking (single mail item)

For tracking a single mail item.

Request
path Parameters
mail-item-id
string

mail-item-id

language
string^[A-Za-z]2
Default: null

ISO language code; when set, any reference data included in the response is returned along with the translation in the specified language (if it exists in the CT tables).

full-view
boolean
Default: false

Defines whether signature images (converted to Base64) are returned. Set to True only if there is enough bandwidth to transfer large data packages. Not advised for mobile applications.

Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/Tracking/{mail-item-id}/{language}/{full-view}

Track (multiple mail items)

For tracking multiple mail items.

Request
path Parameters
comma-separated-list-of-mail-item-ids
Array of strings

comma-separated-list-of-mail-item-ids

language
string^[A-Za-z]2
Default: null

ISO language code; when set, any reference data included in the response is returned along with the translation in the specified language (if it exists in the CT tables).

full-view
boolean
Default: false

Defines whether signature images (converted to Base64) are returned. Set to True only if there is enough bandwidth to transfer large data packages. Not advised for mobile applications.

Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/Track/{comma-separated-list-of-mail-item-ids}/{language}/{full-view}