Skip to content

The Pricefx Backend API

Pricefx REST API Reference

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

2. Upload a File

Request

Uploads a file and adds it to the specified product.

To upload a file you need to retrieve the slot ID using the /uploadmanager.newuploadslot (Create an Upload Slot) endpoint.

Information

To upload a file you need to perform the following actions:

  1. Create an Upload Slot
  2. Upload a File
  3. Delete an Upload Slot
Security
basic or X-PriceFx-jwt
Path
slot_idstringrequired

Enter the ID of the slot you want to use for the upload.

Example: 2665
skustringrequired

Enter the sku of the product you want to add the product image to.

Bodymultipart/form-data
filestring(binary)

A base64 encoded file data.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/productimages.upload/2665/{sku}' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

OK

3. Delete an Upload Slot

Request

Deletes the upload slot that has been created using the /uploadmanager.newuploadslot (Create an Upload Slot) method and retrieves the file upload status, file version and other details.

Information

To upload a file you need to perform the following actions:

  1. Create an Upload Slot
  2. Upload a File
  3. Delete an Upload Slot
Security
basic or X-PriceFx-jwt
Path
slot_idstringrequired

Enter the ID of the slot you want to delete.

Example: 2665
curl -i -X GET \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/uploadmanager.deleteslot/2665

Responses

OK

Bodyapplication/json
responseobjectrequired
response.​nodestringnon-emptyrequired
response.​csrfTokenstringnon-emptyrequired
response.​dataArray of objectsnon-emptyuniquerequired
response.​data[].​versionnumberrequired
response.​data[].​typedIdstringnon-emptyrequired
response.​data[].​contentLengthnumberrequired
response.​data[].​totalBytesReadnumberrequired
response.​data[].​statusstringnon-emptyrequired
response.​data[].​dataany
response.​data[].​ownerany
response.​data[].​percentagenumberrequired
response.​data[].​createDatestringnon-emptyrequired
response.​data[].​createdBynumberrequired
response.​data[].​lastUpdateDatestringnon-emptyrequired
response.​data[].​lastUpdateBynumberrequired
response.​statusnumberrequired
Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [], "status": 0 } }

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

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

2. Upload a File

Request

Uploads a file and adds it to the specified product.

To upload a file you need to retrieve the slot ID using the /uploadmanager.newuploadslot (Create an Upload Slot) endpoint.

Information

To upload a file you need to perform the following actions:

  1. Create an Upload Slot
  2. Upload a File
  3. Delete an Upload Slot
Security
basic or X-PriceFx-jwt
Path
slot_idstringrequired

Enter the ID of the slot you want to use for the upload.

Example: 2665
skustringrequired

Enter the sku of the product you want to add the product image to.

Bodymultipart/form-data
filestring(binary)

A base64 encoded file data.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/productimages.upload/2665/{sku}' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

OK

3. Delete an Upload Slot

Request

Deletes the upload slot that has been created using the /uploadmanager.newuploadslot (Create an Upload Slot) method and retrieves the file upload status, file version and other details.

Information

To upload a file you need to perform the following actions:

  1. Create an Upload Slot
  2. Upload a File
  3. Delete an Upload Slot
Security
basic or X-PriceFx-jwt
Path
slot_idstringrequired

Enter the ID of the slot you want to delete.

Example: 2665
curl -i -X GET \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/uploadmanager.deleteslot/2665

Responses

OK

Bodyapplication/json
responseobjectrequired
response.​nodestringnon-emptyrequired
response.​csrfTokenstringnon-emptyrequired
response.​dataArray of objectsnon-emptyuniquerequired
response.​data[].​versionnumberrequired
response.​data[].​typedIdstringnon-emptyrequired
response.​data[].​contentLengthnumberrequired
response.​data[].​totalBytesReadnumberrequired
response.​data[].​statusstringnon-emptyrequired
response.​data[].​dataany
response.​data[].​ownerany
response.​data[].​percentagenumberrequired
response.​data[].​createDatestringnon-emptyrequired
response.​data[].​createdBynumberrequired
response.​data[].​lastUpdateDatestringnon-emptyrequired
response.​data[].​lastUpdateBynumberrequired
response.​statusnumberrequired
Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [], "status": 0 } }

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