List Volume Discounts

Beta

GET/v1/sales/volume-discounts

This endpoint is idempotent. Learn more

Returns a paginated list of volume discounts, newest first.

The search term matches the discount name, the name of a customer group it is scoped to, or the name of a product line it is scoped to. Customer portal users see only discounts with no customer-group restriction plus those scoped to a group their own account belongs to.

Permissions requiredValues:discounts:readcustomers:readsuppliers:read

The role behind your API key or agent must grant every one of these permissions.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

include[]optional arrayenumValues:customer_groupsproduct_linescategories

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of volume_discount

Resources in this page.

idstring

Volume discount ID.

objectstringenumValues:volume_discount

Resource type identifier.

namestring

Display name of the volume discount.

Must be unique within the account.

tierslistnullable

Quantity tiers that define the discount.

Every tier whose threshold the ordered quantity reaches is applied, and their reductions compound. A discount with no tiers never changes a price.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of volume_discount_tier

Resources in this page.

idstring

Volume discount tier ID.

objectstringenumValues:volume_discount_tier

Resource type identifier.

namestring

Display name of the tier.

discount_percentagestring (decimal)

Fraction of the price taken off once the threshold is met, as a decimal string.

This is a multiplier, not a whole percent: 0.05 takes 5% off. When an order meets several tiers of the same discount, their reductions compound: meeting a 0.1 tier and a 0.2 tier multiplies the price by 0.9 × 0.8, a 28% reduction overall.

thresholdstring (decimal)

Minimum ordered quantity at which this tier's discount begins to apply, as a decimal string.

The quantity compared against the threshold is the total across every line on the order that falls within the discount's scope, converted into one of the discount's acceptable units — not the quantity of a single line.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

customer_groupslistExpandablenullable

Customer groups this discount is scoped to.

When set, only customers belonging to at least one of these groups qualify; when empty, all customers qualify. A customer belongs to a group either by being assigned to it directly or through the price groups on their customer relationship.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of account_group

Resources in this page.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
type_group: used to categorize accounts, such as "Consumers" or "Distributors".

A group's type is fixed when it is created and cannot be changed afterwards.

namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

commission_applied: sales commission is calculated on orders from accounts in this group.
commission_exempt: orders from accounts in this group are exempt from commission.

freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

free_freight: customers within this group will not have to pay for freight.
billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

product_lineslistExpandablenullable

Product lines this discount is scoped to.

When set, only items in one of these product lines qualify; when empty, all product lines qualify.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of product_line

Resources in this page.

idstring

Product line ID.

objectstringenumValues:product_line

Resource type identifier.

namestring

Display name of the product line.

Unique among the product lines visible to your account, which includes the shared system lines.

descriptionstringnullable

Free-form description of the product line.

notesstringnullable

Free-form notes about the product line.

commission_policystringenumValues:commission_appliedcommission_exempt

Default commission policy for products in this product line.

commission_exempt: no commission applies to these products.
commission_applied: commission applies to these products, unless overridden elsewhere.

freight_policystringenumValues:free_freightbilled_freight

Default freight policy for products in this product line.

free_freight: these products do not incur a freight charge.
billed_freight: freight is billed for these products, unless overridden elsewhere.

ownerownernullable

Owner of the product line.

System-owned product lines are platform-provided and shared across all accounts; account-owned product lines are custom to your account. Only account-owned product lines can be updated, deleted, or granted to customers and account groups.

Always returned as null in this endpoint.

unit_groupunit_groupnullable

Unit group associated with this product line.

The unit group determines the set of units available to products in this product line.

Always returned as null in this endpoint.

default_lotquantitynullable

The lot products in this line are made in — a doff, a pallet.

Sizes the campaigns a production schedule plans, and defaults the quantity when a batch is added to a production run. The unit is part of the value — 60 counted in pairs and 60 counted in eaches are different lots — and is drawn from this product line's unit group.

An item's own lot override still takes precedence over the line's. When the line has no lot convention, planning falls back to the lot of the line the item feeds into, and then to the account-wide default lot size.

Always returned as null in this endpoint.

fulfillment_policystringnullableenumValues:make_to_stockmake_to_order

How products in this line are produced when they do not say for themselves.

make_to_stock: built to the forecast, holding a safety stock against its variability.
make_to_order: built only against orders already on the book, holding no buffer.

Null falls through to the account default.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

categorieslistExpandablenullable

Item categories this discount is scoped to.

When set, only items in one of these categories qualify; when empty, all categories qualify.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of item_category

Resources in this page.

idstring

Item category ID.

objectstringenumValues:item_category

