/
AWeber API

AWeber API

AWeber API

Overview

UltraCart integrates with AWeber via the AWeber REST API. When a customer completes a purchase, UltraCart submits a subscriber record to the configured AWeber list, including order and contact data mapped to AWeber custom fields. This guide covers authentication, subscription configuration, and custom field setup required for a complete integration.

Prerequisites

  • An active AWeber account with at least one list configured.

  • UltraCart merchant account with marketing features enabled.

  • Custom fields created in AWeber that match the field names UltraCart sends. See [Custom Fields](#custom-fields) for the required names.

Authentication

The first step is to navigate to:

Main Menu → Operations → Marketing → 3rd Party Email → AWeber

Now click on the connect button as shown below. Click Connect button.

You will be redirected to an AWeber-hosted authorization page.

Enter your AWeber username and password and click **Allow Access**. AWeber validates your credentials and redirects you back to UltraCart with a connection confirmation. Click **Continue** to proceed to list configuration. > **Note:** UltraCart uses OAuth to obtain a persistent access token. You do not need to > re-authenticate unless you revoke access from within AWeber.

AWeber validates your credentials and redirects you back to UltraCart with a connection confirmation. Click **Continue** to proceed to list configuration.

Note: UltraCart uses OAuth to obtain a persistent access token. You do not need to re-authenticate unless you revoke access from within AWeber.

After you click continue you'll be able to configure your global list subscription.

Global List Subscription

A global subscription subscribes every customer to a designated AWeber list regardless of which items were purchased. This is the simplest configuration. After authenticating, UltraCart displays all AWeber lists available in your account. Select one or more lists and click Save.

Item Based List Subscription

Item-based subscriptions subscribe a customer only when they purchase a specific item. This allows targeted list segmentation by product.
Navigate as follows:

Main Menu → Items → Item Management → Then click on the Item ID you would like to edit. In the editor, navigate to the ‘Other tab’ then select 'Third Party Email Marketing

Once you are inside the item editor simply click on the Other tab of the item Menu.

Scroll down and click the 3rd Party Email Marketing link. 

 A list of your AWeber lists appears with **Subscribe** and **Unsubscribe** checkboxes for each. Check the lists you want associated with this item and click **Save**.

Check the box next to each list you want subscribed to when this item is purchased.  Then click save.

Buy-Link Override

For advanced use cases, you can specify a list directly in a buy link URL using the following parameter:

&aweberAdd=<list name>

Custom Fields

UltraCart maps order and contact data to AWeber custom fields during the subscriber API call. For a custom field to be populated, a field with a matching name must already exist on the AWeber list

Important Note: AWeber matches incoming field keys by name. If the custom field does not exist on your AWeber list, or if the name does not match exactly, that field will be silently omitted from the subscriber record.

Renaming fields in the UltraCart checkout form has no effect on this mapping.


Creating Custom Fields in AWeber

  1. Log in to your AWeber account.

  2. Select the list you are using with UltraCart.

  3. Navigate to ‘List Options → Custom Fields.’

  4. Click Add Custom Field and create a field using the exact name from the table below.

  5. Repeat for each field you want populated.

  6. Click Save.

 

Supported Field Names

Create custom fields in AWeber using these exact names. UltraCart sends these key names in the API subscribe call; they are not configurable from within UltraCart.

UltraCart has some build in mappings to custom fields that you can put on your AWeber contacts.  The following custom field names are supported and will automatically map during the subscribe call.

AWeber Custom Field Name

Data Populated by UltraCart

 

AWeber Custom Field Name

Data Populated by UltraCart

 

Phone

Customer phone number

 

Address

Billing address line 1

 

Address (2)

Billing address line 2

 

City

Billing city

 

State

Billing state or province

 

Zip

Billing postal code (alternative key)

 

Zip Code

Billing postal code

 

Country

Billing country

 

SBT

Storefront identifier

 

ItemId

Item ID of the first item on the order

 

ItemIds

Comma-separated list of all item IDs on the order

 

`Zip` and `Zip Code` are both sent. You only need to create one; create whichever name your AWeber account already uses if you have an existing setup.

Payment Method and Address Collection

For address fields to be populated, UltraCart must collect the customer's address before payment is processed. Certain Express Checkout payment methods can bypass address collection:

  • PayPal Express Checkout: If express checkout is enabled, customers may bypass the UltraCart address form entirely. Address fields will be absent from the AWeber subscribe call for those orders. To prevent this, configure your checkout to hide the express checkout row in your checkout so customers complete the address fields before selecting PayPal as their payment method.

  • Credit card payments: Address collection proceeds normally.

  • Venmo: Address collection proceeds normally when express checkout is disabled.

 

Troubleshooting

Address fields are not appearing in AWeber subscriber records

Symptoms: Subscriber records in AWeber show only some fields (such as City and Country) but Address, State, and Zip are blank or missing.

Cause 1 - Custom fields not created in AWeber: The AWeber list does not have custom fields with names matching what UltraCart sends.

Solution: Follow the steps in the Creating Custom Fields in AWeber section above. Create each field using the exact names in the Supported Field Names table. Do not rename fields in the UltraCart checkout form; those label names are unrelated to the AWeber API field mapping.

Cause 2 - PayPal Express Checkout bypassing address collection: Orders placed via PayPal Express Checkout may skip the UltraCart address form, so no address data is available to send to AWeber.

Solution: In your UltraCart checkout configuration, hide the express checkout row to require customers to enter address information before choosing PayPal as a payment method.

Only some fields populate after creating custom fields in AWeber

Symptoms: Fields were created in AWeber but some still do not populate.

Cause: The custom field name in AWeber does not exactly match the name UltraCart sends.

Solution: Verify the field names in AWeber against the Supported Field Names table. AWeber field names are case-sensitive. For example, "address" will not match "Address".

AWeber is showing duplicate or empty subscriber records

Symptoms: Subscriber records are created but contain no custom field data.

Cause: The AWeber list has no custom fields defined, so the subscribe call succeeds but field data is discarded.

Solution: Create the required custom fields as described above, then test with a new order. Existing subscriber records will not be backfilled.

Related Documentation

3rd Party Email Marketing Overview - Overview of all supported email marketing integrations

Checkout Configuration - Configuring payment methods and address collection behavior