StoreSalesMetadata

  • StoreSalesDirect includes metadata for third-party store sales uploads.

  • loyalty_fraction and transaction_upload_fraction are required fields that represent fractions related to identifiable and uploaded transactions, respectively.

  • custom_key is an optional field for a predefined variable key used for custom segmentation in reporting, available to allowed customers.

Metadata for Store Sales Direct.

Fields

third_party_metadata

StoreSalesThirdPartyMetadata

Metadata for a third party Store Sales upload.

loyalty_fraction

double

This is the fraction of all transactions that are identifiable (for example, associated with any form of customer information). Required. The fraction needs to be between 0 and 1 (excluding 0).

transaction_upload_fraction

double

This is the ratio of sales being uploaded compared to the overall sales that can be associated with a customer. Required. The fraction needs to be between 0 and 1 (excluding 0). For example, if you upload half the sales that you are able to associate with a customer, this would be 0.5.

custom_key

string

Name of the store sales custom variable key. A predefined key that can be applied to the transaction and then later used for custom segmentation in reporting. Accessible only to customers on the allow-list.