Skip to main content

Get a price list by id

Returns a price list definition by id. Only custom price lists are supported.

Path Parameters
id int32 REQUIRED

The id of the price list.

Responses
200

The price list.

Schema OPTIONAL
Resource object OPTIONAL

A price list definition.

Id int32 OPTIONAL

Price list id.

Name string OPTIONAL

Price list name.

MarketId int32 OPTIONAL

Market id.

MarketPrefix string OPTIONAL

Market prefix. Eg: SE.

Currency string OPTIONAL

Currency abbreviation. Eg: SEK.

Forced boolean OPTIONAL

When true, prices from this price list are used regardless if the ordinary price is lower.

CreatedAt date-time OPTIONAL

When the price list was created.

Identifier string OPTIONAL

A custom identifier for this price list that can be used instead of the id in some situations.

Active boolean OPTIONAL

Indicates if this price list is active.

Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.

404

Price list not found.

Schema OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.