Price list codes

Price list codes describes the discount matrix use to calculate nett product prices for your customers.

Price list code

id
string <uuid>

Price list code identifier.

code
string [ 3 .. 5 ] characters ^[A-Z0-9]{3,5}$

Human-readable provider-unique code.

description
string [ 0 .. 255 ] characters

Contextual information for price list code.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "VOG30",
  • "description": "30% discount for all product-groups"
}

Retrieve all price list codes

Retrieve a list of price list codes.

SecurityOAuth2
Request
query Parameters
limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Price list code) >= 0 items

List of price list codes.

Array (>= 0 items)
id
string <uuid>

Price list code identifier.

code
string [ 3 .. 5 ] characters ^[A-Z0-9]{3,5}$

Human-readable provider-unique code.

description
string [ 0 .. 255 ] characters

Contextual information for price list code.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/product-catalog/price-list-codes
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Retrieve a price list code

Retrieve a single price list code by its identifier.

SecurityOAuth2
Request
path Parameters
price-list-code-id
required
string <uuid>

Price list code identifier.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Price list code identifier.

code
string [ 3 .. 5 ] characters ^[A-Z0-9]{3,5}$

Human-readable provider-unique code.

description
string [ 0 .. 255 ] characters

Contextual information for price list code.

default

An error occurred - see status code and problem response for more information.

get/v2/product-catalog/price-list-codes/{price-list-code-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "VOG30",
  • "description": "30% discount for all product-groups"
}