Add Products to a Quote

pricefx-develop

Pricefx REST API

Overview

Getting Started

Data Formats and Transport Protocol

Authentication

Status Codes

Filtering, Sorting, Pagination

Pricefx API Reference

The Pricefx Backend API

General Operations

General

Master Data

Products

Product Extensions

Product Image

Customers

Customer Extensions

Sellers

Seller Extensions

Condition Records

Competition Data

Imports

Data Change Requests

Lookup Tables / Company Parameters

Administration and Configuration

User Admin

Authentication

Admin Tools

Logics

Logs

Custom Forms

Calculated Field Sets

Jobs & Tasks

Analytics

Data Manager

Actionable Insights

Actions

Action Types

Price Setting

Price Lists

Manual Price Lists

Live Price Grids

Calculation Grids

Visual Configuration

Quoting

Quotes

Agreements & Promotions

Contracts (Agreements & Promotions)

Visual Configuration

Rebates

Rebate Agreements

Rebate Calculations

Rebate Record Group

Sales Compensations

Channel Management

Claim Types

Claims

Optimization

Workflow

Workflow Delegation

Files

Attachments

Product Image

Configuration

Internationalization

Other

Metadata

Clicmanager

Comments

Notifications

Heartbeat

Key-Value Store

Schemas

Entities

otherSchemas

OpenAPI Reference Files

Add Products to a Quote

post/quotemanager.addproducts

Adds specified product items to the quote. The quote is recalculated after the items are added.

