RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Admin / POS

discount

A shop discount / promo rule.

Amount off products/order, BXGY, free shipping. Applied at POS and checkout when codes/rules match.

Exposure

Used in Admin, POS, or Storefront. Not exposed on Merchant API v1 routes yet.

What

The discount object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

14 fields on discount. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Discount id.

Type
id: string

name

string

Merchant-facing name.

Type
name: string

code

string | null

Optional discount code customers enter.

Type
code: string | null

type

DiscountType

Discount rule kind.

Type
type: PERCENTAGE | FIXED_AMOUNT | FREE_SHIPPING | BUY_X_GET_Y

value

number

Percent or fixed amount depending on type.

Type
value: number

minAmount

number | null

Minimum purchase amount when required.

Type
minAmount: number | null

maxUses

number | null

Global usage cap.

Type
maxUses: number | null

usedCount

number

Times the discount has been used.

Type
usedCount: number

startsAt

string | null

Start of validity window.

Type
startsAt: string | null

endsAt

string | null

End of validity window.

Type
endsAt: string | null

isActive

boolean

Whether the discount is active.

Type
isActive: boolean

appliesTo

string | null

ORDER or PRODUCTS for amount-off rules.

Type
appliesTo: string | null

createdAt

string

ISO-8601 created timestamp.

Type
createdAt: string

updatedAt

string

ISO-8601 updated timestamp.

Type
updatedAt: string

Related