Resource type identifier.

namestring

Display name of the item category.

notesstringnullable

Free-form notes about the item category.

typestringenumValues:material_categoryproduct_category

What kind of items this category groups.

material_category: groups raw materials and components (items of type material).
product_category: groups finished products and parts (items of type product or part).

An item can only be assigned to a category whose type matches the item's type, and the category's type is fixed at creation.

ownerownernullable

Provenance of the item category.

System-owned categories are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned categories are custom to your account.

Always returned as null in this endpoint.

propertieslistnullable

Properties associated with this item category, such as Color or Size.

These describe the dimensions along which items in the category vary, and are also what the customer-facing catalog shows for the category. Attach and detach them with the Add Item Category Property and Remove Item Category Property endpoints.

Always returned as null in this endpoint.

unit_groupunit_groupnullable

Unit group associated with this item category.

Items in this category are measured in units belonging to this group, and can only be ordered in those units unless the item's product line defines its own unit group, which takes precedence.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

attributeslistExpandablenullable

Attributes this discount is scoped to.

When set, an item qualifies only if it has every listed attribute; when empty, attributes are not considered.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of attribute

Resources in this page.

idstring

Attribute ID.

objectstringenumValues:attribute

Resource type identifier.

valuestring

The selectable value this attribute represents, such as Red for a Color property or Large for a Size property.

colorstringenumValues:bluebrowndefault

Swatch color used to display this attribute in the UI.

The named colors are arbitrary display choices; default is a neutral fallback used when no specific swatch applies.

sort_orderinteger

Position of this attribute relative to its siblings within the property, starting at 1.

Positions are kept contiguous: creating, reordering, or deleting an attribute automatically shifts its siblings.

propertypropertynullable

The property this attribute belongs to.

Populated only when the attribute is returned under an item's or a volume discount's attributes list.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

acceptable_unitslistExpandablenullable

Units that ordered quantities are measured in when evaluating tier thresholds.

Quantities ordered in other units are converted to an acceptable unit before being compared against tier thresholds; a quantity that cannot be converted contributes nothing. A discount with no acceptable units always evaluates to a quantity of zero, so it never reaches a threshold above zero.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of unit

Resources in this page.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

The dimension this unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

A quantity is converted with value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator), so a kilogram in a gram-based dimension has a numerator of 1000 and a denominator of 1.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Volume Discounts

List Volume Discounts

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listVolumeDiscount = await client.sales.volumeDiscounts.list();

console.log(listVolumeDiscount.data);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listVolumeDiscount = await client.sales.volumeDiscounts.list();

console.log(listVolumeDiscount.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/volume-discounts?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoicXVkc19ibjdodG85czEwcHAiLCJkIjoiZiJ9.9gVH-hpNrreXWaN6vvI2wqlEd65wWue08QQU-wwhC84",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "quds_bn7hto9s10pp",
      "object": "volume_discount",
      "name": "Bulk Order Discount",
      "tiers": {
        "object": "list",
        "page_info": {
          "next_page_url": null,
          "previous_page_url": null,
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": [
          {
            "id": "qudstr_iylnkrlr3uhm",
            "object": "volume_discount_tier",
            "name": "100+ Units",
            "discount_percentage": "5.000000000000000000000000000000",
            "threshold": "100.000000000000000000000000000000",
            "created_at": "2026-05-10T00:00:00Z",
            "updated_at": "2026-05-10T00:23:00Z"
          }
        ]
      },
      "customer_groups": null,
      "product_lines": null,
      "categories": null,
      "attributes": null,
      "acceptable_units": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/volume-discounts?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoicXVkc19ibjdodG85czEwcHAiLCJkIjoiZiJ9.9gVH-hpNrreXWaN6vvI2wqlEd65wWue08QQU-wwhC84",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "quds_bn7hto9s10pp",
      "object": "volume_discount",
      "name": "Bulk Order Discount",
      "tiers": {
        "object": "list",
        "page_info": {
          "next_page_url": null,
          "previous_page_url": null,
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": [
          {
            "id": "qudstr_iylnkrlr3uhm",
            "object": "volume_discount_tier",
            "name": "100+ Units",
            "discount_percentage": "5.000000000000000000000000000000",
            "threshold": "100.000000000000000000000000000000",
            "created_at": "2026-05-10T00:00:00Z",
            "updated_at": "2026-05-10T00:23:00Z"
          }
        ]
      },
      "customer_groups": null,
      "product_lines": null,
      "categories": null,
      "attributes": null,
      "acceptable_units": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Volume Discounts

Authorization

Query Parameters

Returns

Responses