Pricelist
The Pricelist object includes key pricing details such as sales and purchase prices, enabling vendors and operations to effectively manage and apply different price points for product items. This is essential for aligning pricing strategies with market and internal financial objectives.
The Pricelist object contains the following properties:
id
string
The business identifier of the price list.
Example: PRC-1234-5678-9012
href
string
The resource URI of the price list.
Example: /v1/price-lists/PRC-1234-5678-9012
currency
string
The ISO code for the currency.
Example: EUR
precision
integer
Precision of the pricelist as decimal places.
Example: 3
notes
string
The notes about the price list.
Example: This is the primary price list for the EU region.
statistics
priceListStatistics
The system calculated metrics about the price list.
audit
A reference to the Audit object.
Example:
{
"created": {
"at": "2023-12-14T17:28:57Z",
"by": {
"id": "UR-1234-1234-1234",
"name": "John Smith",
"icon": "/static/users/UR-1234-1234-1234.icon.svg"
}
}
PriceListStatistics
sellers
integer
The number of Sellers that are using this Price List.
Example: 10
listings
integer
The number of Listings that are using this Price List.
Example: 12
priceListitems
integer
The total number of pricelist Items on the Price List.
Example: 23
purchasePriceItems
integer
The number of Items with a populated purchase price.
Example: 10
purchasePriceCompleteness
integer
The percentage of Items with a populated purchase price.
Example: 0.4347826
Example
{
"id": "PRC-1234-5678-9012",
"currency": "EUR",
"precision": 3,
"notes": "This is the primary Price List for the EU region",
"statistics": {
"sellers": 10,
"listings": 12,
"items": 23,
"purchasePriceItems": 10,
"purchasePriceCompleteness": 0.4347826
},
"product": {
"id": "PRD-1234-5678"
},
"vendor": {
"id": "ACC-1671-0642"
}
}
Last updated
Was this helpful?