Some real-world examples of queries made to the inboud Rest API. You can test these out using your own org and a rest API tool, such as Postman.
Your imagination is the limit! The REST API gives you access to the same full functionality of the Epicor CPQ portal itself. Learn more by...
- browsing the Rest API documentation.
log in to your Epicor CPQ org with your browser, and activate DevTools in your web browser to observe how API calls are made from the browser during usual operations. These can inspire your own REST calls.
Some examples may not work for you.
The examples here may contain specific references to objects that don't exist in your org. For example, a query for quote 500 may fail if you only have 200 quotes in your org. Please review the specific parameters in the examples, and ensure they would be valid in your org.
Finding a specific record
Finding a record by ID
{
"fields": ["id", "idQuote", "idProduct"],
"take": 5,
"filters": [
{
"label": "Id",
"type": "property",
"property": "id",
"values": [2],
"$key": "id"
}
],
"nestedPath": null,
"nestedFields": []
}
Finding records that match a criteria
A list of quotes that have a state of "Build Failed"
{
fields: [
"id",
"state",
"ownedBy",
"idCustomer",
"idContact",
"name",
"description",
"currency",
"createdDate",
"modifiedDate",
"owner",
"customer",
"contact",
"products.id",
"products.idQuote",
"products.quote",
"products.currency",
"products.isConfigured",
"products.price",
"products.createdDate",
"products.modifiedDate",
"products.createdBy",
"products.name",
"products.description",
"products.shortDescription",
"products.sku",
"products.imagePath",
"products.idParent",
"products.idMainParent",
"files.tags.id",
"files.tags.name",
"files.id",
"files.name",
"files.source",
"files.status",
"files.filePath",
"totalPrice"
],
sortField: "modifiedDate",
descending: true,
skip: 0,
take: 42,
filters: [
{
label: "State",
type: "property",
property: "state",
sourceType: "states",
control: "multiSelect",
valueField: "value",
labelField: "label",
headerField: "label",
values: [
"Build Failed"
],
$key: "states"
}
],
nestedPath: null,
nestedFields: [ ]
}