Skip to content

Price Engine - API Documentation

Main Navigation Home Getting Started API Reference

Appearance

manageprices.com

Sidebar Navigation

Guide

Getting Started

Authentication

Channels

Errors

Channel API

GET Find all channels

POST Create new channel

GET Get all active channels

GET Get channel by code

DELETE Delete channel

PATCH Update channel

GET Get customer groups assigned to channel

GET Get trade conditions assigned to channel

GET Get promotions assigned to channel

GET Get pricelist assigned to channel

POST Assign pricelist to channel

GET Get customers assigned to channel (direct and via group)

PUT Set primary pricelist for channel (auto-assigns if not yet assigned)

DELETE Remove primary pricelist flag from channel

DELETE Unassign pricelist from channel

POST Bulk assign customers to channel by code

POST Bulk unassign customers from channel by code

POST Bulk assign customer groups to channel by code

POST Bulk unassign customer groups from channel by code

POST Assign trade condition to channel

DELETE Unassign trade condition from channel

Customer API

GET Find all customers

POST Create new customer

GET Get customer by code

DELETE Delete customer

PATCH Update customer

GET Get customer trade conditions

GET Get customer individual pricelist

GET Get customer assigned pricelist

POST Assign pricelist to customer

GET Get customer price and their base prices

GET Get products and their catalog prices (included promotions)

GET Get promotions by code

GET Get available channels for customer

POST Unassign pricelist from customer

POST Assign trade condition to customer

POST Unassign trade condition from customer

Customer Group API

GET Find all customer groups

POST Create new customer group

GET Get customer group by code

DELETE Delete customer group

PATCH Update customer group

GET Get customer group trade conditions

GET Get customer group pricelist

POST Assign pricelist to customer group

POST Unassign pricelist from customer group

POST Assign trade condition to customer group

POST Unassign trade condition from customer group

Promotion API

GET Get promotion list

GET Get active promotion list for SKUS/Customer

GET Get promotion by ID

GET Get catalog prices

POST Get catalog prices

POST Get cart prices

Product API

GET Get products list

GET List all products (paginated, searchable by code)

POST Create a new product

GET Get a product by code (includes attributes and categories)

DELETE Delete a product and all related pricing data

PATCH Partially update a product (code is immutable)

Pricelist API

GET Find all pricelists

POST Create a new standard pricelist

GET Find all regular pricelist

GET Find all pricelist with customer scope

POST Create an individual pricelist for a customer

GET Get a pricelist by ID

DELETE Delete a DRAFT pricelist

PATCH Partially update a pricelist

GET Get pricelist prices

PUT Strict upsert: all productCodes must exist or request fails with 400

PATCH Tolerant upsert: unknown productCodes are skipped, rest are saved

DELETE Delete an individual (DRAFT) pricelist

GET Get customers assigned to pricelist

POST Assign customers to a pricelist

GET Get customer groups assigned to pricelist

POST Assign customer groups to a pricelist

POST Unassign customers from a pricelist

POST Unassign customer groups from a pricelist

Supplier Pricelist API

GET Find all supplier pricelists

GET Find single supplier pricelist

GET Get supplier pricelist products

Trade Conditions API

GET Find all trade conditions

POST Create trade condition

GET Find single trade condition

DELETE Delete trade condition

PATCH Partial update trade condition

POST Assign customers to trade condition

POST Unassign customers from trade condition

POST Assign customer groups to trade condition

POST Unassign customer groups from trade condition

GET Find products assigned to a trade condition

Create new channel

POST

/v1/api/channel

Authorizations

x-webhook-signature

Type

API Key (header: x-webhook-signature)

Request Body

application/json

JSON

"string"

Responses

Channel created successfully

POST

/v1/api/channel

Playground

Server

Authorization

x-webhook-signature

Body

Samples

Powered by VitePress OpenAPI

Pager

Previous page GET Find all channels

Next page GET Get all active channels