Layout-API

PurchaseResponse

array
itemsarray[object]
Show Child Parameters
pointsnumber

Cumulus points obtained for this purchase.

Example:48

storeIDstring

ID of the store. Filial-ID

Example:0036713

storeNamestring

Name of the store

Example:D + G Wynecenter

timestampstring

Human readable time stamp of purchase in local time zone

Example:30.03.2013 10:15:48

totalCHFnumber

Total amount of the receipt in CHF (might be different from the sum of items.)

Example:24

trxIDstring

Transaction ID of receipt

Example:20220124_174650_0045160_046_203

ReceiptHeadShort

object
cumulusPunktenumberrequired

Rewarded Cumulus points.

Example:319.7

hasDetailnumberrequired

0: This is a syntetic pseudo-transaction that just list Partner- or Mitarbeiter-Punkte. Trying to retrieve details will fail always in this case.

1: Actual receipt available via detail/{cumulus}/{transactionId}.

Example:1

storeidstringrequired

Filial-ID

Example:0090390

storenamestringrequired

Filialname

Example:M Wittenbach

totalnumberrequired

Total purchase value in CHF.

Example:159.85

transactionIdstringrequired

ID to retrieve actual receipt if hasDetail==1 If hasDetail = 0 this ID is just a dummy and cannot be used to retrieve the (non-existing) details.

Note: if hasDetail = 0 the transactionId might be empty (i.e. “”).

Example:20220611_092739_0090390_003_9

trxDatestringrequired

Date of purchase in the form YYYYMMDD.

Example:20220611

trxTimestringrequired

Time of purchase (local time of store) in the form hhmmss.

Example:092739

versionstringrequired

Kept for backwards compatibility. You are not supposed to use or interpret this field.

Example

ReceiptListResponse

array
cumulusPunktenumberrequired

Rewarded Cumulus points.

Example:319.7

hasDetailnumberrequired

0: This is a syntetic pseudo-transaction that just list Partner- or Mitarbeiter-Punkte. Trying to retrieve details will fail always in this case.

1: Actual receipt available via detail/{cumulus}/{transactionId}.

Example:1

storeidstringrequired

Filial-ID

Example:0090390

storenamestringrequired

Filialname

Example:M Wittenbach

totalnumberrequired

Total purchase value in CHF.

Example:159.85

transactionIdstringrequired

ID to retrieve actual receipt if hasDetail==1 If hasDetail = 0 this ID is just a dummy and cannot be used to retrieve the (non-existing) details.

Note: if hasDetail = 0 the transactionId might be empty (i.e. “”).

Example:20220611_092739_0090390_003_9

trxDatestringrequired

Date of purchase in the form YYYYMMDD.

Example:20220611

trxTimestringrequired

Time of purchase (local time of store) in the form hhmmss.

Example:092739

versionstringrequired

Kept for backwards compatibility. You are not supposed to use or interpret this field.

SummaryResponse

object
balancePointsnumber

Example:138

payoutCumulusBonsCHFnumber

Example:10

totalAmountCHFnumber

Example:349.26

totalPointsnumber

Example:963

Example

TransactionIdsModel

object
transactionIdsarray[string]required
Example