Retrieves all the quotes belonging to the user based on the proper access rights
get
/ccstore/v1/selfservice/quotes
Retrieves all the quotes belonging to the user based on the proper access rights. If the profile is not logged in or is anonymous then the endpoint will fail. The user will be granted required access rights based on which the listQuotes will return all the quotes belonging to the user or all the quotes belonging to the organization
Request
Supported Media Types
- application/json
Query Parameters
-
fields: string
This controls which fields are returned in the response body. For example, to include the field1 and field2 for each quote in the list, you can send fields=field1,field2.
-
limit: string
The batch size of the quotes list to be fetched together. Max Limit is 250.
-
offset: string
The offset of the page. By default, offset is 0, which means first page will be returned.
-
orderby: string
Specifies a comma-separated list of pairs to order the response by.
-
q: string
"Search criteria to filter the search results based on various fields like first Name etc. Following are the fields supported by this param: \n\n|Field|Type|Description|\n|------------------|------------------|------------------|\n|partyId|string|PartyId associated with the customer profile|\n|status|string|status of the order eg. CREATED|",
-
totalResults: boolean
Indicates if the total results should be included in the response.
Response
Supported Media Types
- application/json
200 Response
Response containing the list quotes
Root Schema : ListQuotesResponse
Example:
{
"offset":0,
"limit":2,
"count":2,
"hasMore":true,
"items":[
{
"totalOneTimeListAmount_t":{
"currency":"USD",
"value":100
},
"proposal_customer_email":null,
"_pp_id":null,
"lastUpdatedDate_t":"2023-02-20T07:39:00Z",
"owner_t":"Super User",
"_document_var_name":"transaction",
"_process_var_name":"oraclecpqo",
"lastPricedDate_t":"2023-02-20T07:39:00Z",
"_step_var_name":"pending_process",
"_customer_id":"1006",
"_customer_t_company_name":"National Discount Auto Parts",
"totalAnnualValue_t":{
"currency":"USD",
"value":0
},
"totalOneTimeNetAmount_t":{
"currency":"USD",
"value":100
},
"maxRequestDate_t":"2023-02-20",
"totalContractValue_t":{
"currency":"USD",
"value":100
},
"_customer_t_email":null,
"totalMonthlyListAmount_t":{
"currency":"USD",
"value":0
},
"createdDate_t":"2023-02-20",
"_date_modified":"2023-02-20T07:39:26.000Z",
"_last_document_number":2,
"version_t":1,
"transactionID_t":"CPQ-831-37084926",
"_buyer_company_name":"icpq-018",
"test_email":null,
"totalMonthlyDiscount_t":{
"currency":"USD",
"value":0
},
"_date_added":"2023-02-20T07:39:25.000Z",
"_supplier_company_name":"icpq-018",
"transactionName_t":null,
"version_number_versionTransaction_t":"1",
"_id":37084926,
"cC_OrderId_t":"o30415",
"_currency_pref":{
"id":5190368,
"currencyCode":"USD"
},
"_pp_name":null,
"priceWithinPolicy_t":true,
"totalOneTimeDiscount_t":{
"currency":"USD",
"value":0
},
"status_t":{
"displayValue":"Created",
"value":"CREATED"
},
"totalMonthlyNetAmount_t":{
"currency":"USD",
"value":0
}
},
{
"totalOneTimeListAmount_t":{
"currency":"USD",
"value":100
},
"proposal_customer_email":null,
"_pp_id":null,
"lastUpdatedDate_t":"2023-02-28T06:57:00Z",
"owner_t":"Super User",
"_document_var_name":"transaction",
"_process_var_name":"oraclecpqo",
"lastPricedDate_t":"2023-02-28T06:57:00Z",
"_step_var_name":"pending_process",
"_customer_id":"1006",
"_customer_t_company_name":"National Discount Auto Parts",
"totalAnnualValue_t":{
"currency":"USD",
"value":0
},
"totalOneTimeNetAmount_t":{
"currency":"USD",
"value":100
},
"maxRequestDate_t":"2023-02-28",
"totalContractValue_t":{
"currency":"USD",
"value":100
},
"_customer_t_email":null,
"totalMonthlyListAmount_t":{
"currency":"USD",
"value":0
},
"createdDate_t":"2023-02-28",
"_date_modified":"2023-02-28T06:57:12.000Z",
"_last_document_number":2,
"version_t":1,
"transactionID_t":"CPQ-841-37088597",
"_buyer_company_name":"icpq-018",
"test_email":null,
"totalMonthlyDiscount_t":{
"currency":"USD",
"value":0
},
"_date_added":"2023-02-28T06:57:11.000Z",
"_supplier_company_name":"icpq-018",
"transactionName_t":null,
"version_number_versionTransaction_t":"1",
"_id":37088597,
"cC_OrderId_t":"o40411",
"_currency_pref":{
"id":5190368,
"currencyCode":"USD"
},
"_pp_name":null,
"priceWithinPolicy_t":true,
"totalOneTimeDiscount_t":{
"currency":"USD",
"value":0
},
"status_t":{
"displayValue":"Created",
"value":"CREATED"
},
"totalMonthlyNetAmount_t":{
"currency":"USD",
"value":0
}
}
]
}400 Response
Bad query params in the request
Root Schema : Error
Type:
Show Source
object-
message:
string
The error message
-
status:
string
The Error code