Documentation & Setup Guide

Get your CJ (Commission Junction) tracking up and running in 5 simple steps. This guide will walk you through the complete setup process.

Estimated Time: 10-15 minutes

Click Tracking Data

When a customer clicks an affiliate link, the following data is captured and stored:

Order Tracking Data

When a customer completes a purchase, the following order data is synced to CJ:

Tracking Flow

Here's the complete flow of how CJ tracking works in this app:

https://yourstore.com/products/item?cjevent=abc123&cjdata=xyz789

Internal APIs

The app uses the following API endpoints:

POST /api/save-click

Saves CJ click tracking data when a customer visits via an affiliate link.

Request Body:

{
  "storeHash": "string",
  "channelId": "number",
  "siteId": "number",
  "cjevent": "string",
  "cjdata": "string",
  "sessionId": "string",
  "userAgent": "string"
}

POST /api/sync-order

Syncs order data to CJ when a customer completes a purchase.

Request Body:

{
  "storeHash": "string",
  "channelId": "number",
  "siteId": "number",
  "orderId": "string",
  "cjevent": "string",
  "cjdata": "string"
}

GET /api/orders

Retrieves paginated list of orders with filtering and sorting.

GET /api/logs

Retrieves paginated list of API call logs with filtering and sorting.

GET /api/storefronts/[storefrontId]/config

Gets or updates storefront configuration (CJ credentials, settings).

POST /api/storefronts/[storefrontId]/script

Installs or uninstalls the tracking script in BigCommerce.

Common Issues

Script Not Installing

• Verify your BigCommerce API credentials are correct
• Check that you have the necessary permissions (Scripts API access)
• Ensure your storefront (channel/site) is correctly configured
• Check the browser console and Logs page for error messages

Orders Not Syncing to CJ

• Verify CJ credentials are correct in Settings (Enterprise ID, Advertiser ID, Action Tracker ID, API Token)
• Check that you're in the correct mode (Test vs Live)
• Ensure CJ parameters (cjevent, cjdata) are present in cookies before checkout
• Check the Logs page for CJ API errors
• Verify order status in Orders page - failed orders will show error details

Duplicate Orders

• The app prevents duplicates by checking for existing orders with the same store ID and order ID
• CJ cookies are automatically cleared after successful order sync
• If you see duplicates, check the Orders page for order status and attempt count

Missing CJ Parameters

• Ensure affiliate links include cjevent and/or cjdata parameters
• Check browser console for [CJ Tracker] log messages
• Verify cookies are being set (check browser DevTools → Application → Cookies)
• Ensure cookies haven't expired (30-day expiration)

Q: Do I need to modify my storefront code?

A: No! The tracking script is automatically injected into your BigCommerce storefront via the BigCommerce Scripts API. No code changes are required.

Q: What happens if a customer clears their cookies?

A: If cookies are cleared before checkout, the order will still be created in your database, but it won't be synced to CJ (since CJ parameters are required). The order will show as pending status.

Q: Can I test without real affiliate links?

A: Yes! You can manually add CJ parameters to any URL:

https://yourstore.com/?cjevent=test123&cjdata=test456

Q: How long are CJ parameters stored?

A: CJ parameters are stored in cookies for 30 days. After a successful order sync, they are automatically cleared to prevent duplicate submissions.

Q: What's the difference between Test and Live mode?

A: Test mode posts to CJ's sandbox environment (tracking.api.cj.com/graphqltest), while Live mode posts to production (tracking.api.cj.com/graphql). Always test in Test mode first!

Q: What if an order fails to sync to CJ?

A: Failed orders are stored in the OutboxJob queue for retry. You can view failed orders in the Orders page and manually retry them (retry functionality coming soon).

Q: Can I use this with multiple storefronts?

A: Yes! Each storefront can have its own CJ configuration. Use the storefront selector in the header to switch between storefronts.

Need additional help? Here are some resources:

• View Logs: Check API calls and errors in real-time
• View Orders: Monitor order sync status and troubleshoot issues
• Settings: Review and update your CJ configuration

For technical support or questions, please contact your development team or refer to the CJ Affiliate API documentation.