Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ActiveCampaign Ecommerce API

The Ecommerce API from ActiveCampaign — 8 operation(s) for ecommerce.

ActiveCampaign Ecommerce API is one of 36 APIs that ActiveCampaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include Ecommerce. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an AsyncAPI specification, and 9 JSON Schemas.

This API exposes 13 operations across 8 paths. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against a single base URL, https://{yourAccountName}.api-us1.com/api/3.

13 operations 8 paths 0 schemas 2 DELETE7 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://youraccountname.api-us1.com/api/3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ActiveCampaign Ecommerce API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Token (ApiToken). By default, every request must be authenticated.

  • ApiToken — Your ActiveCampaign API token

Paths & Operations 13

Across 8 paths, the API surfaces 13 operations — 2 DELETE, 7 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Ecommerce 13
POST
/ecomCustomers
ActiveCampaign Create a Customer
create-customer body → 201400
GET
/ecomCustomers
ActiveCampaign List All Customers
list-all-customers 3 params → 200
GET
/ecomCustomers/{id}
ActiveCampaign Retrieve a Customer
get-customer 1 param → 200400
PUT
/ecomCustomers/{id}
ActiveCampaign Update a Customer
update-customer 1 param body → 200
DELETE
/ecomCustomers/{id}
ActiveCampaign Delete a Customer
delete-customer 1 param → 200400
POST
/ecomOrders
ActiveCampaign Create an Order
create-order body → 201
GET
/ecomOrders
ActiveCampaign List All Orders
list-all-orders 14 params → 200422
GET
/ecomOrders/{ecomOrderId}
ActiveCampaign Retrieve an Order
get-order 1 param → 200
DELETE
/ecomOrders/{ecomOrderId}
ActiveCampaign Delete an Order
delete-order 1 param → 200
PUT
/ecomOrders/{id}
ActiveCampaign Update an Order
update-order 1 param body → 200
GET
/ecomOrderProducts
ActiveCampaign List EcomOrderProducts
list-ecomorderproducts → 200400
GET
/ecomOrders/{id}/orderProducts
ActiveCampaign List EcomOrderProducts for a Specific EcomOrder
list-products-for-order 1 param → 200400
GET
/ecomOrderProducts/{id}
ActiveCampaign Retrieve an EcomOrderProduct
retrieve-an-ecomorderproduct 1 param → 200400404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-ecommerce-api-openapi.yml Raw ↑

Other APIs ActiveCampaign publishes across the network.

ActiveCampaign Accounts API
ActiveCampaign Addresses API
ActiveCampaign AI API
ActiveCampaign Automations API
ActiveCampaign Branding API
ActiveCampaign Broadcasts API
ActiveCampaign Bulk Import API
ActiveCampaign Calendars API
ActiveCampaign Campaigns API
ActiveCampaign Contacts API
ActiveCampaign Credits API
ActiveCampaign Custom Objects API