AWIN Conversions API

The AWIN Conversion API app allows you to send purchase events from your ShopWired website directly to AWIN through an . Unlike client-side tracking scripts, which rely on the browser, the Conversion API collects data server-side. This provides more reliable affiliate tracking, especially with the increasing use of ad blockers and privacy-focused browser features.

ShopWired’s AWIN Conversion API app allows you to take advantage of this feature and send purchase event data directly to AWIN’s servers. Event information is sent immediately (once an order is created in your ShopWired account, it is immediately sent to AWIN’s API).

All are exported to AWIN’s Conversion API, irrespective of how the visitor arrived at your website. Orders created through the API or through your ShopWired account are also exported.

To install the app:

Navigate to Apps
Locate the AWIN Conversion API app
Select install this app

Configuring the app

Once you’ve installed the app, navigate to the app configuration page to configure the following details.

API Key

Enter your AWIN Conversions API key (x-api-key).

Advertiser ID

Enter your AWIN advertiser ID, used to identify your account.

Once these details are saved, ShopWired will automatically send order data to AWIN.

Exported orders

When the AWIN Conversion API app successfully exports an order to AWIN, it will appear in the Exported orders section of the app page.

For each successfully exported order, you can view:

Order ref. (the order reference)
Order created (the date/time the order was created)
Customer name
Invoice exported (the date/time the order was exported)
The event JSON (accessible through the view option)
The event JSON displays the exact information that was sent to AWIN’s API by the app
All personally identifiable information (e.g. name, email) that appears in the event JSON is
When viewing the event JSON you’ll only be able to see the hashed data, not the original data (which you can get from the order itself within your ShopWired account)

Export errors

If an order cannot be exported to AWIN’s API successfully, it will appear in the Export errors section of the app page.

For each unsuccessful order, you can view:

Order ref. (the order reference)
Error (the type of error encountered)
Error message (the message returned by AWIN's API)
The event JSON (accessible through the view option)
The event JSON displays the exact information that was sent to AWIN’s API by the app
All personally identifiable information (e.g. name, email) that appears in the event JSON is
When viewing the event JSON you’ll only be able to see the hashed data, not the original data (which you can get from the order itself within your ShopWired account)

If you are able to adjust your account settings to fix the cause of the export error, use the retry option to attempt to export the order again.

The data ShopWired sends about purchases

When a purchase event (a completed order) is created on your ShopWired website, ShopWired sends the following information to AWIN about the order:

ShopWired data	AWIN Conversion API field	Notes
Order reference	`orderReference`
Order total (excluding shipping and tax)	`amount`	Shipping and tax are excluded
Order currency	`currency`	Taken from your ShopWired business settings
Voucher or offer ID	`voucher`	Only if applied
Customer type	`customerAcquisition`	NEW or RETURNING
AWIN click ID	`awc`	Captured from affiliate tracking links
Channel	`channel`	Defaults to `aw` if not available
Order line details	`basket`	Each product includes ID, name, price, quantity, SKU, and category
Commission group total	`commissionGroups`	Defaults to `DEFAULT` group with order total value