ONTRAPORT
Introduction
OfficeAutoPilot is now ONTRAPORT!
ONTRAPORT (a.k.a. OfficeAutoPilot / SendPepper) is a popular, powerful CRM platform that is integrated with UltraCart. ONTRAPORT can retrieve your item information from UltraCart, receive notices about new orders, rebills, and rebill status updates. UltraCart also supports firing their affiliate system conversion pixel on the UltraCart receipt.
Event | Data Direction |
---|---|
Order (Sale) |
|
Affiliate Signup | UltraCart → OntraPort |
Order (Refund) | UltraCart → OntraPort |
Auto Order Status Change | UltraCart → OntraPort |
Fetch Items | UltraCart → OntraPort |
Configuration
The first step in configuring ONTRAPORT within UltraCart is to navigate to:
In the top section of the page you will need to configure your ONTRAPORT account. UltraCart offers two different methods to integrate ONTRAPORT; API method or Partner Tracking Pixel method. The 1st section of the configuration will differ depending on which method is chosen. Choosing the API method will require only a single API key whereas the Partner Tracking Pixel method will require substantially more information. The remaining configuration steps are the same for both methods.
If you're unsure which method to choose, contact ONTRAPORT support to determine which integration will best suit your needs.
API Integration
If you select the API integration method the following screen will be presented.
This will only be displayed to you if you have this integration method selected. The UltraCart Integration Key is obtainable from ONTRAPORT support.
Partner Tracking Pixel
If you are using OfficeAutoPilot's partner system then you will need to configure the conversion pixel on your account. After selecting the Partner Tracking Pixel method, you will see the following configuration screen. The required steps are outlined on this screen. You are basically entering the host name where your conversion pixel lives for each Theme.
As shown in the screen shot above you copy the host name from the conversion URL provided by ONTRAPORT and enter it in the ONTRAPORT Sub-domain field provided for each Theme (It may be "ontraport.ontraport.com". You can verify that with ONTRAPORT).
Product Mapping
The next step, regardless of which integration method you chose, is to complete the ONTRAPORT Product mapping section.
If you don't enter a value here, UltraCart will send your UltraCart Item Id over as the ONTRAPORT Product Name. This is OK if the products are named the same in both systems. Otherwise, enter the OntraPort Product Name for each UltraCart ItemID.
Types of Information Sent to ONTRAPORT
UltraCart sends four types of information to OfficeAuloPilot:
Type | Description |
---|---|
AffiliateId | The numerical identifier of the affiliate within our system. |
Affiliate Approved | Possible values:
|
Sale | Each time an order takes place, UltraCart sends the information to ONTRAPORT |
Refund | Each time a refund takes place, UltraCart sends the information to ONTRAPORT |
Auto Order Status | Auto Order Status - the status of their recurring order. Here are the possible values:
|
ONTRAPORT also can poll for the items configured on an UltraCart account. This allows ONTRAPORT to stay in sync with the items you're selling on your UltraCart store. Each time a transmission takes place the details (including the actual XML messages) appear in the log. See the next section for how to monitor the log.
Monitoring Log
At the bottom of the ONTRAPORT page is a transmission log which looks like the screen shot below.
This log will show you everything that is being requested from or being sent to ONTRAPORT. It's important to monitor this log for errors when you first start integrating the two systems.
If you click on the view button next to each transmission you can see the full details as shown below.
Notice that UltraCart will tell you:
- The type of transmission
- The status of the transmission
- Description of the transmission
- Actual request sent to ONTRAPORT server
- Response c