Retrieve Order Discount

Beta

GET/v1/sales/order-discounts/{id}

This endpoint is idempotent. Learn more

Returns an order discount by ID.

Permissions requiredValues:discounts:read

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

idstring

Order discount ID.

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 Retrieve Order Discount

Retrieve Order Discount

import OpenMRP from '@openmrp/sdk';

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

const orderDiscount = await client.sales.orderDiscounts.retrieve('ords_qnbrjvq5ih2q');

console.log(orderDiscount.id);

import OpenMRP from '@openmrp/sdk';

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

const orderDiscount = await client.sales.orderDiscounts.retrieve('ords_qnbrjvq5ih2q');

console.log(orderDiscount.id);

200 example

{
  "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"
}

{
  "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"
}

Retrieve Order Discount

Authorization

Path Parameters

Returns

Responses