Introduction

The CDS API exposes operational and administrative functions of CDS. It can be used both in SOAP and RESTful mode.

This API reference explains each of the API methods, with example SOAP and REST requests and responses included for each.

Authorization

To use the CDS API you need to include a token with each call (a GUID that is associated with one or more API operations). You can create a new CDS API token using the CDS Manage Organization Preferences function (see the CDS Postal User Guide for more information).

Parameters

CDS API calls do not include any parameters. All filters and additional information are passed in the request body.

Enable WS-A addressing for SOAP

If you are sending SOAP calls to the CDS API, you need to enable WS-A addressing, as in the SoapUI example below.