Create a volume discount

Creates a new volume discount for a shop. Volume discounts automatically apply tiered pricing when a customer orders above a unit threshold. shop_id is required in the body.

POST/volume_discounts

Authorization

AuthorizationBearer token (JWT) · headerrequired

Request body

requiredapplication/json

shop_idintegerrequired

ID of the shop to create the volume discount in

namestringrequired

discount_typestring

Discount type.

cumulative_modestring

Omit for non-cumulative

Allowed:within_productglobal

apply_on_tier_start_onlyboolean

tiersobject[]required

Show properties

Array of object

frominteger

Units in cart at which this tier starts applying

valueinteger

Discount value for this tier

Responses

201

Volume discount created

_linksHalLinks

idinteger

namestring

discount_typestring

apply_modestring

repeating_tierboolean

tiersobject

Keyed by tier boundary — not an array.

cumulativeboolean

cumulative_modestring

available_forstring

created_atstring<date-time>

updated_atstring<date-time>

422

Validation error

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/volume_discounts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "shop_id": 1,
  "name": "Buy 5+ get 10% off",
  "discount_type": "percentage",
  "tiers": [
    {
      "from": 5,
      "value": 10
    },
    {
      "from": 10,
      "value": 15
    },
    {
      "from": 20,
      "value": 20
    }
  ]
}'

const response = await fetch("https://api.onbolder.com/v2/volume_discounts", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"shop_id\": 1,\n  \"name\": \"Buy 5+ get 10% off\",\n  \"discount_type\": \"percentage\",\n  \"tiers\": [\n    {\n      \"from\": 5,\n      \"value\": 10\n    },\n    {\n      \"from\": 10,\n      \"value\": 15\n    },\n    {\n      \"from\": 20,\n      \"value\": 20\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.onbolder.com/v2/volume_discounts",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"shop_id\": 1,\n  \"name\": \"Buy 5+ get 10% off\",\n  \"discount_type\": \"percentage\",\n  \"tiers\": [\n    {\n      \"from\": 5,\n      \"value\": 10\n    },\n    {\n      \"from\": 10,\n      \"value\": 15\n    },\n    {\n      \"from\": 20,\n      \"value\": 20\n    }\n  ]\n}",
)

Response

{
  "id": 30,
  "name": "Buy 5+ get 10% off",
  "discount_type": "percentage",
  "tiers": {
    "5": 10,
    "10": 15,
    "20": 20
  },
  "_links": {
    "self": {
      "href": "https://api.onbolder.com/v2/volume_discounts/30"
    }
  }
}