Create a price list

POST/price_lists

Authorization

AuthorizationBearer token (JWT) · headerrequired

Request body

requiredapplication/json

seller_idintegerrequired

The seller this price list belongs to.

namestringrequired

Human-readable label for this price list.

prices_include_taxboolean

Whether prices in this list already include tax.

use_price_comparison_for_vol_discountsboolean

Use price comparison values when computing volume discounts.

contact_group_idsinteger[]

Contact groups this price list applies to. On update, this list is additive (existing group ids are not removed).

taxobject

Show properties

namestring

ratenumber

Tax rate, between 0 and 1.

Responses

201

Price list created

_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

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.onbolder.com/v2/price_lists' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "seller_id": 7,
  "name": "Wholesale EUR",
  "prices_include_tax": false
}'

const response = await fetch("https://api.onbolder.com/v2/price_lists", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"seller_id\": 7,\n  \"name\": \"Wholesale EUR\",\n  \"prices_include_tax\": false\n}"
});

import requests

response = requests.post(
    "https://api.onbolder.com/v2/price_lists",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"seller_id\": 7,\n  \"name\": \"Wholesale EUR\",\n  \"prices_include_tax\": false\n}",
)

Response

{
  "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"
    },
    "products:add_price_item": {
      "href": "https://api.onbolder.com/v2/price_lists/10/items",
      "method": "post"
    }
  }
}