v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB

Get repricing agreements

Retrieves all price agreements periods

This operation will return the full list of saved price agreements periods

get/v1/priceagreement/{id}/period

Path parameters

idstring required

The id of the price agreement to which periods should be fetched

Query parameters

auditUserstring required

The audit user to log the request

pageinteger

Current page

sizeinteger

How many agreement periods should be returned per page, default is 30. Cannot be more than 100.

Response

Successfully retrieved

lowestboolean

After all logic and repricing, should the lowest price apply. I.E the repriced one or the one coming from the merchant.

priceListIdstring

A reference to a price list, using the id of the price list

codestring

Product code for this agreement period

type'PER_EACH' | 'ABSOLUTE' | 'PERCENT'

Tells which kind of discount calculation that applies

validFromstring date-time

The RFC 3339 format date and time from what time the price list should be active. Cannot be null

validTostring date-time

The RFC 3339 format date and time when this price list should stop to be active. Cannot be greater than 'validFrom' of any other price list with the same 'code'. Can be null, which means this price list is active until this field is set

valuenumber

The value connected to the type field above. This can be 45.4 PER_EACH, 5.0 PERCENT etc.

idstring

The id of a price agreement period

priceAgreementIdstring

The primary key of the price agreement

Example response

[
  {
    "validFrom": "2022-05-12T13:18:05Z",
    "validTo": "2022-05-12T13:18:05Z"
  }
]