Welcome to the CPC REST API.

This is the root path for requests to the REST API. To find more information about available calls, check the API Version 2 or API Version 3 OpenAPI Specification.

Key Features of CPC API V3:

• Supports Pagination
  • There are two parameters that are required for pagination –
  • offset: This indicates how many items should be skipped. If not specified, no items are skipped (same as offset=0).
  • limit: This indicates the maximum number of items to return. If not specified, a default value of 1000 is applied automatically.
  • For ex: returns at most 100 sales channels starting at the 100th: /saleschannels?offset=100&limit=100

• Content Negotiation
  • API supports exposing response data in json as well as xml format.
  • To request data in xml, pass header 'accept: application/xml'. json is enabled by default.

• V3 also provides date request parameter. Any data modified after the provided date will be returned. Date format is ISO yyyy-MM-dd’T’HH:mm:ss.SSSXXX — for example, “2000-10-31T01:30:00.000-05:00”

• API contract differs widely between V2 and V3 – though context of the data and expectations remain the same. Please access swagger to see the contracts.

• Consumers should still plan on persisting data at their end as was with prior versions of the API.

• Basic domains [ Trees / Saleschannels / Groups & Products ] remain same / consistent with prior versions of API. Please note as-of-now, the V3 is not exposing any new data - data is same as V2 for most part.

API Documentation for V3:

All available endpoints are documented on OpenApi Specification.

Since this is OpenAPI specification, developers can download / save / import specification or import directly from the link in Postman or other tools of their choice.

The endpoints are secured and proper tokens are required to access them.