Quote Management

Send request to perform a quotation

This operation creates a Quote entity.

Securityx-sonata-buyer-key-and-api-key
Request
query Parameters
buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 79 (Sn 8.8)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when the responding entity represents more than one Seller.

Reference: MEF 79 (Sn 8.8)

Request Body schema: application/json;charset=utf-8
required

The Quote to be created

Array of objects (Note)

Free form text associated with the quote. Only useful in processes involving human interaction. Not applicable for the automated process.

requestedQuoteCompletionDate
string <date-time>

This is requested date - from quote requester - to get a complete response for this quote

Array of objects (RelatedContactInformation)

Party playing a role for this quote. If instantSyncQuote equals false then the Buyer MUST specify Buyer Contact Information ('role: buyerContactInformation') and the Seller MUST specify Seller Contact Information ('role: sellerContactInformation')

description
string

Description of the quote

externalId
string

ID given by the consumer and only understandable by him (to facilitate his searches afterwards)

buyerRequestedQuoteLevel
required
string (MEFBuyerQuoteLevel)

An indication of whether the Buyer's Quote Request is for a Budgetary or Firm Quote Level. Set by the Buyer. Buyer Requested Quote Level contains the possible values and may be set by the Buyer on the Request. All Quote Items in a Quote have the same Quote Level.

Enum: "budgetary" "firm"
projectId
string

An identifier that is used to group Quotes that represent a unit of functionality that is important to a Buyer. A Project can be used to relate multiple Quotes together.

instantSyncQuote
required
boolean

If this flag is set to true, the Buyer requests an immediate Quote to be provided in the response to the creation of a Quote.

required
Array of objects (MEFQuoteItem_Create) non-empty

An item of the quote - used to describe an operation on a product to be quoted

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable entity due to the business validation problems in the Quote or one of the Quote items

500

Internal Server Error

post/mefApi/sonata/quoteManagement/v8/quote
Request samples
application/json;charset=utf-8
{
  • "note": [
    ],
  • "requestedQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "relatedContactInformation": [
    ],
  • "description": "string",
  • "externalId": "string",
  • "buyerRequestedQuoteLevel": "budgetary",
  • "projectId": "string",
  • "instantSyncQuote": true,
  • "quoteItem": [
    ]
}
Response samples
application/json;charset=utf-8
{
  • "note": [
    ],
  • "requestedQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "relatedContactInformation": [
    ],
  • "description": "string",
  • "externalId": "string",
  • "buyerRequestedQuoteLevel": "budgetary",
  • "projectId": "string",
  • "instantSyncQuote": true,
  • "effectiveQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "expectedQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "validFor": {
    },
  • "quoteLevel": "budgetary",
  • "quoteItem": [
    ],
  • "stateChange": [
    ],
  • "id": "string",
  • "href": "string",
  • "state": "accepted",
  • "quoteDate": "2019-08-24T14:15:22Z"
}

Retrieves a Quote by ID

This operation retrieves a Quote entity. Attribute selection is enabled for all first level attributes.

Securityx-sonata-buyer-key-and-api-key
Request
path Parameters
id
required
string

Identifier of the Quote

query Parameters
buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 79 (Sn 8.8)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when the responding entity represents more than one Seller.

Reference: MEF 79 (Sn 8.8)

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/mefApi/sonata/quoteManagement/v8/quote/{id}
Response samples
application/json;charset=utf-8
{
  • "note": [
    ],
  • "requestedQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "relatedContactInformation": [
    ],
  • "description": "string",
  • "externalId": "string",
  • "buyerRequestedQuoteLevel": "budgetary",
  • "projectId": "string",
  • "instantSyncQuote": true,
  • "effectiveQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "expectedQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "validFor": {
    },
  • "quoteLevel": "budgetary",
  • "quoteItem": [
    ],
  • "stateChange": [
    ],
  • "id": "string",
  • "href": "string",
  • "state": "accepted",
  • "quoteDate": "2019-08-24T14:15:22Z"
}