TransactionAttribute

  • Store sales transactions have several attributes including store and item details, transaction date/time, amount, currency code, conversion action, order ID, and custom value.

  • The transaction_date_time, transaction_amount_micros, currency_code, and conversion_action fields are required for store sales transactions.

  • The transaction_amount_micros must be greater than 1000 and, if item attributes are provided, reflects the total value of items.

  • The item_attribute field is only accessible to customers on an allow-list.

Attribute of the store sales transaction.

Fields

store_attribute

StoreAttribute

Store attributes of the transaction.

item_attribute

ItemAttribute

Item attributes of the transaction. Accessible only to customers on the allow-list.

transaction_date_time

string

Timestamp when transaction occurred. Required. The format is "YYYY-MM-DD HH:MM:SS[+/-HH:MM]", where [+/-HH:MM] is an optional timezone offset from UTC. If the offset is absent, the API will use the account's timezone as default. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30+03:00"

transaction_amount_micros

double

Transaction amount in micros. Required. Transaction amount in micros needs to be greater than 1000. If item Attributes are provided, it represents the total value of the items, after multiplying the unit price per item by the quantity provided in the ItemAttributes.

currency_code

string

Transaction currency code. ISO 4217 three-letter code is used. Required.

conversion_action

string

The resource name of conversion action to report conversions to. Required.

order_id

string

Transaction order id. Useful to group transactions which are part of the same order.

custom_value

string

Value of the custom variable for each transaction. Allowed only if a custom key is provided in the store sales metadata.