Skip to content
Pricefx REST API
/
/Product Image

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

1. Create an Upload Slot

Request

Returns a slot ID that is needed for the /bdmanager.upload/{typedId}/{slot_id}, or /productimages.upload/{slot_id}/{sku} (Upload a File) 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
curl -i -X GET \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/uploadmanager.newuploadslot

Responses

Slot created.

Bodyapplication/json
nodestringnon-empty
csrfTokenstringnon-empty
dataArray of objectsnon-emptyunique
statusnumber
Response
application/json
{
  "response": {
    "node": "node",
    "csrfToken": "token",
    "data": [ … ],
    "status": 0
  }
}

1. Create an Upload Slot

Request

Returns a slot ID that is needed for the /bdmanager.upload/{typedId}/{slot_id}, or /productimages.upload/{slot_id}/{sku} (Upload a File) endpoint. Same behavior and response as GET /uploadmanager.newuploadslot.

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
Query
ownerTypedIdstring

Optionally, the request URL can include the ownerTypedId parameter if the uploaded file should be attached to a specific owner entity, such as a Quote (Typed ID).

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/uploadmanager.newuploadslot?ownerTypedId=string'

Responses

Slot created.

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

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

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

Advanced Configuration Options

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

Operations

Product Image

Operations

1. Create an Upload Slot

Request

Returns a slot ID that is needed for the /bdmanager.upload/{typedId}/{slot_id}, or /productimages.upload/{slot_id}/{sku} (Upload a File) 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
curl -i -X GET \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/uploadmanager.newuploadslot

Responses

Slot created.

Bodyapplication/json
nodestringnon-empty
csrfTokenstringnon-empty
dataArray of objectsnon-emptyunique
statusnumber
Response
application/json
{
  "response": {
    "node": "node",
    "csrfToken": "token",
    "data": [ … ],
    "status": 0
  }
}

1. Create an Upload Slot

Request

Returns a slot ID that is needed for the /bdmanager.upload/{typedId}/{slot_id}, or /productimages.upload/{slot_id}/{sku} (Upload a File) endpoint. Same behavior and response as GET /uploadmanager.newuploadslot.

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
Query
ownerTypedIdstring

Optionally, the request URL can include the ownerTypedId parameter if the uploaded file should be attached to a specific owner entity, such as a Quote (Typed ID).

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/uploadmanager.newuploadslot?ownerTypedId=string'

Responses

Slot created.

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

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

Configuration

Operations

Internationalization

Operations

Metadata

Operations

MCP

Operations

Clicmanager

Operations

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

Operations

Entities

otherSchemas

Schemas