Retrieving the reasons for changing the quote status
GET {{api-url}}/quote/{{tenant}}/quote-reasons?pageSize=60&pageNumber=1&sort=<string>&q=<string>&fields=<string>
Retrieves reasons for changing the quote status.
Required scopes
quote.quote_read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageSize | number | Number of items to be retrieved per page. | |
pageNumber | number | Page number to be retrieved. The number of the first page is 1. | |
sort | string | List of properties used to sort the results, separated by commas. The order of properties indicates their priority in sorting. |
Possible values:
{fieldName}{fieldName}.asc{fieldName}.desc
Note: If you want to sort the results by localized properties, the possible values are:
{fieldName}.{language}{fieldName}.{language}.asc{fieldName}.{language}.desc
If the sorting direction is not specified, the fields are sorted in ascending order. |
| q | string | | A standard query parameter is used to search for specific values.
- Searching for items by string-based properties:
- By a field value:
q=siteCode:main, wheresiteCodeis the field name, andmainis its desired value. - By a localized field value:
q=items.product.name.en:apple_lobo, wherenameis the field name of product,enis the language code, andapple_lobois the field value expressed in the specified language. Note: This query works only for localized fields, which are stored in a map format, wherekeyis the language code andvalueis the translation to particular language.
- By a field value:
- Searching for items by a number-based property:
- With a specific value:
q=items.quantity.quantity:20 - With a value greater than:
q=items.quantity.quantity:>20 - With a value lower than:
q=items.quantity.quantity:<20 - With a value greater than or equal to:
q=items.quantity.quantity:>=20 - With a value lower than or equal to:
q=items.quantity.quantity:<=20 - With a value within a range of values:
q=items.quantity.quantity:(>=10 AND <=20)
whereitems.quantity.quantityis the name of the number-based field, and20is its querying value.
- With a specific value:
- Searching for items by a date-based property: All numer-based property queries are also valid for dates. In that case, the date should be placed within double quotes:
q=metadataCreatedAt:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z") - Searching for items by a boolean-based property:
q=description.multiLanguage:true, wheredescription.multiLanguageis the boolean field name, andtrueis its desired value. - Searching for items with a nonexistent or empty property:
q=description.en:null, wheredescription.enis the field that has its value set tonull. - Searching for items with an existing property:
q=mixin:exists, wheremixinis the field that has a non-empty value. - Searching for items by multiple specific values:
q=id:(5c3325baa9812100098ff48f,5c3325d1a9812100098ff494), whereidis the field name, and strings within the bracket are the desired values. - Searching for items by multiple fields:
q=id:5c3325baa9812100098ff48f siteCode:mainwhereidandsiteCodeare field names. All objects that contain the specified values are returned. Multiple fields (separated by space) can be specified. Multiple values for each field can also be specified in the format presented earlier. - Searching for items with string-based properties conforming to a regex:
q=siteCode:~ainorq=code:(~U PL)- in case of searching for strings with space, wheresiteCodeis the name of the field, andainorU PLis its querying regex. - Searching for items with a localized string-based property conforming to a regex:
items.product.name.en:~(Joghurt im)- wherenameis the product field name,enis the desired language, andJoghurt imis the search term. | |fields| string | | Fields to be returned in the response.
When this parameter is passed, only the id and {fieldName} are retrieved for each entry.
You can specify multiple fields by separating them with commas.
|
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept-Language | string | List of language codes acceptable for the response. You can specify factors that indicate which language should be retrieved if the one with a higher factor was not found in the localized fields. If a value is specified, then it must be present in the tenant configuration. |
- If the header is set to a particular language or a list of languages, all localized fields are retrieved as strings.
- If the header is set to
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages. - If the header is empty, localized fields are retrieved in the default language defined in the Configuration Service.
|
|
X-Total-Count| boolean | | Flag indicating whether the total number of retrieved items should be returned. | |Accept| string | | |