Skip to content
Pricefx REST API
/Pricefx API Reference/
/
OAuth Authorization Reque...

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

Authenticate with SAML

Request

Redirects to the Identity Provider (IdP) for authentication.

Security
basic or X-PriceFx-jwt
Query
keepSessionboolean

Set to true to reuse an existing session and avoid unnecessary roundtrips to the IdP. When set to true, if a valid session is detected, the endpoint will directly redirect to the target page as per RelayState without performing an IdP roundtrip. If no session or an expired session is found, the endpoint will perform the IdP roundtrip as usual.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/saml/signon?keepSession=true'

Responses

OK - Redirects to the target page if a valid session exists.

OAuth Authorization Request

Request

The authorization endpoint is used to interact with the resource owner and obtain an authorization grant. See https://datatracker.ietf.org/doc/html/rfc6749#section-3.1 for details. At the end of the flow it will send a code value back to/via the redirecttion URL specified in the client’s config & initial request (as they need to be the same).

Security
basic or X-PriceFx-jwt
Query
response_typestringrequired

Value MUST be set to "code".

client_idstringrequired

The client identifier.

redirect_uristring

The URL to redirect to after authorization has been granted.

scopestring

The scope of the access request.

statestring

An opaque value used by the client to maintain state between the request and callback.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/oauth/authorize?response_type=string&client_id=string&redirect_uri=string&scope=string&state=string'

Responses

Found

Access Token Request

Request

Request to obtain the access token in the OAuth authorization process. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.3 for details.

Security
basic or X-PriceFx-jwt
Query
grant_typestringrequired

Value MUST be set to "authorization_code".

codestringrequired

The authorization code received from the authorization server.

redirect_uristring

Required if the "redirect_uri" parameter was included in the authorization request and their values MUST be identical.

client_idstring

Required if the client is not authenticating with the authorization server.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/oauth/token?grant_type=string&code=string&redirect_uri=string&client_id=string'

Responses

OK

Bodyapplication/json
access_tokenstring
token_typestring
expires_ininteger
refresh_tokenstring
example_parameterstring
Response
application/json
{
  "access_token": "2YotnFZFEjr1zCsicMWpAA",
  "token_type": "bearer",
  "expires_in": 7200,
  "refresh_token": "tGzv3JOkF0XG5Qx2TlKWIA",
  "example_parameter": "example_value"
}

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

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