Pricelists

Pricelist object

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 tool is essential for aligning pricing strategies with market and internal financial objectives.

Field	Type	Description
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	Currency as ISO code. Example: "EUR"
precision	integer	Precision of the Price List as number of decimal places. Example: "3"
notes	string	Any user notes about the Price List. Example: "This is the primary Price List for the EU region"
externalIds	ExternalIds	Example: { "vendor": "op-322-322", }
statistics	PriceListStatistics	System calculated metrics about the Price List
product	Product	The Product that the Price List belongs to.
vendor	Account	The Vendor that the Price List belongs to. The field is visible only for OPS
audit	Audit	Audit events for the 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

Field	Type	Description
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 pice list Items on the Price List. Example: "23"
purchasePriceItems	integer	The number of Items with a populated purchase price. Example: "10"
purchasePriceCompleteness	decimal	The percentage of Items with a populated purchase price. Example: "0.4347826"

Example

PRICE LIST OBJECT

{
  "id": "PRC-1234-5678-9012",
  "href": "/v1/price-lists/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"
  }
}