Schemas

This page documents all the data schemas used in the Arctic Tern Headless API.

Category

A store category.

Properties:

Field	Type	Description
id	string	Unique identifier for the category
name	string	Name of the category
created_at	datetime	When the category was created
updated_at	datetime	When the category was last updated

Example:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "example name",
  "created_at": "2024-01-01T12:00:00Z",
  "updated_at": "2024-01-01T12:00:00Z"
}

Enrolment

An enrolment record.

Properties:

Field	Type	Description
id	string	Any unique non-empty string value

Example:

{
  "id": "id-123"
}

Event

An event representing a user action.

Properties:

Field	Type	Description
event_group_id	string	Unique identifier for the event group (click UUID)
created_at	datetime	When the event was created
type	string	Type of event
url	string	The redirect URL for this event

Example:

{
  "event_group_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-01-01T12:00:00Z",
  "type": "example type",
  "url": "example url"
}

Image

An image file variant.

Properties:

Field	Type	Description
url	string	URL of the image file
density	integer	Pixel density multiplier
width	integer	Image width in pixels
height	integer	Image height in pixels

Example:

{
  "url": "example url",
  "density": 42,
  "width": 42,
  "height": 42
}

Offer

An offer for cashback at a store.

Properties:

Field	Type	Description
id	string	Unique identifier for the offer
start_datetime	datetime	When the offer starts
end_datetime	string	When the offer ends (null if no end date)
tiers	array	Cashback tiers for this offer
name	string	Store name
title	string	Store title (or name if title is not set)
hero_image	array	Hero image variants
terms	string	Terms and conditions (HTML)
dos	string	Things to do when shopping at this store (HTML)
donts	string	Things to avoid when shopping at this store (HTML)
description	string	Store description (HTML)
callout	string	Callout text (HTML)
logo	array	Store logo variants
categories	array	Store categories (primary category first, then secondary categories ordered by store_category_mappings.order)

Example:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "start_datetime": "2024-01-01T12:00:00Z",
  "end_datetime": "2024-01-01T12:00:00Z",
  "tiers": [],
  "name": "example name",
  "title": "example title",
  "hero_image": [],
  "terms": "example terms",
  "dos": "example dos",
  "donts": "example donts",
  "description": "example description",
  "callout": "example callout",
  "logo": [],
  "categories": []
}

OfferTier

A cashback tier for an offer.

Properties:

Field	Type	Description
name	string	Name of the tier
cashback	string	Formatted cashback amount or percentage

Example:

{
  "name": "example name",
  "cashback": "example cashback"
}

Reward

A reward (payment) record.

Properties:

Field	Type	Description
reward_id	string	Unique identifier for the reward
amount	number	string
status	Status	Current status of the reward
created_at	datetime	When the reward was created
updated_at	datetime	When the reward was last updated
currency_code	string	Three-letter currency code
sent_datetime	string	When the reward was sent to the enrolled user

Example:

{
  "reward_id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 3.14,
  "status": "PENDING",
  "created_at": "2024-01-01T12:00:00Z",
  "updated_at": "2024-01-01T12:00:00Z",
  "currency_code": "example currency_code",
  "sent_datetime": "2024-01-01T12:00:00Z"
}