Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Order

The order information for the transaction being sent to the web service.

Hierarchy

  • Order

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Optional affiliateId

affiliateId: undefined | string

The ID of the affiliate where the order is coming from.

Optional amount

amount: undefined | number

The total order amount for the transaction.

Optional currency

currency: undefined | string

The ISO 4217 currency code for the currency used in the transaction.

Optional discountCode

discountCode: undefined | string

The discount code applied to the transaction. If multiple discount codes were used, please separate them with a comma.

Optional hasGiftMessage

hasGiftMessage: undefined | false | true

Whether the purchaser included a gift message.

Optional isGift

isGift: undefined | false | true

Whether order was marked as a gift by the purchaser.

Optional referrerUri

referrerUri: URL

The URI of the referring site for this order.

Optional subaffiliateId

subaffiliateId: undefined | string

The ID of the sub-affiliate where the order is coming from.

Generated using TypeDoc