Price lists
Contents
Info
The Price list API is used for inserting and updating prices in the CloudSuite platform. Below we include a few methods and examples. This includes customer-specific prices, contracts, and individual prices, including price tiers.
See: https://cloudsuite.atlassian.net/wiki/spaces/CFL/pages/1802502560/Data+API#Price-list-API
Below only describes how to add the pricelist itself. In order to connect the pricelist to a customer you need to add this field in the customer message
Fields
Pricelist
Field | Value |
|---|---|
key | A unique key for this list |
origin | The origin for this pricelist |
type | group, party, action, contract |
name | Name of the list |
rounding | The way the prices are rounded. 0.01 means rounded by cents on 2 decimals |
kind | sale |
active | True / false |
currency | Currency for the pricelist, eq. EUR of USD |
company | Import_key of the company |
product_contracts | List of contacts |
Contract
Field | Value |
|---|---|
key | Unique key for the contract within the pricelist |
origin | The origin of this contract (same as the pricelist) |
active | True / false |
lines | List of lines |
start_date | Start date of the contract |
end_date | End date of the contract |
Priceline
Field | Value | Remarks |
|---|---|---|
product | The import_key of the product |
|
base | cost_price, purchase_price, list_price, nothing | Insert a value or do not set the base. Only use base when percentage=true is used. |
create_netprice | Create a net price for this product |
|
additional_discount | In case of additional discounts on top of this discount |
|
price_uom | The UOM of the price. | If the price is given in Kg and the sale UOM is different (per box of 12 kilos), you can use it. |
tiers - quantity | Number of items for this price/percentage |
|
tiers - value | The percentage of the price itself | Use positive values for discount. |
percentage | The value in the tier is a percentage or not |
|
Usage full pricelist
URL
https://test.cloudsuite.io/api/origin/CLOUDSUITE/pricelist/PrijslijstA/Request
{
"key": "PrijslijstA",
"origin": "CLOUDSUITE",
"type": "group",
"name": "PrijslijstA",
"rounding": "0.01",
"kind": "sale",
"active": true,
"currency": "EUR",
"company": "CLOUDSUITEBV",
"product_contracts": [
{
"key": "PrijslijstA_contract",
"origin": "CLOUDSUITE",
"active": true,
"start_date": "2023-10-01",
"end_date": "2023-10-20",
"lines": [
{
"product": "PRODUCTID1",
"base": "list_price",
"tiers": [
{
"quantity": 1,
"value": "90.00"
},
{
"quantity": 100,
"value": "80.00"
}
]
},
{
"product": "PRODUCTID2",
"base": "list_price",
"tiers": [
{
"quantity": 1,
"value": "91.00"
},
{
"quantity": 100,
"value": "81.00"
}
]
}
]
},
{
"key": "PrijslijstA_contract2",
"origin": "CLOUDSUITE",
"active": true,
"start_date": "2023-11-01",
"end_date": "2023-12-20",
"lines": [
{
"product": "PRODUCTID3",
"base": "list_price",
"tiers": [
{
"quantity": 1,
"value": "90.00"
},
{
"quantity": 100,
"value": "80.00"
}
]
},
{
"product": "PRODUCTID4",
"base": "list_price",
"tiers": [
{
"quantity": 1,
"value": "91.00"
},
{
"quantity": 100,
"value": "81.00"
}
]
}
]
}
]
}Usage product contract pricelist
The contract can or cannot be filled with elements. This depend on the method
URL
PUT https://test.cloudsuite.io/api/origin/CLOUDSUITE/pricelist/PrijslijstA/
POST https://test.cloudsuite.io/api/origin/CLOUDSUITE/pricelist/Request
{
"key" : "PrijslijstA",
"origin" : "CLOUDSUITE",
"type" : "group",
"name" : "PrijslijstA",
"rounding" : "0.01",
"kind" : "sale",
"active" : true,
"currency" : "EUR",
"company" : "CLOUDSUITEBV",
"product_contracts" : [
]
}
Usage product priceline in contract pricelist
URL
https://test.cloudsuite.io/api/origin/CLOUDSUITE/pricelist/PrijslijstA/product_contracts/PrijslijstA_contract/line/PRODUCTID1/Request
{
"product" : "PRODUCTID1",
"base" : "list_price",
"percentage": true,
"tiers" : [
{
"quantity" : 1,
"value" : "10.00"
},
{
"quantity" : 100,
"value" : "15.00"
}
]
}
Scenarios
Fill big pricelist asynchronous
Related content
© 2024 CloudSuite BV, All rights reserved