List price lists

Returns price lists for the authenticated account. A price list lets you override variant prices for specific customer groups or channels.

GET/price_lists

Authorization

AuthorizationBearer token (JWT) · headerrequired

Query parameters

seller_idinteger

Filter price lists by seller ID.

currencystring

Filter price lists by currency code (ISO 4217).

pageinteger

min 1 · default: 1

per_pageinteger

min 1 · max 200 · default: 20

Responses

200

Paginated list of price lists

total_itemsinteger

per_pageinteger

pageinteger

_linksHalLinks

_classstring[]

_embeddedobject

Show properties

price_listsPriceList[]

Show properties

Array of PriceList

_linksHalLinks

idinteger

namestring

currency_codestring

prices_include_taxboolean

use_price_comparison_for_vol_discountsboolean

taxnumber

contact_groups_countinteger

created_onstring<date-time>

updated_onstring<date-time>

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

seller_idqueryFilter price lists by seller ID.currencyqueryFilter price lists by currency code (ISO 4217).pagequeryper_pagequery

Request

curl -X GET 'https://api.onbolder.com/v2/price_lists' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/price_lists", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/price_lists",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "_class": [
    "results",
    "price_lists"
  ],
  "total_items": 1,
  "per_page": 20,
  "page": 1,
  "_links": {
    "self": {
      "href": "https://api.onbolder.com/v2/price_lists"
    },
    "products:create_price_list": {
      "href": "https://api.onbolder.com/v2/price_lists",
      "method": "post"
    }
  },
  "_embedded": {
    "items": [
      {
        "id": 10,
        "name": "Wholesale EUR",
        "currency_code": "EUR",
        "created_on": "2024-01-15T10:00:00Z",
        "_links": {
          "self": {
            "href": "https://api.onbolder.com/v2/price_lists/10"
          }
        }
      }
    ]
  }
}