Price lists

The price list object and its fields

Price lists determine the SKU prices and their currency within a market. Create more price lists if you need to manage international business models or B2B/B2C (learn more).

The price list object

A price list object is returned as part of the response body of each successful create, list, retrieve, or update API call.

Field

Type

Description

type

string

price_lists

id

string

The price list unique identifier

links.self

string

The price list endpoint URL

attributes.name

string

The market's internal name

attributes.currency_code

string

The international 3-letter currency code as defined by the ISO 4217 standard.

attributes.tax_included

boolean

Indiceates if the associated prices include taxes.

attributes.id

string

Unique identifier for the resource (hash).

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add your own identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool or a CRM.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.prices

array

The associated prices.

meta.mode

string

The resource environment (can be one of test or live)