Overview

Performance Quoting ECommerce APIs allow the management of ECommerce.

You will find below a change tracking section to see which and how API changed between versions. View API Documentation

Current version: 1.1.9

Online Access to Documentation (via Swagger)

APIs are available here:

https://quote.YOUR_REALM_URL.proscloud.com/quotex-public-api/docs/index.html?contract=model &token=TOKEN

Replace YOUR_REALM_URL with your realm URL (ex: us1, eu1, etc.) Generate your token from AppPortal: View API User Access

The role DESIGNER has to be used to generate the token.

Version Change Tracking

Changes from version 1.1.9 to version 1.1.10

WHAT'S CHANGED

POST /quote/getUiContextIds

Request:

Changed content type : application/json

• Added property catalogUiModelName (string)

The ui catalog model name, used by the enterprise catalog. When omitted or empty, the enterprise catalog UI Context is not created.

• Changed property dataProviderName (string)

The data provider name, used by the enterprise catalog. When omitted or empty, the enterprise catalog UI Context is not created.

Return Type:

Changed response : 200 OK

Successful response

Changed content type : application/json

• Changed property enterpriseCatalog (string)

The enterprise catalog UI Context ID. Empty when the enterprise catalog is disabled or when the catalog parameters (dataProviderName, catalogUiModelName) are not provided in the request.

Changes from version 1.1.8 to version 1.1.9

WHAT’S NEW

POST /quote/settings

get quote settings. - BETA version, API signature is subject to change.

WHAT’S DELETED

POST /quote/catalog/collections

Get the catalog collections. - BETA version, API signature is subject to change.

POST /quote/catalog/structure

Get the catalog structure. - BETA version, API signature is subject to change.

POST /quote/catalog/search

Search in the catalog. - BETA version, API signature is subject to change.

POST /quote/catalog/quickSearch

Search in the catalog. - BETA version, API signature is subject to change.

POST /quote/catalog/products

Get the products in the catalog. - BETA version, API signature is subject to change.

POST /quote/catalog/productPath

Get the product path. - BETA version, API signature is subject to change.

WHAT’S CHANGED

POST /quote/row

Return Type:

Changed response : 200 OK

Changes from version 1.1.2 to version 1.1.8

WHAT’S NEW

POST /quote/getUiContextIds

Retrieve the UI Context IDs. - BETA version, API signature is subject to change.

WHAT’S CHANGED

GET /quote/microsite/settings

Return Type:

Changed response : 200 OK

• Changed content type : application/json
  • Added property isEnterpriseCatalogEnabled (boolean)
    Indicates if the enterprise catalog is enabled:
• Added property enterpriseCatalogServiceUrl (string)
  The enterprise catalog service url:
• Added property quotingServiceUrl (string)
  The quoting service url:
• Added property enterpriseCatalogAuthenticationTokenForDevModeOnly (string)
  Authentication token used by Enterprise Catalog service for development mode only:
• Added property activityTrackingAuthenticationTokenForDevModeOnly (string)
  Authentication token used by Activity Tracking service for development mode only:
• Added property activityTrackingGroupMaxDelay (number)

Maximum delay in minutes for grouping activity tracking messages.

POST /quote/getData

Request:

Changed content type : application/json

• Changed property snapIds (object)

Quote and component snap Ids. These Ids can change if quote data are updated. When provided in a getData request the API will compare provided ones with current and return data only if they change.

• Added property activityTrackingSnapId (integer)

Activity tracking snap Ids. This Id will change if changes are performed on the Quote

Return Type:

Changed response : 200 OK

• Changed content type : application/json
  • Changed property rowsData (object)

Contains rows data and metadata for pagination.

* Added property `range` (object)

* Property `startIndex` (integer)

* Property `endIndex` (integer)

* Property `focusedIndex` (integer)

• Changed property snapIds (object)

Quote and component snap Ids. These Ids can change if quote data are updated. When provided in a getData request the API will compare provided ones with current and return data only if they change.

* Added property `activityTrackingSnapId` (integer)

Activity tracking snap Ids. This Id will change if changes are performed on the Quote

POST /quote/row/{rowId}/getChildren

Request:

Changed content type : application/json

• Added property focusedRowId (string)

Optional row identifier to use as focus. When provided, a range or rows around of this rowId will be returned instead of requested page.

• Changed property snapIds (object)

Quote and component snap Ids. These Ids can change if quote data are updated. When provided in a getData request the API will compare provided ones with current and return data only if they change.

