List Order Discounts

Beta

GET/v1/sales/order-discounts

This endpoint is idempotent. Learn more

Returns a paginated list of the order discounts defined for the current account, newest first.

Pass q to narrow the list to discounts whose name or code contains the search text.

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.

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 order_discount

Resources in this page.

idstring

Order discount ID.

objectstringenumValues:order_discount

Resource type identifier.

namestring

Display name of the discount.

codestring

The code a buyer enters to apply this discount to an order.

Codes are unique within your account and are matched without regard to letter case.

percentagestring (decimal)

The fraction of the order total taken off, as a decimal string.

This is a multiplier, not a whole percent: 0.1 takes 10% off. Only read when discount_type is percentage.

amountstring (decimal)

The flat amount taken off the order total, as a decimal string.

Only read when discount_type is amount.

discount_typestringenumValues:percentageamount

How the discount is calculated.

percentage: the order total is reduced by the fraction in percentage.
amount: the order total is reduced by the flat amount in amount.

order_countinteger

How many sales orders this discount has been applied to, across all buyers.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Order Discounts

List Order Discounts

import OpenMRP from '@openmrp/sdk';

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

const listOrderDiscount = await client.sales.orderDiscounts.list();

console.log(listOrderDiscount.data);

import OpenMRP from '@openmrp/sdk';

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

const listOrderDiscount = await client.sales.orderDiscounts.list();

console.log(listOrderDiscount.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/order-discounts?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoib3Jkc19xbmJyanZxNWloMnEiLCJkIjoiZiJ9.ZGqFLhop0LvhBmTj3OLoY3Dle84hLQGGZkvQNhC6Nf4",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ords_qnbrjvq5ih2q",
      "object": "order_discount",
      "name": "10% Off",
      "code": "SAVE10",
      "percentage": "10.000000000000000000000000000000",
      "amount": "0.000000000000000000000000000000",
      "discount_type": "percentage",
      "order_count": 5,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/order-discounts?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoib3Jkc19xbmJyanZxNWloMnEiLCJkIjoiZiJ9.ZGqFLhop0LvhBmTj3OLoY3Dle84hLQGGZkvQNhC6Nf4",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ords_qnbrjvq5ih2q",
      "object": "order_discount",
      "name": "10% Off",
      "code": "SAVE10",
      "percentage": "10.000000000000000000000000000000",
      "amount": "0.000000000000000000000000000000",
      "discount_type": "percentage",
      "order_count": 5,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Order Discounts

Authorization

Query Parameters

Returns

Responses