Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
SalesPrice

🔒 List sales prices V3

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: salesPrice:read.

Paginated list of SalesPrices.

get/api/v3/salesPrices

Query parameters

key'id' | 'product.id' | 'customer.id' | 'group.id' | 'currency' | 'amount' | 'remark' | 'validFrom' | 'expiresAt' | 'createdAt' | 'updatedAt'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'lessThanOrEquals' | 'greaterThanOrEquals'

operator

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

id: equals, notEquals, in, notIn

product.id: equals, notEquals, in, notIn

customer.id: equals, notEquals, in, notIn

group.id: equals, notEquals, in, notIn

currency: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

amount: equals, notEquals, in, notIn, greaterThan, lessThan

remark: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

validFrom: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

expiresAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

createdAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

updatedAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

sortstring[]

Sort via id, -id, amount, -amount, createdAt, -createdAt, updatedAt and -updatedAt. Default sort is -created_at

perPageinteger
Example:15

Number of items per page. Default: 15, Max: 100

pageinteger
Example:1

Page number.

Response

Paginated list of SalesPrices.

Example response

{
  "data": [
    {
      "id": "1337",
      "product": {
        "id": "1337"
      },
      "customer": {
        "id": "1337"
      },
      "customerGroup": {
        "id": "1337"
      },
      "price": {
        "amount": "13.37",
        "currency": "EUR"
      },
      "amount": 13.37,
      "packageAmount": 13.37,
      "customerProductNumber": "Number1",
      "isNotCalculatedFromExchangeTable": true,
      "remark": "remark example",
      "validFrom": "2025-01-01",
      "expiresAt": "2025-01-01"
    }
  ],
  "meta": {
    "currentPage": 1,
    "from": 1,
    "path": "https://api.example.com/items",
    "perPage": 15,
    "to": 15
  },
  "links": {
    "first": "https://api.example.com/items?page=1",
    "next": "https://api.example.com/items?page=17"
  }
}