Quote history

Retrieving quote history

get

Retrieves changes related to a quote with a given ID.

---

Required scopes

• quote.quote_read - allows employees to retrieve history of any quote

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

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

Example: saasdev2

quoteIdstringRequired

Quote unique identifier generated when the quote is created.

Example: 084bcaf5-66b8-4ddd-9489-65c5f6449e94

Header parameters

X-Total-CountbooleanOptional

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

Default: falseExample: true

Responses

200

The request was successful. Quote details are returned.

application/json

Quote update operation list.

idstringOptional

The unique ID of the audit log.

opstring · enumOptional

operation type

Possible values:

pathstring · enumOptional

Path that indicates on which element the update has been executed.

Possible values:

newValueall ofOptional

anyOptional

or

or

or

or

or

or

stringOptional

Value of the string type.

or

objectOptional

Mixin request.

and

objectOptional

New value after the update.

previousValueall ofOptional

Value before update.

anyOptional

or

or

or

or

or

or

stringOptional

Value of the string type.

or

objectOptional

Mixin request.

and

objectOptional

Value before update.

userIdstringOptional

ID of the user who modified the item.

userFirstNamestringOptional

First name of the user who modified the item.

userLastNamestringOptional

Last name of the user who modified the item.

userTypestring · enumOptionalPossible values:

restrictionstring · nullableOptional

Access control identifier that determines who can view or manage the quotes.

Purpose: Restricts quote visibility based on scope permissions. Only users/applications with matching restriction scopes can access quotes with a specific restriction value.

Access Control:

• Reading: Users can only query and view quotes with the restriction value that matches one of their authorized restrictions.

Validation: The value must exist in the tenant's configured list of valid restrictions.

Restriction Synchronization:

• If quote is created by a customer (based on a cart) and restriction property is not set, the restriction value of quote is inherited from customer's restriction.
• If a quote is created by an employee and the restriction property is not set with tenant configuration property enableSyncBetweenRestrictionsAndSiteCodes set to true, the restriction field automatically syncs with quote's siteCode property.

Example: DE

modifiedAtstringOptional

Modification date.

401

Given request is unauthorized - the authorization token is invalid or has expired. It usually means that tenant from the token does not match tenant from path.

application/json

403

Permission denied due to insufficient rights. This may happen when request does not contain sufficient scopes for given query values.

application/json

get

/quote/{tenant}/quotes/{quoteId}/history

HTTPcURLJavaScriptPython

GET /quote/{tenant}/quotes/{quoteId}/history HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "6447b45cac0475131f3a6261",
    "op": "ADD",
    "path": "/items",
    "newValue": {
      "itemId": "2298854309b06d4c6d3cf1zfe",
      "quantity": {
        "quantity": 1,
        "unitCode": "H87"
      },
      "price": {
        "priceId": "14551d2309b06sd46d3cf19bq",
        "unitPrice": 13,
        "totalNetValue": 13,
        "tax": {
          "taxClass": "STANDARD",
          "taxRate": 20
        },
        "product": {
          "productId": "74698542309b06dc46d3cf19fe"
        }
      }
    },
    "userId": "7777i52309521897214",
    "userFirstName": "Robin",
    "userLastName": "Fritz",
    "restriction": "main",
    "userType": "EMPLOYEE",
    "modifiedAt": "2024-04-02T13:06:15.280Z"
  },
  {
    "id": "6447b45cac0475131f3a6262",
    "op": "REPLACE",
    "path": "/status",
    "newValue": {
      "value": "OPEN"
    },
    "previousValue": {
      "value": "AWAITING"
    },
    "userId": "612ji52309521897214",
    "userFirstName": "Robin",
    "userLastName": "Fritz",
    "userType": "EMPLOYEE",
    "modifiedAt": "2024-04-02T13:06:15.280Z"
  },
  {
    "id": "6447b45cac0475131f3a6263",
    "op": "REPLACE",
    "path": "/validTo",
    "newValue": "2025-04-02T13:06:15.280Z",
    "previousValue": "2023-04-02T13:06:15.280Z",
    "userId": "612ji52309521897214",
    "userFirstName": "Stefan",
    "userLastName": "Muller",
    "userType": "EMPLOYEE",
    "modifiedAt": "2024-04-02T13:06:15.280Z"
  },
  {
    "id": "6447b45cac0475131f3a6264",
    "op": "REPLACE",
    "path": "/items/2298854309b06d46d3cf19fe",
    "previousValue": {
      "itemId": "2298854309b06d4c6d3cf1zfe",
      "quantity": {
        "quantity": 1,
        "unitCode": "H87"
      },
      "price": {
        "priceId": "14551d2309b06sd46d3cf19bq",
        "unitPrice": 13,
        "totalNetValue": 13,
        "tax": {
          "taxClass": "STANDARD",
          "taxRate": 20
        },
        "product": {
          "productId": "74698542309b06dc46d3cf19fe"
        }
      }
    },
    "newValue": {
      "itemId": "2298854309b06d4c6d3cf1zfe",
      "quantity": {
        "quantity": 2,
        "unitCode": "H87"
      },
      "price": {
        "priceId": "14551d2309b06sd46d3cf19bq",
        "unitPrice": 14,
        "totalNetValue": 14,
        "tax": {
          "taxClass": "STANDARD",
          "taxRate": 21
        },
        "product": {
          "productId": "74698542309b06dc46d3cf1fff"
        }
      }
    },
    "userId": "5577i52309521897214",
    "userFirstName": "Mark",
    "userLastName": "Schmidt",
    "userType": "EMPLOYEE",
    "modifiedAt": "2024-04-02T13:06:15.280Z"
  },
  {
    "id": "6447b45cac0475131f3a6261",
    "op": "REMOVE",
    "path": "/items/124dfa82410fas824kfa",
    "previousValue": {
      "itemId": "2298854309b06d4c6d3cf1zfe",
      "quantity": {
        "quantity": 1,
        "unitCode": "H87"
      },
      "price": {
        "priceId": "14551d2309b06sd46d3cf19bq",
        "unitPrice": 13,
        "totalNetValue": 13,
        "tax": {
          "taxClass": "STANDARD",
          "taxRate": 20
        },
        "product": {
          "productId": "74698542309b06dc46d3cf19fe"
        }
      }
    },
    "userId": "612ji52309521897214",
    "userFirstName": "Stefan",
    "userLastName": "Muller",
    "userType": "EMPLOYEE",
    "modifiedAt": "2024-04-02T13:06:15.280Z"
  }
]