Quote management
Was this helpful?
Was this helpful?
The tenant that the caller is acting upon
Note: This value must always be provided in lowercase.
^[a-z][a-z0-9]+$Quote unique identifier generated when the quote is created
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.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.The tenant that the caller is acting upon
Note: This value must always be provided in lowercase.
^[a-z][a-z0-9]+$Quote unique identifier generated when the quote is created
No content
Retrieves quotes. The response includes either all quotes or a subset of quotes based on the assigned access token scopes.
quote.quote_read - assigned to employees to allow them to retrieve all tenant quotes
quote.quote_read_own - assigned to customers to enable them to retrieve only the quotes that they created themselves or that were created on their behalf
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
saasdev2Number of items to be retrieved per page.
60Page number to be retrieved. The number of the first page is 1.
1List of properties used to sort the results, separated by colons. The order of properties indicates their priority in sorting.
Possible values:
{fieldName}{fieldName}:asc{fieldName}:descNote: If you want to sort the results by localized properties, the possible values are:
{fieldName}.{language}{fieldName}.{language}:asc{fieldName}.{language}:descIf the sorting direction is not specified, the fields are sorted in ascending order.
A standard query parameter is used to search for specific values.
q=siteCode:main, where siteCode is the field name, and main is its desired value.q=items.product.name.en:apple_lobo, where name is the field name of product, en is the language code, and apple_lobo is the field value expressed in the specified language. Note: This query works only for localized fields, which are stored in a map format, where key is the language code and value is the translation to particular language.q=items.quantity.quantity:20q=items.quantity.quantity:>20q=items.quantity.quantity:<20q=items.quantity.quantity:>=20q=items.quantity.quantity:<=20q=items.quantity.quantity:(>=10 AND <=20)items.quantity.quantity is the name of the number-based field, and 20 is its querying value.q=metadataCreatedAt:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z")q=description.multiLanguage:true, where description.multiLanguage is the boolean field name, and true is its desired value.q=description.en:null, where description.en is the field that has its value set to null.q=mixin:exists, where mixin is the field that has a non-empty value.q=id:(5c3325baa9812100098ff48f,5c3325d1a9812100098ff494), where id is the field name, and strings within the bracket are the desired values.q=id:5c3325baa9812100098ff48f siteCode:main where id and siteCode are 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.q=siteCode:~ain or q=code:(~U PL) - in case of searching for strings with space, where siteCode is the name of the field, and ain or U PL is its querying regex.items.product.name.en:~(Yoghurt im) - where name is the product field name, en is the desired language, and Joghurt im is the search term.siteCode:{main}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.
code,messageList 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.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.Flag indicating whether the total number of retrieved items should be returned.
falseExample: trueGenerates a new quote, which can be created either manually using a complete quote definition that includes items, or by copying the details from cart.
quote.quote_manage - required for the employee to create a quote
quote.quote_manage_own - required for the customer to be able to create a quote from cart
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
saasdev2Partially updates a quote with a given Id. Single update may contain multiple partial updates in the form of an array. It contains the allowed operations list:
add (adding an item to the items list)
remove (removing an item from the items list)
replace (replacing an item with given id with new definition which may contain custom price proposal or defined price)
After events are saved, some of the information is retrieved in the async way from other services: full price definition is based on the provided price ID, and the full product name is based on the provided product ID.
quote.quote_manage - allows employees or external api calls to modify all quotes
quote.quote_manage_own - allows customers to modify only their own quotes by modifying the status to either ACCEPTED or DECLINED.
The tenant that the caller is acting upon
Note: This value must always be provided in lowercase.
^[a-z][a-z0-9]+$Quote unique identifier generated when the quote is created
Quote update operation list.
Value of the string type
Mixin request
No content