Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Export an Excel File

The Pricefx Backend API

Pricefx REST API Reference

Download OpenAPI description
pricefx-server_openapi.json
pricefx-server_openapi.yaml
Overview
URL
https://www.pricefx.com
Pricefx
documentation@pricefx.com
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}

General

Operations

Products

Operations

Product Extensions

Operations

Product Image

Operations

Customers

Operations

Customer Extensions

Operations

Sellers

Operations

Seller Extensions

Operations

Condition Records

Operations

Competition Data

Operations

Imports

Operations

Data Change Requests

Operations

Lookup Tables / Company Parameters

Operations

User Admin

Operations

Authentication

Operations

Admin Tools

Operations

Logics

Operations

Logs

Operations

Custom Forms

Operations

Calculated Field Sets

Operations

Jobs & Tasks

Operations

Data Manager

Operations

Actions

Operations

Action Types

Operations

Price Lists

Operations

Manual Price Lists

Operations

Live Price Grids

Operations

Calculation Grids

Operations

Visual Configuration

Operations

Quotes

Operations

Submit a Quote

Request

Submits a specified quote.

Required PermissionRoles with the Required Permission
QUOTE_UPDATEEdit Quoting (PRICESHOP_EDIT), Administer Quoting (PRICESHOP_QUOTEADMIN), Manage Quoting (PRICESHOP)
Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobjectrequired
data.​quoteobjectrequired
data.​quote.​versionnumber
data.​quote.​typedIdstringnon-emptyrequired
data.​quote.​uniqueNamestringnon-emptyrequired
data.​quote.​labelstringnon-empty
data.​quote.​targetDatestringnon-empty
data.​quote.​workflowStatusstringnon-empty
data.​quote.​headerTextstringnon-empty
data.​quote.​inputsArray of objectsnon-emptyuniquerequired
data.​quote.​inputs[].​namestringnon-empty
data.​quote.​inputs[].​labelstringnon-empty
data.​quote.​inputs[].​lookupTableIdany
data.​quote.​inputs[].​urlstringnon-empty
data.​quote.​inputs[].​typestringnon-empty
data.​quote.​inputs[].​valuestringnon-empty
data.​quote.​inputs[].​valueHintstringnon-empty
data.​quote.​inputs[].​readOnlyany
data.​quote.​inputs[].​filterany
data.​quote.​inputs[].​parameterGroupany
data.​quote.​inputs[].​requiredany
data.​quote.​inputs[].​labelTranslationsany
data.​quote.​inputs[].​addUnknownValuesany
data.​quote.​inputs[].​typedIdany
data.​quote.​inputs[].​alwaysEditableany
data.​quote.​inputs[].​inputsArray of objects
data.​quote.​inputs[].​parameterConfigobject
data.​quote.​inputs[].​formattingOptionsobject
data.​quote.​inputs[].​valueOptionsany
data.​quote.​viewStateobject
data.​quote.​outputsArray of objects
data.​quote.​lastUpdateByNamestringnon-empty
data.​quote.​createdByNamestringnon-empty
data.​quote.​submittedByNamestringnon-empty
data.​quote.​calculationStatusnumber
data.​quote.​dirtyboolean
data.​quote.​refreshInputsboolean
data.​quote.​nodeIdany
data.​quote.​userGroupEditany
data.​quote.​userGroupViewDetailsany
data.​quote.​serverMessagesany
data.​quote.​additionalInfo1any
data.​quote.​additionalInfo2any
data.​quote.​additionalInfo3any
data.​quote.​additionalInfo4any
data.​quote.​numberOfAttachmentsnumber
data.​quote.​creationWorkflowStatusany
data.​quote.​creationWorkflowCurrentStepany
data.​quote.​creationWorkflowStepCountany
data.​quote.​creationWorkflowStepLabelany
data.​quote.​signatureany
data.​quote.​lineItemsArray of objectsnon-emptyunique
data.​quote.​expiryDatestringnon-empty
data.​quote.​externalRefany
data.​quote.​customerIdstringnon-empty
data.​quote.​customerNamestringnon-empty
data.​quote.​customerGroupany
data.​quote.​quoteStatusstringnon-empty
data.​quote.​renderInfoany
data.​quote.​serverMessagesExtendedany
data.​quote.​approvalRequiredEmailAttachmentsJsonany
data.​quote.​hasWorkflowHistoryboolean
data.​quote.​approvedByNameany
data.​quote.​deniedByNameany
data.​quote.​createDatestringnon-empty
data.​quote.​createdBynumber
data.​quote.​lastUpdateDatestringnon-empty
data.​quote.​lastUpdateBynumber
data.​quote.​supersededByany
data.​quote.​prevRevstringnon-empty
data.​quote.​rootUniqueNamestringnon-empty
data.​quote.​quoteTypeany
data.​quote.​statusstringnon-empty
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/quotemanager.submit \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "quote": {
        "version": 0,
        "typedId": "string",
        "uniqueName": "string",
        "label": "string",
        "targetDate": "string",
        "workflowStatus": "string",
        "headerText": "string",
        "inputs": [
          {
            "name": "string",
            "label": "string",
            "lookupTableId": null,
            "url": "string",
            "type": "string",
            "value": "string",
            "valueHint": "string",
            "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": [
            {}
          ]
        },
        "outputs": [
          {}
        ],
        "lastUpdateByName": "string",
        "createdByName": "string",
        "submittedByName": "string",
        "calculationStatus": 0,
        "dirty": true,
        "refreshInputs": true,
        "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": [
          {
            "version": 0,
            "typedId": "string",
            "clicId": 0,
            "inputs": [
              {}
            ],
            "outputs": [
              {
                "resultName": "string",
                "resultLabel": "string",
                "result": 0,
                "excludeFromExport": true,
                "warnings": null,
                "alertMessage": null,
                "alertType": null,
                "displayOptions": 0,
                "formatType": "string",
                "suffix": null,
                "resultType": "string",
                "cssProperties": null,
                "userGroup": null,
                "resultGroup": null,
                "overrideValueOptions": null,
                "overrideAllowEmpty": true,
                "labelTranslations": null,
                "overridable": true,
                "overridden": true,
                "resultDescription": null
              }
            ],
            "dirty": true,
            "lineId": "string",
            "parentId": null,
            "calculationStatus": 0,
            "editabilityStatus": 0,
            "label": "string",
            "sku": "string",
            "priceRecordId": null,
            "folder": true,
            "treeLabel": "string",
            "createDate": "string",
            "createdBy": 0,
            "lastUpdateDate": "string",
            "lastUpdateBy": 0
          }
        ],
        "expiryDate": "string",
        "externalRef": null,
        "customerId": "string",
        "customerName": "string",
        "customerGroup": null,
        "quoteStatus": "string",
        "renderInfo": null,
        "serverMessagesExtended": null,
        "approvalRequiredEmailAttachmentsJson": null,
        "hasWorkflowHistory": true,
        "approvedByName": null,
        "deniedByName": null,
        "createDate": "string",
        "createdBy": 0,
        "lastUpdateDate": "string",
        "lastUpdateBy": 0,
        "supersededBy": null,
        "prevRev": "string",
        "rootUniqueName": "string",
        "quoteType": null,
        "status": "string"
      }
    }
  }'

