Sign in
Settings

Get company loyalty settings

Retrieves your company's current loyalty program configuration, including discount policy, membership tier structure, referral reward rates, and operational limits.

When to use: Call this endpoint when initializing your application or periodically (e.g., daily) to cache current settings. Settings rarely change but affect all transaction calculations.

Marketing settings can be configured in UDS Admin.

get/settings

Headers

X-Origin-Request-Idstring required

Request identifier (UUID).

X-Timestampstring date-time required

Timestamp in ISO8601 date format.

Response

Settings

idinteger required

Company ID.

namestring required

Company name.

promoCodestring required

Company invitation promo code. Customers can use this code to join your loyalty program.

currencystring nullable required

ISO-4217

baseDiscountPolicy'APPLY_DISCOUNT' | 'CHARGE_SCORES' required

Defines loyalty program type:

  • APPLY_DISCOUNT — apply a discount to an order;

  • CHARGE_SCORES base discount won't apply but customer will receive points award with the same base discount rate applied to cash part of purchase operation.

purchaseByPhoneboolean required

Permission to make purchases by phone number.

usePointsByPhoneboolean required

Permission to spend points purchases by phone number.

writeInvoiceboolean required

Necessity to indicate a bill number when performing transactions through UDS Cashier.

slugstring required

Company slug for web page.

Changes