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

Object

Admin / POS

gift_card

A shop gift card balance.

Issued on POS or online; redeemed as GIFT_CARD tender on orders.

Exposure

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

What

The gift_card 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

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

id

string

Gift card id.

Type
id: string

code

string

Shop-scoped card code (unique).

Type
code: string

initialBalance

number

Balance when the card was issued.

Type
initialBalance: number

balance

number

Current remaining balance.

Type
balance: number

currency

string

ISO currency code.

Type
currency: string

channel

string

Issuing channel: "pos" or "online".

Type
channel: string

customerId

string | null

Optional customer who owns the card.

Type
customerId: string | null

note

string | null

Staff note.

Type
note: string | null

expiresAt

string | null

Expiry timestamp when set.

Type
expiresAt: string | null

disabledAt

string | null

Set when the card is disabled.

Type
disabledAt: string | null

createdAt

string

ISO-8601 created timestamp.

Type
createdAt: string

updatedAt

string

ISO-8601 updated timestamp.

Type
updatedAt: string

Related