Required Permission	Roles with the Required Permission
QUOTE_UPDATE	Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`)

Securitybasic or X-PriceFx-jwt

Request

Request Body schema: application/json

required

object

required

object

version

required

number

typedId

required

string non-empty

uniqueName

required

string non-empty

label

required

string non-empty

targetDate

required

string non-empty

workflowStatus

required

string non-empty

headerText

required

string non-empty

required

Array of objects non-empty unique

Array (non-empty)

name required	string non-empty
label required	string non-empty
lookupTableId	any
url required	string non-empty
type required	string non-empty
value required	string non-empty
valueHint required	string non-empty
readOnly	any
filter	any
parameterGroup	any
required	any
labelTranslations	any
addUnknownValues	any
typedId	any
alwaysEditable	any
inputs	Array of objects
parameterConfig	object
formattingOptions	object
valueOptions	any

required

object

gridViewState	any
openFolders	any
selectedNodes	any

outputs

required

Array of objects

lastUpdateByName

required

string non-empty

createdByName

required

string non-empty

submittedByName

any

calculationStatus

required

number

dirty

required

boolean

refreshInputs

required

boolean

nodeId

any

userGroupEdit

any

userGroupViewDetails

any

serverMessages

any

additionalInfo1

any

additionalInfo2

any

additionalInfo3

any

additionalInfo4

any

numberOfAttachments

required

number

creationWorkflowStatus

any

creationWorkflowCurrentStep

any

creationWorkflowStepCount

any

creationWorkflowStepLabel

any

signature

any

lineItems

required

Array of objects

expiryDate

required

string non-empty

externalRef

any

customerId

required

string non-empty

customerName

required

string non-empty

customerGroup

any

quoteStatus

required

string non-empty

renderInfo

any

serverMessagesExtended

any

approvalRequiredEmailAttachmentsJson

any

hasWorkflowHistory

required

boolean

approvedByName

any

deniedByName

any

createDate

required

string non-empty

createdBy

required

number

lastUpdateDate

required

string non-empty

lastUpdateBy

required

number

supersededBy

any

prevRev

any

rootUniqueName

required

string non-empty

quoteType

required

string non-empty

status

required

string non-empty

parent

any

skus

required

Array of strings

Responses

200

Example response

Response Schema: application/json

object

node

string non-empty

Array of objects non-empty unique

Array (non-empty)

version	number
typedId	string non-empty
uniqueName	string non-empty
label	string non-empty
targetDate	string non-empty
workflowStatus	string non-empty
headerText	string non-empty
	Array of objects non-empty unique
	object
outputs	Array of objects
lastUpdateByName	string non-empty
createdByName	string non-empty
submittedByName	string non-empty
calculationStatus	number
dirty	boolean
refreshInputs	boolean
nodeId	any
userGroupEdit	any
userGroupViewDetails	any
serverMessages	Array of any
additionalInfo1	any
additionalInfo2	any
additionalInfo3	any
additionalInfo4	any
numberOfAttachments	number
creationWorkflowStatus	any
creationWorkflowCurrentStep	any
creationWorkflowStepCount	any
creationWorkflowStepLabel	any
signature	any
	Array of objects non-empty unique
expiryDate	string non-empty
externalRef	any
customerId	string non-empty
customerName	string non-empty
customerGroup	any
quoteStatus	string non-empty
renderInfo	any
serverMessagesExtended	Array of any non-empty unique
approvalRequiredEmailAttachmentsJson	any
hasWorkflowHistory	boolean
approvedByName	string non-empty
deniedByName	any
createDate	string non-empty
createdBy	number
lastUpdateDate	string non-empty
lastUpdateBy	number
supersededBy	any
prevRev	string non-empty
rootUniqueName	string non-empty
quoteType	any
status	string non-empty

status

number

Request samples

application/json

{"data": {"quote": {"version": 3,
"typedId": "2147491354.Q",
"uniqueName": "P-2147491354",
"label": "New Quote 2021",
"targetDate": "2021-11-02",
"workflowStatus": "DRAFT",
"headerText": "<p>Quote 2021</p>",
"inputs": [{"name": "Customer",
"label": "Customer",
"lookupTableId": null,
"url": "/fetch/C/",
"type": "CUSTOMER",
"value": "00003",
"valueHint": "Kate Smith",
"readOnly": null,
"filter": null,
"parameterGroup": null,
"required": null,
"labelTranslations": null,
"addUnknownValues": null,
"typedId": null,
"alwaysEditable": null,
"inputs": [ ],
"parameterConfig": { },
"formattingOptions": { },
"valueOptions": null
}
],
"viewState": {"gridViewState": null,
"openFolders": null,
"selectedNodes": null
},
"outputs": [ ],
"lastUpdateByName": "admin",
"createdByName": "admin",
"submittedByName": null,
"calculationStatus": 0,
"dirty": false,
"refreshInputs": false,
"nodeId": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"serverMessages": null,
"additionalInfo1": null,
"additionalInfo2": null,
"additionalInfo3": null,
"additionalInfo4": null,
"numberOfAttachments": 0,
"creationWorkflowStatus": null,
"creationWorkflowCurrentStep": null,
"creationWorkflowStepCount": null,
"creationWorkflowStepLabel": null,
"signature": null,
"lineItems": [ ],
"expiryDate": "2021-11-30",
"externalRef": null,
"customerId": "00003",
"customerName": "Kate Smith",
"customerGroup": null,
"quoteStatus": "DRAFT",
"renderInfo": null,
"serverMessagesExtended": null,
"approvalRequiredEmailAttachmentsJson": null,
"hasWorkflowHistory": false,
"approvedByName": null,
"deniedByName": null,
"createDate": "2021-11-02T16:41:33",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-02T16:41:33",
"lastUpdateBy": 2147490696,
"supersededBy": null,
"prevRev": null,
"rootUniqueName": "P-2147491354",
"quoteType": "default",
"status": "DRAFT"
},
"parent": null,
"skus": ["11111",
"22222",
"33333"
]
}
}

Response samples

application/json

{"response": {"node": "e2e-templates-node",
"data": [{"version": 5,
"typedId": "2147491345.Q",
"uniqueName": "P-2147491340-REV-3",
"label": "Quote01",
"targetDate": "2021-11-01",
"workflowStatus": "NO_APPROVAL_REQUIRED",
"headerText": "<p>Quote message.</p>",
"inputs": [{"name": "Customer",
"label": "Customer",
"lookupTableId": null,
"url": "/fetch/C/",
"type": "CUSTOMER",
"value": "00003",
"valueHint": "Kate Smith",
"readOnly": null,
"filter": null,
"parameterGroup": null,
"required": null,
"labelTranslations": null,
"addUnknownValues": null,
"typedId": null,
"alwaysEditable": null,
"inputs": [ ],
"parameterConfig": { },
"formattingOptions": { },
"valueOptions": null
}
],
"viewState": {"gridViewState": null,
"openFolders": null,
"selectedNodes": ["0pnOfOZ0RNyO8LA",
"n0MnhY2gThX7adD",
"IZpgAGs8pCAxG2p"
]
},
"outputs": [ ],
"lastUpdateByName": "admin",
"createdByName": "admin",
"submittedByName": "admin",
"calculationStatus": 0,
"dirty": false,
"refreshInputs": false,
"nodeId": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"serverMessages": ["Quote calculated successfully",
"Quote saved\t"
],
"additionalInfo1": null,
"additionalInfo2": null,
"additionalInfo3": null,
"additionalInfo4": null,
"numberOfAttachments": 0,
"creationWorkflowStatus": null,
"creationWorkflowCurrentStep": null,
"creationWorkflowStepCount": null,
"creationWorkflowStepLabel": null,
"signature": null,
"lineItems": [{"version": 5,
"typedId": "2147515671.QLI",
"clicId": null,
"inputs": [ ],
"outputs": [{"resultName": "price",
"resultLabel": "Price",
"result": 666,
"excludeFromExport": false,
"warnings": null,
"alertMessage": null,
"alertType": null,
"displayOptions": 2,
"formatType": "INTEGER",
"suffix": null,
"resultType": "SIMPLE",
"cssProperties": null,
"userGroup": null,
"resultGroup": null,
"overrideValueOptions": null,
"overrideAllowEmpty": true,
"labelTranslations": null,
"overridable": false,
"overridden": false,
"resultDescription": null
}
],
"dirty": false,
"lineId": "0pnOfOZ0RNyO8LA",
"parentId": null,
"calculationStatus": 0,
"editabilityStatus": 0,
"label": "Label One",
"sku": "11111",
"priceRecordId": null,
"folder": false,
"treeLabel": "Label One",
"createDate": "2021-11-02T14:06:06",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-02T14:06:06",
"lastUpdateBy": 2147490696
},
{"version": 5,
"typedId": "2147515672.QLI",
"clicId": null,
"inputs": [ ],
"outputs": [{"resultName": "price",
"resultLabel": "Price",
"result": 666,
"excludeFromExport": false,
"warnings": null,
"alertMessage": null,
"alertType": null,
"displayOptions": 2,
"formatType": "INTEGER",
"suffix": null,
"resultType": "SIMPLE",
"cssProperties": null,
"userGroup": null,
"resultGroup": null,
"overrideValueOptions": null,
"overrideAllowEmpty": true,
"labelTranslations": null,
"overridable": false,
"overridden": false,
"resultDescription": null
}
],
"dirty": false,
"lineId": "n0MnhY2gThX7adD",
"parentId": null,
"calculationStatus": 0,
"editabilityStatus": 0,
"label": "Label Two",
"sku": "22222",
"priceRecordId": null,
"folder": false,
"treeLabel": "Label Two",
"createDate": "2021-11-02T14:06:06",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-02T14:06:06",
"lastUpdateBy": 2147490696
},
{"version": 5,
"typedId": "2147515673.QLI",
"clicId": null,
"inputs": [ ],
"outputs": [{"resultName": "price",
"resultLabel": "Price",
"result": 666,
"excludeFromExport": false,
"warnings": null,
"alertMessage": null,
"alertType": null,
"displayOptions": 2,
"formatType": "INTEGER",
"suffix": null,
"resultType": "SIMPLE",
"cssProperties": null,
"userGroup": null,
"resultGroup": null,
"overrideValueOptions": null,
"overrideAllowEmpty": true,
"labelTranslations": null,
"overridable": false,
"overridden": false,
"resultDescription": null
}
],
"dirty": false,
"lineId": "IZpgAGs8pCAxG2p",
"parentId": null,
"calculationStatus": 0,
"editabilityStatus": 0,
"label": "Label Three",
"sku": "33333",
"priceRecordId": null,
"folder": false,
"treeLabel": "Label Three",
"createDate": "2021-11-02T14:06:06",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-02T14:06:06",
"lastUpdateBy": 2147490696
}
],
"expiryDate": "2021-11-01",
"externalRef": null,
"customerId": "00003",
"customerName": "Kate Smith",
"customerGroup": null,
"quoteStatus": "OFFER",
"renderInfo": null,
"serverMessagesExtended": [{"key": "QUOTE_CALCULATED",
"message": "Quote calculated successfully"
},
{"key": null,
"message": "Quote saved\t"
}
],
"approvalRequiredEmailAttachmentsJson": null,
"hasWorkflowHistory": false,
"approvedByName": "admin",
"deniedByName": null,
"createDate": "2021-11-02T14:01:54",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-02T14:06:06",
"lastUpdateBy": 2147490696,
"supersededBy": null,
"prevRev": "P-2147491340-REV-2",
"rootUniqueName": "P-2147491340",
"quoteType": null,
"status": "DRAFT"
}
],
"status": 0
}
}