The price list object
A comprehensive list of the price list resource's attributes and relationships
A price list object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/price_lists
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The price list unique identifier |
links.self |
| The price list endpoint URL |
attributes.code |
| A string that you can use to identify the price list (must be unique within the environment). |
attributes.created_at |
| Time at which the resource was created. |
attributes.currency_code |
| The international 3-letter currency code as defined by the ISO 4217 standard. |
attributes.metadata |
| 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. |
attributes.name |
| The price list's internal name. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code. |
attributes.rule_outcomes |
| The rule outcomes. |
attributes.rules |
| The rules (using Rules Engine) to be applied. |
attributes.tax_included |
| Indicates if the associated prices include taxes. |
attributes.updated_at |
| Time at which the resource was last updated. |
relationships.attachments |
| The associated attachments. |
relationships.price_list_schedulers |
| The associated price list schedulers. |
relationships.prices |
| The associated prices. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated