Skip to main content

​
List Conversions

Retrieve all conversions (orders) for a project.
​
brand
string
required
The brand/project ID
​
page
number
Page number for pagination (default: 1)
​
per_page
number
Number of results per page (default: 15)
​
search
string
Search by order code, customer email, or name
Request
GET /api/brands/{brand}/conversions
cURL
curl "https://app.elasticfunnels.io/api/brands/{brand_id}/conversions?page=1&per_page=15" \
  -H "EF-Access-Key: your_api_key_here"

{
  "data": [
    {
      "code": "ORD-12345",
      "customer_email": "[email protected]",
      "customer_name": "John Doe",
      "total": 149.97,
      "currency": "USD",
      "status": "completed",
      "created_at": "2024-12-10T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 150
  }
}

​
Get Conversion Details

Retrieve details about a specific conversion.
​
brand
string
required
The brand/project ID
​
code
string
required
The order code
Request
GET /api/brands/{brand}/conversions/{code}
cURL
curl https://app.elasticfunnels.io/api/brands/{brand_id}/conversions/ORD-12345 \
  -H "EF-Access-Key: your_api_key_here"

{
  "code": "ORD-12345",
  "customer_email": "[email protected]",
  "customer_name": "John Doe",
  "customer_phone": "+1234567890",
  "total": 149.97,
  "currency": "USD",
  "status": "completed",
  "items": [
    {
      "product_name": "Main Product",
      "price": 49.99,
      "quantity": 1,
      "type": "main"
    },
    {
      "product_name": "Upsell Product",
      "price": 99.98,
      "quantity": 2,
      "type": "upsell"
    }
  ],
  "shipping_address": {
    "address_1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US"
  },
  "created_at": "2024-12-10T10:30:00.000000Z"
}

​
Export Conversions

Export conversions to CSV.
​
brand
string
required
The brand/project ID
​
start_date
string
Start date (YYYY-MM-DD)
​
end_date
string
End date (YYYY-MM-DD)
​
status
string
Filter by status: completed, refunded, chargeback
Request
POST /api/brands/{brand}/conversions/export
cURL
curl -X POST https://app.elasticfunnels.io/api/brands/{brand_id}/conversions/export \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "start_date": "2024-12-01",
    "end_date": "2024-12-10"
  }'

{
  "message": "Export is being processed",
  "export_id": "exp_abc123",
  "download_url": "https://app.elasticfunnels.io/api/brands/{brand_id}/exports/exp_abc123/download/{token}"
}

​
Refund Conversion

Process a refund for a conversion (requires admin/owner permissions).
​
brand
string
required
The brand/project ID
​
code
string
required
The order code
​
amount
number
Refund amount (optional, defaults to full refund)
​
reason
string
Refund reason
Request
POST /api/brands/{brand}/conversions/{code}/refund
cURL
curl -X POST https://app.elasticfunnels.io/api/brands/{brand_id}/conversions/ORD-12345/refund \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Customer request"
  }'

{
  "message": "Refund processed successfully",
  "code": "ORD-12345",
  "refund_amount": 149.97,
  "status": "refunded"
}