Skip to main content

Promotions - export fields

Promotions

Field

Description

Data type

Example value

promotionId

The unique ID for the promotion template

GUID

33E4499D-1259-48F9-8E0D-A6B001157EC5

promotionName

Given name of the promotion

string

20% discount on purchase - Welcome offer

promotionType

Type of the promotion

string

LoyaltyBar, Code, MobileSwipe, Bonuscheck

externalId

The external promotion ID, set by API only.

string

ABC123

validFromDateTime

Valid from

datetime

2020-06-30T09:00:00+01:00

validToDate

Valid to

datetime

2020-07-30T00:00:00+01:00

externalPromotionCode

If type is Bonuscheck then it will be populated with the bonuscheck number.

string

24587495

createdOn

When the promotion template was created

datetime

2020-05-30T00:00:00+01:00

changedOn

When the promotion was last changed

datetime

2020-07-29T10:00:00+01:00

deletedOn

When the promotion was deleted

datetime

2020-07-30T00:00:00+01:00

PromotionRecipient

Field

Description

Data type

Example value

promotionRecipientId

The unique ID for each promotion assignment

GUID

66E4499D-1259-48F9-8E0D-A6B001157EC5

promotionId

The unique ID for the promotion template

GUID

33E4499D-1259-48F9-8E0D-A6B001157EC5

contactId

The unique contact ID

GUID

99E4499D-3459-48F9-8E0D-A6B001157ED7

isUsed

Whether the promotion has been used or not

boolean

false

usedInStoreId

In which store the promotion was used

string

1001

UsageDateTime

When the promotion was used

datetime

2020-07-29T12:00:00+01:00

validFromDateTime

When the promotion is valid from

datetime

2020-05-30T00:00:00+01:00

validToDateTime

When the promotion is valid until

datetime

2020-07-29T10:00:00+01:00

createdOnDateTime

When the promotion was created

datetime

2020-07-30T00:00:00+01:00

receiptExternalId

The unique external ID for the receipt

string

4646f3ef-732a-4bae-a352-ae8ae843e003

value

Value on promotion

decimal

73.0000

valueType

Type of value

String

EXTERNALOFFER, PERCENT, MONEY

changeType

Type of change

String

CREATE, DELETE