1. CPQ
  2. External Integrations
  3. Inbound Web Services

Understanding the Rest API

Article last updated:

Epicor CPQ is a web service provider, and can listen for inbound requests for data from external systems through our REST API. Some example use cases:

  • You want your ERP system to be able to query a Epicor CPQ quote to get information from that quote, or to get the attached files from the quote.
  • You want a signal from an embedded device in your Internet of Things (IOT) to move a quote to the next phase of a workflow.
  • You want an automated security system to scan all your users in Epicor CPQ on a periodic basis, to ensure data stored on the user records comply with corporate standards.

Your imagination is the limit!  The REST API gives you access to the same full functionality of the Epicor CPQ portal itself.


Open the Rest API documentation by clicking here.

Important

  • The objects used in the REST API have property names in PascalCase. When accessing the API in XML format, these property names are in PascalCase, however to be consistent with conventions, the property names are converted to camelCase when accessing the API in JSON format. Be careful about this small capitalization change between PascalCase and camelCase.
  • Only the Epicor CPQ standard objects and any attributes you create in those standard objects are visible through our REST API.  Custom database tables or views you create in your database are not exposed through the API. To integrate to your custom data, learn more about integrating External Databases.

Authenticating to the REST API

To ensure a secure connection, the REST API supports multiple authentication methods.

  • forms-authentication
  • basic-auth
  • OAuth 2.0 (token authentication)

Connecting to the REST API using OAuth 2.0

The basic steps for using the OAuth 2.0 token are:

  1. Retrieve an OAuth 2.0 JWT token from your Entra ID environment that is registered with the SSO functionality in CPQ
  2. Send the retrieved token with subsequent calls to the API under the header “Authorization”: “Bearer {token}”

 There are multiple ways to retrieve a token. For each you will need the application ID that is registered with the application inside Entra. We currently support:

  • Authorization Code with PKCE
  • Username and Password
Was this article helpful?