Interface DonationAlertsSendMerchandiseSaleAlertData

Data structure for sending a merchandise sale alert.

interface DonationAlertsSendMerchandiseSaleAlertData {
    amount: number;
    boughtAmount?: number;
    currency: string;
    externalId: string;
    merchandiseIdentifier: string;
    merchantIdentifier: string;
    message?: string;
    username?: string;
}

Properties

amount: number

The total value of the sale.

boughtAmount?: number

Number of items purchased. Defaults to 1.

currency: string

ISO 4217 currency code corresponding to the amount.

externalId: string

A unique developer-generated ID for the sale (maximum length: 32 characters).

merchandiseIdentifier: string

The ID of the merchandise item sold.

merchantIdentifier: string

Merchant's ID on DonationAlerts.

message?: string

A message from the customer related to their purchase.

username?: string

The customer's name.