Recommended API Flow

Please follow these directions if you are not using the CheckoutChamp website builder.

Full API Documentation: https://apidocs.checkoutchamp.com/?version=latest

It is not necessary to use every page listed below. However, the pages that you do use should contain the API calls listed within that section to give you the most data within your CheckoutChamp instance.

Presell Page

1. Call Import Click

• pageType=presellPage

• userAgent=User Agent Header, used for reporting on browser and device type

• requestUri=The URL that the user requested when they landed on the page (Ex. https://mylander.com/nutra/?affId=AF54B33412&c1=fb&c2=5000234)

  • use affId to grant affiliate credit

  • Url encode this value to prevent breakage from passing the ampersand

• httpReferer (optional, for use with UTM filters) = The URL of the previous webpage from which a link to the currently requested page was followed.

  • may be the same value as requestUri. httpReferer must include the UTM code(s)

Lead Page

1. Call Import Click - pageType=leadPage - send sessionId returned from first Import Click call if not first call*

2. Call Import Lead - partial can be created as soon as you have firstName, lastName, emailAddress or phoneNumber (campaignId and API credentials will also need to be sent) - Send sessionId parameter returned from Import Click to link order to session You can continually call Import Lead as the customer fills their information into your forms - send orderId parameter returned from the first Import Lead call

Checkout Page

1. Call Import Click - pageType=checkoutPage - send sessionId returned from first Import Click call if not first call*

• Use fraudPixel=1 if using option 1 for the Device Data Collector Pixel (Fraud Manager and Kount)

2. You can call Import Lead again if updating/expanding partial information

3. Call Import Order - send orderId parameter if already exists and sessionId

• Call Confirm PayPal - Only use if paySource=PAYPAL on Import Order - Please view our PayPal documentation for full instructions

Upsell Pages 1+

1. Call Import Click - pageType=upsellPage1-4 - send sessionId returned from first Import Click call

2. Call Import Upsale - include orderId and sessionId

Repeat each step for each upsell page

Thank you Page

Either:

Call Import Click - pageType=thankyouPage - send sessionId returned from first Import Click call

Or:

Call Confirm Order (optional) to send Order Confirmation Email Immediately

---

Flowchart

Click the PDF below for an interactive flowchart to aid in explaining which API Calls should be made on each page of your funnel.

69KB

CC Recommended API Flow.pdf

pdf

---

API Descriptions

Import Click - https://api.checkoutchamp.com/landers/clicks/import/

The CheckoutChamp Import Click API allows you to track visits to your landing pages in the CRM Reporting.

On the first Import Click call you must pass requestUri (the full url of the current page). Upon a successful call, the API will return a sessionId. This sessionId must be sent on subsequent API calls in that session to tie the click to the partial order or complete order that is placed.

---

Import Lead - https://api.checkoutchamp.com/leads/import/

The CheckoutChamp Import Lead API allows you to add new leads to the CRM.

---

Import Order - https://api.checkoutchamp.com/order/import/

The CheckoutChamp Import Order API allows you to create new orders.

---

Confirm Paypal - https://api.checkoutchamp.com/transactions/confirmPaypal

The Confirm Paypal API allows you to complete orders on your pages using the Paypal Express Checkout button.

---

Import Upsale - https://api.checkoutchamp.com/upsale/import/

The CheckoutChamp Import Upsale API allows you to add one-click upsales to existing orders.

---

Confirm Order - https://api.checkoutchamp.com/order/confirm/

The CheckoutChamp Confirm Order API will immediately send confirmation auto responder emails to the customer.

---