Skip to content
Nappai Documentation

ActiveCampaign E-commerce Orders

This component helps you manage your e-commerce orders within ActiveCampaign. You can use it to look up specific orders, create new order records, or sync order information from your online store. It acts as a bridge between your e-commerce platform and ActiveCampaign, ensuring your customer data and orders stay up to date.

How it Works

This component connects directly to the ActiveCampaign API. When you configure it, you tell Nappai which order you want to work with using IDs or search filters. It then communicates securely with ActiveCampaign to fetch order details, create new orders based on the data you provide, or update order status. The results are returned as structured data that you can use in other parts of your automation.

Connection & Credentials

This component requires configuring a credential in the Nappai panel before interacting with the external service:

  1. Go to the Credentials section in your Nappai panel.
  2. Create a new credential of the type ActiveCampaign and fill in the required fields (API URL, API Key). You can get your credentials in your ActiveCampaign account by going to the Settings > Developer menu.
  3. In your workflow, select the saved credential in the Credential input field of this node.

Inputs

The following fields are available to configure this component. Each field may be visible in different operations:

  • Operation: Select the operation to perform.
  • Get By: Retrieve a single order by ID or all orders.
  • Order ID: ActiveCampaign internal ID of the order.
  • Limit: Maximum number of orders to return.
  • Service ID Mode: Custom: enter the Service ID manually. Dynamic: select from your registered e-commerce connections.
  • Service ID: ID of the e-commerce integration connection (e.g., Shopify, WooCommerce).
  • Service: Select an e-commerce connection from your ActiveCampaign account.
  • Customer Mode: Custom: enter the AC Customer ID manually. Dynamic: select from existing e-commerce customers.
  • AC Customer ID: ActiveCampaign internal ID of the customer.
  • Customer: Select an existing e-commerce customer.
  • External Order ID: ID of the order in the external e-commerce platform.
  • Order Number: Human-readable order number (e.g., #1001).
  • Order URL: URL to the order in the external platform.
  • Order Date: Date of the order in ISO 8601 format (e.g., 2024-01-15T10:30:00-05:00).
  • Customer Email: Email address of the customer who placed the order.
  • Total Price: Total order value (e.g., 7000 = $7000.00).
  • Currency: Currency of the order.
  • Shipping Amount: Shipping cost (e.g., 500 = $500.00).
  • Tax Amount: Tax amount (e.g., 100 = $100.00).
  • Discount Amount: Discount applied (e.g., 200 = $200.00).
  • Order Status: Status of the order.
  • Number of Products: Number of products to add to the order. Each product will show its own set of fields.

Outputs

This component returns structured data about your orders. You can use these outputs to feed information into other parts of your workflow, such as updating customer records or triggering follow-up actions.

  • Order Result: Returns the complete structure of the order, including ID, status, totals, and product details.
  • Operation Status: Indicates the success or failure of the action.
  • Error Details: Provides error messages if something goes wrong.
  • Empty Result: Returns empty data if no orders match the search.

Output Data Example (JSON)json

{ “order_id”: “54321”, “order_number”: “#1001”, “status”: “completed”, “customer_email”: “buyer@example.com”, “total”: 7000, “currency”: “USD”, “shipping_amount”: 500, “tax_amount”: 100, “discount_amount”: 200, “products”: [ { “product_id”: “98765”, “name”: “Example Product”, “quantity”: 1 } ] }

Connectivity

This component is typically used in e-commerce workflows. You might connect it to a trigger that fires when a new order is placed on your store. The output can then be connected to email marketing components to send order confirmations, or to data management nodes to update customer records. It works well as a bridge between your store and ActiveCampaign to automate order processing.

Usage Example

Fetching Order Details: Use this component to retrieve details of a specific order using its Order ID. You can then use the output to check the order status or total price, which you might use to calculate shipping costs or trigger a specific follow-up email for high-value orders.

Tips and Best Practices

  • Ensure your API Key has the correct permissions in ActiveCampaign to read and write orders.
  • Use the “Limit” field to control how many orders are returned, which helps avoid performance issues.
  • Map the Order ID when you need to work with specific orders rather than fetching all available orders.
  • Always check the Operation Status output to handle errors gracefully in your workflow.
  • For dynamic integrations, use the Service ID Mode to automatically select connections based on your e-commerce platform.

Security Considerations

Never share your API Key or Secret. Store credentials securely in Nappai and only expose them to trusted workflows. Ensure your API URL matches your ActiveCampaign account region to avoid connection errors.