• Added property activityTrackingSnapId (integer)

Activity tracking snap Ids. This Id will change if changes are performed on the Quote

Return Type:

Changed response : 200 OK

• Changed content type : application/json
  • Changed property rowsData (object)

Contains rows data and metadata for pagination.

* Added property `range` (object)

* Property `startIndex` (integer)

* Property `endIndex` (integer)

* Property `focusedIndex` (integer)

• Changed property snapIds (object)

Quote and component snap Ids. These Ids can change if quote data are updated. When provided in a getData request the API will compare provided ones with current and return data only if they change.

* Added property `activityTrackingSnapId` (integer)

Activity tracking snap Ids. This Id will change if changes are performed on the Quote

Changes from version 1.1.1 to version 1.1.2

WHAT'S CHANGED

GET /quote/microsite/settings

Return Type:

Changed response : 200 OK

• Changed content type : application/json
  • Added property aiChatUploadEnabled (boolean)
    Indicates the ai chat upload feature is enabled:
  • Added property aiChatTroles1Enabled (boolean)
    Indicates the ai chat trole1 feature is enabled:

    Changes from version 1.0.52 to version 1.1.1

WHAT’S CHANGED

POST /quote/setFieldValue

Request:

Changed content type: application/json

• Changed property inputValue (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

POST /quote/setCellValue

Request:

Changed content type: application/json

• Changed property inputValue (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

POST /quote/getData

Return Type:

Changed response: 200 OK

• Changed content type : application/json
  • Changed property fieldsData (array)

Changed items (object):

• The requested field data. If a provided field ID is not found, it will be included with an empty value
  • Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property rowsData (object)

Contains row data and metadata for pagination.

• Changed property rows (array)

Changed items (object):

• Row data including cell values and row error status
  • Changed property cells (array)
    The row cells:

Changed items (object):

• Cell content and information
  • Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

POST /quote/row/{rowId}/getChildren

Return Type:

Changed response: 200 OK

• Changed content type : application/json
  • Changed property rowsData (object)

Contains row data and metadata for pagination.

• Changed property rows (array)

Changed items (object):

• Row data including cell values and row error status

• Changed property cells (array)
  The row cells:

Changed items (object):

• Cell content and information

• Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property parentFolders (array)

Changed items (object):

• Row data including cell values and row error status

• Changed property cells (array)
  The row cells:

Changed items (object):

• Cell content and information

• Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property parentProducts (array)

Changed items (object):

• Row data including cell values and row error status
  • Changed property cells (array)
    The row cells:

Changed items (object):

• Cell content and information
  • Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

POST /quote/deleteLines

Return Type:

Changed response: 200 OK

• Changed content type : application/json
  • Changed property rows (array)

Changed items (object):

• A Quote line
  • Changed property cells (array)

Changed items (object):

• A grid cell.
  • Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property inputValue (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

POST /quote/catalog/search

Request:

Changed content type: application/json

• Changed property generalSettings (array)

Changed items (object):

• The catalog search general settings

• Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

Return Type:

Changed response: 200 OK

• Changed content type : application/json
  • Changed property products (array)
    list of found products corresponding to provided search criterea:

Changed items (object):

• List of catalog products in the search results
  • Changed property productProperties (array)

List of requested product properties like the price. In the same order and propertyType as requested.

Changed items (object):

• A grid cell.
  • Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property inputValue (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property computationLink (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property configurationLink (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property replacementProduct (object)
  A possible replacement product with its quantity:
  • Changed property product (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property productProperties (array)

List of requested product properties like the price. In the same order and propertyType as requested.

Changed items (object):

• A grid cell.

• Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property inputValue (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property computationLink (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property configurationLink (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

POST /quote/catalog/quickSearch

Request:

Changed content type: application/json

• Changed property generalSettings (array)

Changed items (object):

• The catalog search general settings

• Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

POST /quote/catalog/products

Request:

Changed content type: application/json

• Changed property generalSettings (array)

Changed items (object):

• The catalog search general settings

• Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

Return Type:

Changed response: 200 OK

• Changed content type : application/json
  • Changed property products (array)
    A list of found products corresponding to the provided CPEs:

Changed items (object):

• product and its properties
  • Changed property businessPropertySets (array)
    List of product BP sets:

Changed items (object):

• business property set
  • Changed property businessProperties (array)

Changed items (object):

• business property set
  • Changed property values (array)

Changed items (object):

• See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue
  • Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property price (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Changed property strikethroughPrice (object)

See different ECommerceGridValue subtypes definitions for more information. Example:

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

POST /quote/dimension/aspects

Return Type:

Changed response: 200 OK

• Changed content type : application/json
  • Changed property aspects (array)

Changed items (object):

• See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue
  • Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

POST /quote/dimension/nodes

Request:

Changed content type : application/json

• Changed property aspect (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

Return Type:

Changed response: 200 OK

• Changed content type : application/json
  • Changed property nodes (array)

Changed items (object):

• See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue
  • Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

GET /quote/sharing/my-quotes

Return Type:

Changed response: 200 OK

Successful response.

• Changed content type : application/json
  • Changed property quotes (array)

Changed items (object):

• Changed property highlightedFields (array)
  List of additional fields related to the Quote:

Changed items (object):

• Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

GET /quote/sharing/shared-quotes

Return Type:

Changed response: 200 OK

Successful response.

• Changed content type : application/json
  • Changed property quotes (array)

Changed items (object):

• Changed property highlightedFields (array)
  List of additional fields related to the Quote:

Changed items (object):

• Changed property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Changed property valueType (string)

Removed enum values:

• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

  Changes from version 1.0.48 to version 1.0.49

WHAT'S CHANGED

GET /quote/sharing/my-quotes

Parameters:

Changed: startDate in query

Start date to filter on Quote creation date. A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day. Example: 2023-11-26

Changed: endDate in query

End date to filter on Quote creation date. A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day. Example: 2023-12-27

GET /quote/sharing/shared-quotes

Parameters:

Changed: startDate in query

Start date to filter on Quote creation date. A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day. Example: 2023-11-26

Changed: endDate in query

End date to filter on Quote creation date. A date as defined by full-date in RFC3339 format, with full-date = date-fullyear - date-month - date-day. Example: 2023-12-27

Changes from version 1.0.47 to version 1.0.48

WHAT'S NEW

POST /quote/dimension/aspects

POST /quote/dimension/nodes

WHAT'S CHANGED

POST /quote/getData

Return Type:

Changed response: 200 OK

• Changed content type : application/json
  • Changed property fieldsData (array)

Changed items (object):

The requested field data. If a provided field Id is not found it will be included with an empty value

• Added property fieldDescription (string)
  The optional field description providing explanations, translated in the given locale:
• Added property dataProviderInformation (object)
  optional cell related data provider information:
  • Property name (string)
  • Property identifier (string)
  • Property type (string)
• Changed property rowsData (object)

Contains rows data and metadata for pagination.

• Changed property rows (array)

Changed items (object): > Row data including cell values and row error status

• Changed property cells (array)
  The row cells:

Changed items (object): > Cell content and information

• Added property dataProviderInformation (object)
  optional cell related data provider information:
  • Property name (string)
  • Property identifier (string)
  • Property type (string)

• Changed property columns (array)

Changed items (object):

• Added property columnDescription (string) > The optional column description providing explanations, translated in the given locale

POST /quote/row/{rowId}/getChildren

Return Type:

Changed response: 200 OK

• Changed content type : application/json
  • Changed property rowsData (object)

Contains rows data and metadata for pagination.

• Changed property rows (array)

Changed items (object):

• Changed property cells (array)
  The row cells:

Changed items (object):

• Added property dataProviderInformation (object)
  optional cell related data provider information:
  • Property name (string)
  • Property identifier (string)
  • Property type (string)
• Changed property columns (array)

Changed items (object):

• Added property columnDescription (string)
  The optional column description providing explanations, translated in the given locale:
  • Changed property parentFolders (array)

Changed items (object):

• Changed property cells (array)
  The row cells:

Changed items (object):

• Added property dataProviderInformation (object)
  optional cell related data provider information:
  • Property name (string)
  • Property identifier (string)
  • Property type (string)
• Changed property parentProducts (array)

Changed items (object):

• Changed property cells (array)
  The row cells:

Changed items (object):

• Added property dataProviderInformation (object)
  optional cell related data provider information:
  • Property name (string)
  • Property identifier (string)
  • Property type (string)

GET /quote/sharing/my-quotes

Return Type:

Changed response: 200 OK

Successful response.

• Changed content type : application/json
  • Changed property quotes (array)

Changed items (object):

• Added property linkId (string)
  An ID used to create a link to the quote:

GET /quote/sharing/shared-quotes

Return Type:

Changed response: 200 OK

Successful response.

• Changed content type : application/json
  • Changed property quotes (array)

Changed items (object):

• Added property linkId (string)
  An ID used to create a link to the quote:

  Changes from version 1.0.40 to version 1.0.47

WHAT'S NEW

POST /quote/collaboration/notify-seller

WHAT'S CHANGED

GET /quote/microsite/settings

Return Type:

Changed response: 200 OK

• Changed content type: `application/json`

• Added property `isCollaborationStatusEnabled` (boolean)
  Indicates if the collaboration status is enabled:

GET /quote/sharing/my-quotes

Return Type:

Changed response: 200 OK

Successful response.

• Changed content type : application/json
  • Changed property allQuotesContributors (array)
    The list of contirbutors on all my Quotes:

Changed items (object):

• Added property negotiate (boolean)

True if contributor can negotiate.

• Changed property quotes (array)

Changed items (object):

• Added property sellerNotificationStatus (object)
  The seller notification status:
  • Property notified (boolean)

The seller has been notified if true, false otherwise.

• Property lastUpdateDate (string)
  The last update date as defined by date-time in RFC3339 format with date-time= full-date 'T' full-time example: '2024-02-21T17:32:28':

• Added property status (object)
  The Quote collaboration status with it's information:
  • Property name (string)
    The collaboration status name:
  • Property label (string)
    The collaboration status translation in the given language:
• Changed property contributors (array)
  List of Quote contributors if Quote is shared:

Changed items (object):

• Added property negotiate (boolean)

True if contributor can negotiate.

GET /quote/sharing/shared-quotes

Return Type:

Changed response: 200 OK

Successful response.

• Changed content type : application/json

• Changed property quotes (array)
  • Changed items (object):
    • Added property sellerNotificationStatus (object)
      The seller notification status:
      • Property notified (boolean)

The seller has been notified if true, false otherwise.

• Property lastUpdateDate (string)
  The last update date as defined by date-time in RFC3339 format with date-time= full-date 'T' full-time example: '2024-02-21T17:32:28':

• Added property status (object)
  The Quote collaboration status with it's information:
  • Property name (string)
    The collaboration status name:
  • Property label (string)
    The collaboration status translation in the given language:

GET /quote/sharing/pending-requests

Return Type:

Changed response: 200 OK

Successful response.

• Changed content type : application/json

• Changed property pendingRequests (array)

Changed items (object):

• Added property canNegotiate (boolean)

The user sending the request requests the right to negotiate.

POST /quote/sharing/pending-request/review

Return Type:

Changed response: 200 OK

Successful response.

• Changed content type: application/json
  • Changed property pendingRequests (array)

Changed items (object):

• Added property canNegotiate (boolean)

The user sending the request requests the right to negotiate.

POST /quote/sharing/invite-to-collaborate-link

Request:

Changed content type : application/json

New required properties:

• canNegotiate
• Added property canNegotiate (boolean)

The user sending the request requests the right to negotiate.

POST /quote/sharing/invite-to-access-quote-link

Request:

Changed content type : application/json

New required properties:

• canNegotiate
• Added property canNegotiate (boolean)

The user sending the request requests the right to negotiate.

GET /quote/sharing/permissions

Return Type:

Changed response: 200 OK

• Changed content type : application/json

New required properties:

• canNegotiate

New optional properties:

• negotiation
• Added property canNegotiate (boolean)

Negotiation right to be able to change Quote collaboration status. If this is set to true user should have access READ_WRITE access.

• Deleted property negotiation (boolean)

Negotiation rights to be able to change Quote collaboration status. If this is set to true user should have access READ_WRITE access.

POST /quote/sharing/permissions

Request:

Changed content type: application/json

• Changed property permissions (object)
  Permissions for a contributor on a Quote or list of Quotes:

New required properties:

• canNegotiate

New optional properties:

• negotiation
• Added property canNegotiate (boolean)

Negotiation right to be able to change Quote collaboration status. If this is set to true user should have access READ_WRITE access.

• Deleted property negotiation (boolean)

Negotiation rights to be able to change Quote collaboration status. If this is set to true user should have access READ_WRITE access.

GET /quote/collaboration/status/targets

Return Type:

Changed response: 200 OK

• Changed content type : application/json
  • Added property sellerNotified (boolean)
    Was seller notified for the current Quote:
  • Added property sellerNotifyLabel (string)
    Label of seller notify action:

POST /quote/collaboration/status

Request:

Changed content type : application/json

• Added property transition (string)
  The collaboration status target transition:

  Changes from version 1.0.36 to version 1.0.40

WHAT'S NEW

POST /quote/row/{rowId}/getChildren

GET /quote/collaboration/status/targets

POST /quote/collaboration/status

WHAT'S CHANGED

POST /quote/row

Request:

Changed content type : application/json

• Added property insertionPoint(string)

- the insertionPoint if any

GET /quote/sharing/my-quotes

Parameters:

Added: locale in query

The display locale that will be used to format values formatted like en-US.

Return Type:

Changed response : 200 OK

Successful response.

• Changed content type : application/json
• Changed property quotes (array)

Changed items (object):

• Added property lastUpdateDate (string)
  The Quote last update date as defined by date-time in RFC3339 format with date-time= full-date T full-time example: 2024-02-21T17:32:28:
  • Added property highlightedFields (array)
    List of additional fields related to the Quote:

Items (object):

• Property fieldId (string)
  The field identifier:
  • Property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Property valueType (string)

Enum values:

• Empty
• String
• BigDecimal
• Boolean
• Business
• Currency
• DateTime
• Integer
• Json
• LocalDate
• Locale
• Long
• Monetary
• Multiple
• Percentage
• UnitOfMeasure
• Xml
• Html
• Url
• ScaleGrid
• Attachment
• Error
• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Property formattedValue (string)

GET /quote/sharing/shared-quotes

Parameters:

Added: locale in query

The display locale that will be used to format values formatted like en-US.

Return Type:

Changed response : 200 OK

Successful response.

• Changed content type : application/json
  • Changed property quotes (array)

Changed items (object):

• Added property lastUpdateDate (string)
  The Quote last update date as defined by date-time in RFC3339 format with date-time= full-date 'T' full-time example: 2024-02-21T17:32:28:
  • Added property highlightedFields (array)
    List of additional fields related to the Quote:

Items (object):

• Property fieldId (string)
  The field identifier:

• Property value (object)

See different ECommerceGridValue subtypes definitions for more information. Example: StringECommerceGridValue

• Property valueType (string)

Enum values:

• Empty
• String
• BigDecimal
• Boolean
• Business
• Currency
• DateTime
• Integer
• Json
• LocalDate
• Locale
• Long
• Monetary
• Multiple
• Percentage
• UnitOfMeasure
• Xml
• Html
• Url
• ScaleGrid
• Attachment
• Error
• MonetaryPerQuantity
• CurrencyPerQuantity
• Measure

• Property formattedValue (string)

GET /quote/sharing/permissions

Return Type:

Changed response : 200 OK

• Changed content type : application/json

New required properties:

• negotiation
  • Added property negotiation (boolean)

Negotiation rights to be able to change Quote collaboration status. If this is set to true user should have access READ_WRITE access.

POST /quote/sharing/permissions

Request:

Changed content type : application/json

• Changed property permissions (object)
  Permissions for a contributor on a Quote or list of Quotes:

New required properties:

• negotiation
  • Added property negotiation (boolean)

Negotiation rights to be able to change Quote collaboration status. If this is set to true user should have access READ_WRITE access.

Changes from version 1.0.28 to version 1.0.33

WHAT'S NEW

POST /quote

Create a quote. - BETA version, API signature is subject to change.

GET /quote/models

Get list of available Quote models. - BETA version, API signature is subject to change.

GET /quote/getAccessRights/{sessionStateSnapId}

Retrieve the quote access rights. - BETA version, API signature is subject to change.

POST /quote/catalog/quickSearch

Search in the catalog. - BETA version, API signature is subject to change.

GET /quote/sharing/my-quotes

Get list of my Quotes. - BETA version, API signature is subject to change.

GET /quote/sharing/shared-quotes

Get list of Quotes shared with me. - BETA version, API signature is subject to change.

GET /quote/sharing/pending-requests

Get list of pending requests. - BETA version, API signature is subject to change.

POST /quote/sharing/pending-request/review

Review a pending request. - BETA version, API signature is subject to change.

POST /quote/sharing/invite-to-collaborate-link

Generate an invitation to collaborate link. - BETA version, API signature is subject to change.

POST /quote/sharing/invite-to-access-quote-link

Generate an invitation link to access to a quote. - BETA version, API signature is subject to change.

GET /quote/sharing/permissions

POST /quote/sharing/permissions

WHAT'S DELETED

POST /quote/getFields

Get fields. - BETA version, API signature is subject to change.

POST /quote/getLines

Get lines values. - BETA version, API signature is subject to change.

GET /quote/getAccessRights

Retrieve the quote access rights. - BETA version, API signature is subject to change.

WHAT'S CHANGED

GET /quote/microsite/settings

Description:

This operation retrieves the collaboration portal settings.

Return Type:

Changed response: 200 OK

• Changed content type : application/json
  • Changed property accessMode (string)

The access mode.VIEW view only, without password. VIEW_EDIT view and edit, both without password. VIEW_PASSWORD view only, view is password protected. EDIT_PASSWORD view and edit, edit is password protected. VIEW_EDIT_PASSWORD view and edit, view and edit is password protected. APP_PORTAL_USER_VIEW view only, app portal protected.

APP_PORTAL_USER_VIEW_EDIT view and edit, app portal protected. DASHBOARD_QUOTE_VIEW dashboard access view only, app portal protected. DASHBOARD_QUOTE_VIEW_EDIT dashboard access, view and edit allowed, app portal protected.

Added enum values:

• DASHBOARD_QUOTE_VIEW
• DASHBOARD_QUOTE_VIEW_EDIT

POST /quote/open

Parameters:

Added: Request-Id in header

Use this optional header to correlate many calls to the same external operation or workflow. Must be a UUID without "-" characters.

POST /quote/resolveLocale

Parameters:

Added: Request-Id in header

Use this optional header to correlate many calls to the same external operation or workflow. Must be a UUID without "-" characters.

Return Type:

Changed response: 200 OK

Successful response. Quote opening finished. See response content for more information

• Changed content type : application/json
  • Added property datePattern (string)

The date pattern to use for string format

• Added property dateTimePattern (string)

The date time to use pattern for string format

• Added property amPmStrings (array)

List of am pm strings

Items (string):

• Added property shortWeekDays (array)

List of localized short week days

Items (string):

• Added property shortMonths (array)

List of localized short months

Items (string):

• Added property clock (integer)
• Added property firstDayOfWeek (integer)

Index of localized first day of week

POST /quote/pushEncryptedContext

Parameters:

Added: Request-Id in header

Use this optional header to correlate many calls to the same external operation or workflow. Must be a UUID without "-" characters.

POST /quote/setFieldValue

Parameters:

header

Request-Id

Use this optional header to correlate many calls the same external operation or workflow. Must be a UUID without "-" characters.

POST /quote/setCellValue

Parameters:

header

Request-Id

Use this optional header to correlate many calls the same external operation or workflow. Must be a UUID without "-" characters.

POST /quote/getData

Parameters:

header

Request-Id

Use this optional header to correlate many calls the same external operation or workflow. Must be a UUID without "-" characters.

POST /quote/deleteLines

Parameters:

header

Request-Id

Use this optional header to correlate many calls the same external operation or workflow. Must be a UUID without "-" characters.

POST /quote/getDomain

Parameters:

Added: Request-Id in header

Use this optional header to correlate many calls the same external operation or workflow. Must be a UUID without "-" characters.

GET /quote/status

Parameters:

Added: Request-Id in header

Use this optional header to correlate many calls the same external operation or workflow. Must be a UUID without "-" characters.

POST /quote/status

Parameters:

Added: Request-Id in header

Use this optional header to correlate many calls the same external operation or workflow. Must be a UUID without "-" characters.

GET /quote/getSessionStates

Parameters:

Added: Request-Id in header

Use this optional header to correlate many calls the same external operation or workflow. Must be a UUID without "-" characters.

GET /quote/getRequestStatus/{correlationId}

Parameters:

Added: Request-Id in header

Use this optional header to correlate many calls the same external operation or workflow. Must be a UUID without "-" characters.

POST /quote/catalog/search

Request:

Changed content type: application/json

• Changed property nbResults (integer)

Max number of search results to return. The provided number should be within the authorized interval, if not max results number will be used

Return Type:

Changed response: 200 OK

• Changed content type: application/json
  • Changed property products (array)

List of found products corresponding to provided search criterea

Changed items (string -> object):

POST /quote/catalog/products

Parameters:

Added: Request-Id in header

Use this optional header to correlate many calls to the same external operation or workflow. Must be a UUID without "-" characters.

POST /quote/catalog/productPath

Parameters:

Added: Request-Id in header

Use this optional header to correlate many calls the same external operation or workflow. Must be a UUID without "-" characters.

Changes from version 1.0.26 to version 1.0.27

WHAT’S NEW

GET /quote/getSessionStates

Retrieve the quote session states. - BETA version, API signature is subject to change.

POST /quote/catalog/collections

Get the catalog collections. - BETA version, API signature is subject to change.

POST /quote/catalog/structure

Get the catalog structure. - BETA version, API signature is subject to change.

POST /quote/catalog/products

Get the products in the catalog. - BETA version, API signature is subject to change.

POST /quote/catalog/productPath

Get the product path. - BETA version, API signature is subject to change.

WHAT’S CHANGED

POST /quote/session

Initialize a Quote session. - BETA version, API signature is subject to change.

POST /quote/requestAccessRight

Request an access right. - BETA version, API signature is subject to change.

Description:

This operation request an access right (VIEW or EDIT) with a password. You can request an access once every 5 seconds per token.

GET /quote/microsite/settings

Get the microsite settings. - BETA version, API signature is subject to change.

POST /quote/open

Open a quote. - BETA version, API signature is subject to change.

Return Type:

Changed response : 200 OK

Successful response. Quote opening finished. See response content for more information

• Changed content type : application/json
  • Added property modelName (string)

The quote model name to use for all following operations.

Changed response : 202 Accepted

Successful response. Quote opening in ongoing. See response content for more information

• Changed content type : application/json
  • Added property modelName (string)

The quote model name to use for all following operations.

POST /quote/resolveLocale

Resolve the locale to use. - BETA version, API signature is subject to change.

POST /quote/pushEncryptedContext

Push an encrypted context. - BETA version, API signature is subject to change.

Request:

Changed content type : application/json

• Changed property encryptedContext (string)

Encrypted context. Check ECommerceContexts object for the schema of contexts to encrypt

Return Type:

Deleted response : 200 OK

Successful response.

Changed response : 201 Created

Successful response.

POST /quote/getFields

Get fields. - BETA version, API signature is subject to change.

POST /quote/setFieldValue

Set a field value. - BETA version, API signature is subject to change.

POST /quote/setCellValue

Set a cell value. - BETA version, API signature is subject to change.

POST /quote/getLines

Get lines values. - BETA version, API signature is subject to change.

POST /quote/getData

Get Quote data including fields and lines values. - BETA version, API signature is subject to change.

Request:

Changed content type : application/json

• Changed property pageNumber (integer)

The page number, pages start at index 1. If set to 0, rows will not be requested unless specific rows are requested with their Ids

Return Type:

Changed response : 200 OK

• Changed content type : application/json
  • Changed property rowsData (object)

Contains rows data and metadata for pagination.

• Added property totalRowsFormattedValue (string)
  Lines total formatted for display:

POST /quote/deleteLines

Delete lines from the quote. - BETA version, API signature is subject to change.

POST /quote/getDomain

Retrieve a cell or field domain. - BETA version, API signature is subject to change.

GET /quote/status

Get the quote status. - BETA version, API signature is subject to change.

POST /quote/status

Change the quote status. - BETA version, API signature is subject to change.

GET /quote/getAccessRights

Retrieve the quote access rights. - BETA version, API signature is subject to change.

GET /quote/getRequestStatus/{correlationId}

Retrieve the execution status for an async request. - BETA version, API signature is subject to change.

POST /quote/docgen

Generate a document from the quote. - BETA version, API signature is subject to change.

GET /quote/docgen/{docgenId}

Get a generated document. - BETA version, API signature is subject to change.

POST /quote/catalog/search

Search in the catalog. - BETA version, API signature is subject to change.

Request:

Changed content type : application/json

New required properties:

• quoteModelName
• Added property quoteModelName (string)

The quote model name. This will be used to find the right catalog

• Deleted property quoteModelId (string)

The quoteModelId retrieved after opening the Quote. This will be used to find the right catalog

Return Type:

Changed response : 200 OK

• Changed content type : application/json
  • Changed property products (array)
    list of found products corresponding to provided search criterea:

Changed items (object -> string):

POST /quote/row

Add a row in the quote. - BETA version, API signature is subject to change.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

New required properties:

• id

New optional properties:

• products
• Added property id (string)

Use this id to get your command execution status.

• Deleted property products (array)
  list of found products corresponding to provided search criterea: