Skip to main content
OptionalIdentifiers

Object schema for Klar APi. While those attributes are optional, they are very useful in linking up the order data with your marketing data.

Frank Birzle avatar
Written by Frank Birzle
Updated over 6 months ago

googleAnalyticsTransactionId

Type: string

Description: The transaction ID provided by Google Analytics for the given transaction.

Example Value(s): '4234823904892038490238904234'

orderSourceName

Type: string

Description: A title describing the order source.

Example Value(s): 'webshop' or 'b2b' or 'pos'

orderChannelName

Type: string

Description: The channel the purchase has been attributed to.

Example Value(s): 'influencer' or 'direct'

orderPlatformName

Type: string

Description: The platform the customer purchased the order.

Example Value(s): 'amazon' or 'ebay'

utmSource

Type: string

Description: The utmSource for the order.

Example Value(s): 'influencer' or 'instagram'

utmMedium

Type: string

Description: The utmMedium for the order.

Example Value(s): 'organic' or 'referral'

utmCampaign

Type: string

Description: The utmCampaign for the order.

Example Value(s): 'valentinesday' or 'DE | Brand | Awesome Foods Spring `22'

utmTerm

Type: string

Description: The utmTerm for the order.

Example Value(s): 'food' or 'non-food'

utmContent

Type: string

Description: The utmContent for the order.

landingPage

Type: string

Description: Landing page the order was initiated from.

Example Value(s): 'https://www.mystore.com/folder/subpage.html' or https://www.mystore.com/?initiator=xyz123

isSubscriptionOrder

Type: boolean

Description: Boolean value indicating is the order was part of a subscription.

Example Value(s): true or false

isFirstSubscriptionOrder

Type: boolean

Description: Boolean value indicating is the order was part of a subscription.

Example Value(s): true or false

Did this answer your question?