CommunitySupport PortalYouTubeStart a free trial

Quote reason

Retrieving reasons for changing the quote status

get

Retrieves a full list of reasons for changing the quote status with details.

Required scopes

  • quote.quote_read

  • quote.quote_read_own

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Example: saasdev2
Query parameters
pageSizeinteger · min: 1Optional

Number of items to be retrieved per page.

Default: 60
pageNumberinteger · min: 1Optional

Page number to be retrieved. The number of the first page is 1.

Default: 1
sortstringOptional

List 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}: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.

qstringOptional

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, where siteCode is the field name, and main is its desired value.
    • By a localized field 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.
  • 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)
      where items.quantity.quantity is the name of the number-based field, and 20 is its querying value.
  • Searching for items by a date-based property: All number-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, where description.multiLanguage is the boolean field name, and true is its desired value.
  • Searching for items with a nonexistent or empty property: q=description.en:null, where description.en is the field that has its value set to null.
  • Searching for items with an existing property: q=mixin:exists, where mixin is the field that has a non-empty value.
  • Searching for items by multiple specific values: q=id:(5c3325baa9812100098ff48f,5c3325d1a9812100098ff494), where id is the field name, and strings within the bracket are the desired values.
  • Searching for items by multiple fields: 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.
  • Searching for items with string-based properties conforming to a regex: 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.
  • Searching for items with a localized string-based property conforming to a 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.
Example: siteCode:{main}
fieldsstringOptional

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.

Example: code,message
Header parameters
Accept-LanguagestringOptional

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-CountbooleanOptional

Flag indicating whether the total number of retrieved items should be returned.

Default: falseExample: true
Responses
200
OK
application/json
get
GET /quote/{tenant}/quote-reasons HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "642c1ff3c78f9b2958d17c18",
    "code": "PRICE_TOO_HIGH",
    "message": {
      "en": "The price is too high",
      "de": "Der Preis ist zu hoch"
    },
    "type": "CHANGE",
    "metadata": {
      "version": 1,
      "createdAt": "2023-02-23T09:36:55.929Z",
      "modifiedAt": "2023-02-23T09:38:49.196Z"
    }
  }
]

Creating a reason for changing the quote status

post

Creating reasons for the 'CHANGE' or 'DECLINE' types of quote statuses. The reason for the quote status change serves to provide more descriptive information why the status has been changed. This option is available both for merchants and customers, depending on who updates the status of the quote.

Required scopes

  • quote.quote_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Example: saasdev2
Header parameters
Content-LanguagestringRequired

The Content-Language request HTTP header defines language(s) of the payload.

Example: de
Body

The schema specifies the attributes that must be provided when creating a quote reason.

idstringOptional

The ID for a quote reason can either be manually provided at the time of the quote reason creation, or is automatically generated if not provided.

typestring · enumRequired

Type of the quote reason.

Possible values:
codestringRequired

Code of the reason for the quote status change.

Responses
201
The request was successful. Quote reason was created and its id is returned.
application/json
post
POST /quote/{tenant}/quote-reasons HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Language: de
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "code": "PRICE_TOO_HIGH",
  "type": "CHANGE",
  "message": {
    "en": "The price is too high",
    "de": "Der Preis ist zu hoch"
  }
}
{
  "id": "642c1ff3c78f9b2958d17c18"
}

Retrieving a quote reason

get

Retrieves a quote reason with details by its unique identifier.

Required scopes

  • quote.quote_read

  • quote.quote_read_own

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Example: saasdev2
quoteReasonIdstringRequired

Quote reason unique identifier generated when the quote reason is created.

Example: 642c1ff3c78f9b2958d17c18
Header parameters
Accept-LanguagestringOptional

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.
Responses
200
OK
application/json
get
GET /quote/{tenant}/quote-reasons/{quoteReasonId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "642c1ff3c78f9b2958d17c18",
  "code": "PRICE_TOO_HIGH",
  "message": {
    "en": "The price is too high",
    "de": "Der Preis ist zu hoch"
  },
  "type": "CHANGE",
  "metadata": {
    "version": 1,
    "createdAt": "2023-02-23T09:36:55.929Z",
    "modifiedAt": "2023-02-23T09:38:49.196Z"
  }
}

Updating the reason for changing the quote status

put

Updating the reason for changing the quote status.

Required scopes

  • quote.quote_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Example: saasdev2
quoteReasonIdstringRequired

Quote reason unique identifier generated when the quote reason is created.

Example: 642c1ff3c78f9b2958d17c18
Header parameters
Content-LanguagestringRequired

The Content-Language request HTTP header defines language(s) of the payload.

Example: de
Body

The schema specifies the attributes that must be provided when creating a quote reason.

typestring · enumRequired

Type of the quote reason.

Possible values:
codestringRequired

Code of the reason for the quote status change.

Responses
204
The request was successful. Quote reason has been updated.
put
PUT /quote/{tenant}/quote-reasons/{quoteReasonId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Language: de
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "code": "PRICE_TOO_HIGH",
  "type": "CHANGE",
  "message": {
    "en": "The price is too high",
    "de": "Der Preis ist zu hoch"
  },
  "metadata": {
    "version": 1
  }
}
No content

Deleting the reason for changing the quote status

delete

Deletes the reason provided for the quote status change with a specific reason ID.

Required scopes

  • quote.quote_manage - the quote reason can be deleted by an employee

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant name should always be written in lowercase.

Example: saasdev2
quoteReasonIdstringRequired

Quote reason unique identifier generated when the quote reason is created.

Example: 642c1ff3c78f9b2958d17c18
Responses
204
Quote reason has been deleted successfully.
delete
DELETE /quote/{tenant}/quote-reasons/{quoteReasonId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content
PreviousQuote pdfNextModels

Was this helpful?