Responses

Example response

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "e2e-templates-node",
    "data": [ … ],
    "status": 0
  }
}

Export an Excel File

Request

Downloads the XLSX file of the specified quote.

Required PermissionRoles with the Required Permission
QUOTE_FETCHFILTEREDView Quoting (PRICESHOP_RO), Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Edit Quoting (PRICESHOP_EDIT), Administer Quoting (PRICESHOP_QUOTEADMIN), Manage Quoting (PRICESHOP), Manage Workflow Logics (WF_BUILDER)
Security
basic or X-PriceFx-jwt
Path
uniqueNamestringrequired

Specify the uniqueName of the quote you want to download.

Example: P-2147491340-REV-3
Query
templateNamestring

Specifies the template to be used when exporting a file.

outputstring

Specifies the format of the output file.

Enum"json""xls""csv""pdf"
Example: output=xls
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/quotemanager.fetchxls/P-2147491340-REV-3?templateName=string&output=xls'

Responses

OK - returns a file data.

Export a DOCX File

Request

Downloads the DOCX file of the specified quote.

Required PermissionRoles with the Required Permission
QUOTE_FETCHFILTEREDView Quoting (PRICESHOP_RO), Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Edit Quoting (PRICESHOP_EDIT), Administer Quoting (PRICESHOP_QUOTEADMIN), Manage Quoting (PRICESHOP), Manage Workflow Logics (WF_BUILDER)
Security
basic or X-PriceFx-jwt
Path
uniqueNamestringrequired

Specify the uniqueName of the quote you want to download.

Example: P-2147491340-REV-3
Query
templateNamestring

Specifies the template to be used when exporting a file.

outputstring

Specifies the format of the output file.

Enum"json""xls""csv""pdf"
Example: output=xls
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/quotemanager.fetchdocx/P-2147491340-REV-3?templateName=string&output=xls'

Responses

OK

Contracts (Agreements & Promotions)

Operations

Visual Configuration

Operations

Rebate Agreements

Operations

Rebate Calculations

Operations

Rebate Record Group

Operations

Sales Compensations

Operations

Claim Types

Operations

Claims

Operations

Optimization

Operations

Workflow

Operations

Workflow Delegation

Operations

Attachments

To upload a file you need to perform the following actions using endpoints in this category:

  1. Create an Upload Slot
  2. Upload a File
  3. Delete an Upload Slot
Operations

Product Image

Operations

Configuration

Operations

Internationalization

Operations

Metadata

Operations

Clicmanager

Clicmanager (CLIC = "Calculable Line Item Collection") endpoints are used in the REACT version to manipulate Quote/Agreements & Promotions (Contract)/Rebate Agreement/Compensation Plan objects.

Operations

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

See the Key-Value Database Storage Knowledge Base article for more details.

Operations

Entities

Here you can find all fields of the corresponding entity (represented by the type code).
Use the /metadata.describe endpoint to find out the correct data type of the field that is used in your partition.

otherSchemas

Schemas