Skip to main content
Version: V2

Customer

The Customers API allows you to manage customer data within the CPQ system. It provides endpoints for retrieving, creating, updating, and deleting customer records and profiles. This API is essential for maintaining accurate and up-to-date customer information for sales and support processes.

Features and Functionalities​

The Customers API has the following functionalities:

Manage Customer​

  • Endpoint:
    • GET /v2/customer/{id:int}: Retrieve a specific customer by their ID.
    • GET /v2/customer/: Retrieve a list of all customers.
    • GET /v2/customer/onlinesearch/{cpqId:long}: Perform an online search for customers associated with a specific CPQ ID.
    • POST /v2/customer: Create a new customer.
    • PUT /v2/customer: Update an existing customer.
    • PUT /v2/customer/{id:int}/owners: Update the owners of a specific customer.
    • POST /v2/customer/{id:int}/owner/{ownerId:long}: Add an owner to a specific customer.
    • PUT /v2/customer/{id:int}/owner/change: Change the owner of a specific customer.
    • POST /v2/customer/customerprofile: Create a new customer profile.
    • DELETE /v2/customer/customerprofile: Delete a customer profile.
  • Description: These endpoints allow for the management of customer data, including retrieval, creation, updating, and deletion of customer records and profiles.
  • Use Case: Use these endpoints to manage customer information within the system, ensuring that customer data is up-to-date and accurate for sales and support processes.