cpq-rest-api

Oracle CPQ REST API Standards & Collection Operations

Query Filtering with q Parameter

Oracle CPQ REST collections use MongoDB-style JSON syntax for filtering:

GET /rest/v19/commerceDocumentsOraclecpqoTransaction?q={"status_t":{"$eq":"CREATED"}}

Comparison Operators:

• $eq / $ne: Equality / inequality ({"status_t":{"$eq":"CREATED"}})
• $gt / $gte: Greater than / greater than or equal ({"totalAmount_t":{"$gte":1000}})
• $lt / $lte: Less than / less than or equal ({"quantity":{"$lt":50}})
• $exists: Field existence check ({"createdBy":{"$exists":true}})

Logical Operators:

• $and: Conjunction of conditions ?q={"$and":[{"status_t":{"$eq":"PENDING"}},{"totalAmount_t":{"$gt":500}}]}
• $or: Disjunction of conditions ?q={"$or":[{"status_t":{"$eq":"CREATED"}},{"status_t":{"$eq":"DRAFT"}}]}

Sorting with orderBy

Order results using orderBy=attributeName:[asc|desc]. Comma-separated for multiple fields:

GET /rest/v19/commerceDocumentsOraclecpqoTransaction?orderBy=dateModified_t:desc,transactionID_t:asc

Pagination

Control page windows using limit, offset, and request total counts:

• limit: Maximum records per response (1 to 1000, default 25).
• offset: Starting record index (0-based).
• totalResults: Set ?totalResults=true to include the total record count.

Response metadata structure:

{
  "items": [...],
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "count": 25,
  "totalResults": 142,
  "links": [{"rel": "next", "href": "..."}]
}

Hierarchical Expansion with expand

Retrieve child objects/subdocuments inline in a single request:

GET /rest/v19/commerceDocumentsOraclecpqoTransaction/{id}?expand=items,lineItems

Standard HTTP Status Codes & Error Handling

• 200 OK: Request succeeded.
• 201 Created: Resource created successfully.
• 204 No Content: Successful execution with empty body (DELETE / Actions).
• 400 Bad Request: Validation error or malformed query q syntax.
• 401 Unauthorized / 403 Forbidden: Authentication / Permission failure.
• 404 Not Found: Resource or URI does not exist.
• 409 Conflict: Optimistic locking or concurrent modification conflict.
• 500 Internal Server Error: Unhandled CPQ server or BML exception.