This article describes the architecture and steps to install the SocialLadder attribution mechanism for code based conversion attribution using SocialLadder's APIs. This article is technical in nature and will require a trained developer in order to be integrated into your platform.
In many implementations, conversions can be tracked through a simple Tracking Pixel that can be installed on your site and will fire directly on the purchasers browser. In some scenarios the Tracking Pixel will not meet your specific needs. Please work with your Account Manager to determine the most efficient implementation that fits your needs.
In this installation, conversions from your platform will be sent into the Post Conversion end point. You can find details about this endpoint on our API documentation page here. This endpoint enables your platform to send details about each conversion into SocialLadder so that the correct ambassador can get credit for this conversion.
The API in the URL can be seen in the below screenshot:
In order to use the API, you will need to receive an API Key from your Account Manager or Implementation Specialist to ensure you have access to the APIs for your account.
On the API documentation page, you can see an example payload for this endpoint. You will need to generate the payload within your platform replacing the fields below with the actual data for this conversion.
IMPORTANT: do not add or remove fields from the payload. If a field does not apply to your specific integration, set the default value for this field as specified below or ask your Implementation Specialist what you should send in for this field.
TransId: This is the order or conversion ID. This field is required and is any value that uniquely identifies this conversion from others. This value is used to prevent duplicates if the same TransId is sent in more than one, it will only be attributed the first time.
ShopCode: This value tells us which connector in SocialLadder this conversion is for. This will be provided by your Account Manager or your Implementation Specialist once they get your connector configured.
PromoCode: This is the ambassador code that was used for this conversion. This code will be used to identify which ambassador gets credit for this conversion.
EmailAddress: This is the email address of the purchaser. This field is optional.
TransAmount: This is the total price of the conversion. If the conversion does not have an amount, send 0 into this field.
TransUnits: This is the number of units on this conversion. For example, on a purchase, if there were 5 line items, then you would send 5 into this value. If your conversion does not have multiple units, send 1 into this field.
OverridePointValue: This is an optional field that can be used to specify the amount of credit that an ambassador is given for this purchase. If this field is used, the default credit will not be given and instead the ambassador will receive the amount of points or currency specified in this field instead.
IMPORTANT NOTE: This field is used for both points and currency compensation. The type of compensation cannot be specified through this API, this is defined by the default configuration for this connector. For example, if the value sent into this field is 100, and the default compensation configured in SocialLadder is to give 50 points per sale, then the ambassador will receive 100 points for this conversion. If the default compensation is configured to give $10, then the ambassador will receive $100 for this conversion.
Action: This values should always be set to 'Sale'
UDF fields: These are User Defined Fields. These fields can be used to track custom meta data about conversion. You can send any additional details you want to track into these fields and they will be tracked along with these conversion and be available on reporting. These values are not used for any functional purposes inside of SocialLadder. If these fields are not used, simply send in a blank value for each of them.
SaleDate: This is the date and time of the conversion.