Checkout Champ - Documentation

Overview

Manage customers, orders, subscriptions, and campaigns in Checkout Champ. Call actions with automationType, action, and params from any workflow node that supports automations.

Authentication

Checkout Champ API Login ID and Password (per-account).

Available Actions

Click any action to jump to its example payload. Affiliates

Affiliate Update

Campaigns

Create Campaign
Create Campaign Product
Update Campaign
Update Campaign Countries
Update Campaign Product

Club-Members

Cancel Club Membership
Query Club Members
Reactivate Club Membership
Reset Club Members
Update Club Members

Coupons

Create Coupon
Create Coupon Range Profile
Query Coupon
Update Coupon Range Profile

Customer

Add Customer Note
Create Blacklist
Delete Customers
Query Customer Contracts
Update Customer
Update Customer Card

Fulfillment

Query Fulfillment
Update Fulfillment

Funnels

Query Funnels

Gateway

Query Gateway

Order

Cancel Order
Confirm Order
Import Order
Import Upsale
Order Coupon
Order QA
Order Sales Tax
Order Ship Rate
Order Surcharge
Refund Order
Rerun Declined Sale
Resend Autoresponder
Update Order

Payments

Confirm PayPal

Products

Create Product
Query Product

Purchase

Query Purchases
Update Purchase

Purchases

Pause Purchase

Reports

Query Order Summary Report
Query Projected Billing Report
Query Retention Report
Query Transaction Summary Report

Transaction

Capture Transaction
Composite Data Query
Query Transactions
Refund Transactions
Transaction Range Select
Update Transaction

Examples

Example 1: Checkout Champ: Import Lead

Add a new lead/order through the Import Lead API

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-import-lead-001",
  "nodeParams": {
    "action": "import_lead",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "campaignId": 13,
      "firstName": "Test",
      "lastName": "Robinson",
      "emailAddress": "test@example.com",
      "phoneNumber": "11233399",
      "address1": "4455 Hollywood Blvd",
      "address2": "Apt. 1120",
      "city": "Rome",
      "state": "NY",
      "country": "US",
      "postalCode": "00012"
    }
  }
}

Example 2: Checkout Champ: Preauth Order

Preauthorize a credit card for $1.00 on new orders

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-preauth-order-001",
  "nodeParams": {
    "action": "preauth_order",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0",
      "firstName": "Test",
      "lastName": "Robinson",
      "address1": "4455 Hollywood Blvd",
      "city": "Rome",
      "state": "NY",
      "country": "US",
      "postalCode": "00012",
      "cardNumber": "4111111111111111",
      "cardExpiryDate": "02/2025",
      "cardSecurityCode": "123",
      "paySource": "CREDITCARD"
    }
  }
}

Example 3: Checkout Champ: Order QA

Approve or decline orders pending Quality Assurance

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-order-qa-001",
  "nodeParams": {
    "action": "order_qa",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0",
      "action": "APPROVE"
    }
  }
}

Example 4: Checkout Champ: Rerun Declined Sale

Retry billing of a declined transaction in a new sale

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-rerun-declined-sale-001",
  "nodeParams": {
    "action": "rerun_declined_sale",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 5: Checkout Champ: Refund Order

Refund an order

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-refund-order-001",
  "nodeParams": {
    "action": "refund_order",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 6: Checkout Champ: Cancel Order

Cancel an order

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-cancel-order-001",
  "nodeParams": {
    "action": "cancel_order",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 7: Checkout Champ: Import Order

Import a new order

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-import-order-001",
  "nodeParams": {
    "action": "import_order",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "campaignId": 13,
      "firstName": "Test",
      "lastName": "Robinson",
      "emailAddress": "test@example.com",
      "phoneNumber": "11233399",
      "postalCode": "00012"
    }
  }
}

Example 8: Checkout Champ: Order Sales Tax

Calculate sales tax for an order

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-order-sales-tax-001",
  "nodeParams": {
    "action": "order_sales_tax",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 9: Checkout Champ: Order Surcharge

Apply surcharge to an order

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-order-surcharge-001",
  "nodeParams": {
    "action": "order_surcharge",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 10: Checkout Champ: Update Fulfillment

Update fulfillment status and tracking information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-fulfillment-001",
  "nodeParams": {
    "action": "update_fulfillment",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "fulfillmentId": "12345",
      "status": "SHIPPED",
      "trackingNumber": "1Z999AA10123456784"
    }
  }
}

Example 11: Checkout Champ: Query Fulfillment

Query fulfillment information by order ID or fulfillment ID

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-fulfillment-001",
  "nodeParams": {
    "action": "query_fulfillment",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 12: Checkout Champ: Confirm Order

Confirm an order

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-confirm-order-001",
  "nodeParams": {
    "action": "confirm_order",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 13: Checkout Champ: Query Order

Query order details by order ID or customer ID

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-order-001",
  "nodeParams": {
    "action": "query_order",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 14: Checkout Champ: Import Upsale

Import an upsale order

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-import-upsale-001",
  "nodeParams": {
    "action": "import_upsale",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "campaignId": 13,
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 15: Checkout Champ: Update Order

Update an existing order

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-order-001",
  "nodeParams": {
    "action": "update_order",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 16: Checkout Champ: Order Ship Rate

Get shipping rate for an order

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-order-ship-rate-001",
  "nodeParams": {
    "action": "order_ship_rate",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 17: Checkout Champ: Order Coupon

Apply a coupon code to an order

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-order-coupon-001",
  "nodeParams": {
    "action": "order_coupon",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0",
      "couponCode": "SAVE10"
    }
  }
}

Example 18: Checkout Champ: Resend Autoresponder

Resend autoresponders that may have been sent to the wrong email or phone

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-resend-autoresponder-001",
  "nodeParams": {
    "action": "resend_autoresponder",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0",
      "autoresponderType": "ORDER",
      "type": "EMAIL"
    }
  }
}

Example 19: Checkout Champ: Create Blacklist

Add or remove a blacklist entry by card bin, country/state, email, phone, or IP

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-create-blacklist-001",
  "nodeParams": {
    "action": "create_blacklist",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "blacklistType": "cardBin",
      "cardBin": "411111"
    }
  }
}

Example 20: Checkout Champ: Query Customer Contracts

Get base64-encoded customer contract PDF files by order ID or customer ID

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-customer-contracts-001",
  "nodeParams": {
    "action": "query_customer_contracts",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 21: Checkout Champ: Add Customer Note

Add a note to a customer record

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-add-customer-note-001",
  "nodeParams": {
    "action": "add_customer_note",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "customerId": "46611",
      "note": "Customer called regarding order status"
    }
  }
}

Example 22: Checkout Champ: Update Customer Card

Update credit card information for a customer

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-customer-card-001",
  "nodeParams": {
    "action": "update_customer_card",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "customerId": "46611",
      "cardNumber": "4111111111111111",
      "cardExpiryDate": "02/2025",
      "cardSecurityCode": "123"
    }
  }
}

Example 23: Checkout Champ: Update Customer

Update customer information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-customer-001",
  "nodeParams": {
    "action": "update_customer",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "customerId": "46611"
    }
  }
}

Example 24: Checkout Champ: Delete Customers

Delete a customer record

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-delete-customers-001",
  "nodeParams": {
    "action": "delete_customers",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "customerId": "46611"
    }
  }
}

Example 25: Checkout Champ: Query Customer History

Query customer order and transaction history

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-customer-history-001",
  "nodeParams": {
    "action": "query_customer_history",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "customerId": "46611"
    }
  }
}

Example 26: Checkout Champ: Query Customers

Query customer information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-customers-001",
  "nodeParams": {
    "action": "query_customers",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "customerId": "46611"
    }
  }
}

Example 27: Checkout Champ: Query Transactions

Query transaction information by order ID or customer ID

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-transactions-001",
  "nodeParams": {
    "action": "query_transactions",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 28: Checkout Champ: Update Transaction

Update transaction information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-transaction-001",
  "nodeParams": {
    "action": "update_transaction",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "transactionId": "TXN123456"
    }
  }
}

Example 29: Checkout Champ: Refund Transactions

Refund a transaction

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-refund-transactions-001",
  "nodeParams": {
    "action": "refund_transactions",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "transactionId": "TXN123456"
    }
  }
}

Example 30: Checkout Champ: Composite Data Query

Query composite data

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-composite-data-query-001",
  "nodeParams": {
    "action": "composite_data_query",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD"
    }
  }
}

Example 31: Checkout Champ: Transaction Range Select

Select transactions within a date range

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-transaction-range-select-001",
  "nodeParams": {
    "action": "transaction_range_select",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD"
    }
  }
}

Example 32: Checkout Champ: Query Purchases

Query purchase/subscription information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-purchases-001",
  "nodeParams": {
    "action": "query_purchases",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "customerId": "46611"
    }
  }
}

Example 33: Checkout Champ: Update Purchase

Update purchase/subscription information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-purchase-001",
  "nodeParams": {
    "action": "update_purchase",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "purchaseId": "PURCH123"
    }
  }
}

Example 34: Checkout Champ: Cancel Purchase

Cancel a purchase/subscription

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-cancel-purchase-001",
  "nodeParams": {
    "action": "cancel_purchase",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "purchaseId": "PURCH123"
    }
  }
}

Example 35: Checkout Champ: Pause Purchase

Pause a purchase/subscription

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-pause-purchase-001",
  "nodeParams": {
    "action": "pause_purchase",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "purchaseId": "PURCH123"
    }
  }
}

Example 36: Checkout Champ: Refund Purchase

Refund a purchase/subscription

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-refund-purchase-001",
  "nodeParams": {
    "action": "refund_purchase",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "purchaseId": "PURCH123"
    }
  }
}

Example 37: Checkout Champ: Query Product

Query product information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-product-001",
  "nodeParams": {
    "action": "query_product",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "productId": "1"
    }
  }
}

Example 38: Checkout Champ: Create Product

Create a new product

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-create-product-001",
  "nodeParams": {
    "action": "create_product",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "productName": "My Product"
    }
  }
}

Example 39: Checkout Champ: Update Product

Update product information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-product-001",
  "nodeParams": {
    "action": "update_product",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "productId": "1"
    }
  }
}

Example 40: Checkout Champ: Query Campaign

Query campaign information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-campaign-001",
  "nodeParams": {
    "action": "query_campaign",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "campaignId": 13
    }
  }
}

Example 41: Checkout Champ: Create Campaign

Create a new campaign

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-create-campaign-001",
  "nodeParams": {
    "action": "create_campaign",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "campaignName": "My Campaign"
    }
  }
}

Example 42: Checkout Champ: Update Campaign

Update campaign information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-campaign-001",
  "nodeParams": {
    "action": "update_campaign",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "campaignId": 13
    }
  }
}

Example 43: Checkout Champ: Create Campaign Product

Add a product to a campaign

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-create-campaign-product-001",
  "nodeParams": {
    "action": "create_campaign_product",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "campaignId": 13,
      "productId": 1
    }
  }
}

Example 44: Checkout Champ: Update Campaign Product

Update product settings within a campaign

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-campaign-product-001",
  "nodeParams": {
    "action": "update_campaign_product",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "campaignId": 13,
      "productId": 1
    }
  }
}

Example 45: Checkout Champ: Create Coupon

Create a new coupon

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-create-coupon-001",
  "nodeParams": {
    "action": "create_coupon",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "couponCode": "SAVE10"
    }
  }
}

Example 46: Checkout Champ: Query Coupon

Query coupon information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-coupon-001",
  "nodeParams": {
    "action": "query_coupon",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "couponCode": "SAVE10"
    }
  }
}

Example 47: Checkout Champ: Update Coupon

Update coupon information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-coupon-001",
  "nodeParams": {
    "action": "update_coupon",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "couponCode": "SAVE10"
    }
  }
}

Example 48: Checkout Champ: Create Coupon Range Profile

Create a coupon range profile

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-create-coupon-range-profile-001",
  "nodeParams": {
    "action": "create_coupon_range_profile",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "couponCode": "SAVE10"
    }
  }
}

Example 49: Checkout Champ: Update Coupon Range Profile

Update a coupon range profile

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-coupon-range-profile-001",
  "nodeParams": {
    "action": "update_coupon_range_profile",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "couponCode": "SAVE10"
    }
  }
}

Example 50: Checkout Champ: Import Click

Import a click/tracking event for a campaign

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-import-click-001",
  "nodeParams": {
    "action": "import_click",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "campaignId": 13
    }
  }
}

Example 51: Checkout Champ: Confirm PayPal

Confirm a PayPal transaction

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-confirm-paypal-001",
  "nodeParams": {
    "action": "confirm_paypal",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "transactionId": "TXN123456"
    }
  }
}

Authenticate a club member

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-club-member-login-001",
  "nodeParams": {
    "action": "club_member_login",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "memberIdentifier": "member@example.com",
      "memberPassword": "memberpassword"
    }
  }
}

Example 53: Checkout Champ: Cancel Club Membership

Cancel a club membership

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-cancel-club-membership-001",
  "nodeParams": {
    "action": "cancel_club_membership",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "memberId": "MEMBER123"
    }
  }
}

Example 54: Checkout Champ: Query Club Members

Query club member information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-club-members-001",
  "nodeParams": {
    "action": "query_club_members",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "memberId": "MEMBER123"
    }
  }
}

Example 55: Checkout Champ: Update Club Members

Update club member information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-club-members-001",
  "nodeParams": {
    "action": "update_club_members",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "memberId": "MEMBER123"
    }
  }
}

Example 56: Checkout Champ: Reactivate Club Membership

Reactivate a cancelled club membership

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-reactivate-club-membership-001",
  "nodeParams": {
    "action": "reactivate_club_membership",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "memberId": "MEMBER123"
    }
  }
}

Example 57: Checkout Champ: Reset Club Members

Reset club member password or credentials

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-reset-club-members-001",
  "nodeParams": {
    "action": "reset_club_members",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "memberId": "MEMBER123"
    }
  }
}

Example 58: Checkout Champ: Affiliate Query

Query affiliate information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-affiliate-query-001",
  "nodeParams": {
    "action": "affiliate_query",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "affiliateId": "AFF123"
    }
  }
}

Example 59: Checkout Champ: Affiliate Create

Create a new affiliate

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-affiliate-create-001",
  "nodeParams": {
    "action": "affiliate_create",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "affiliateName": "New Affiliate"
    }
  }
}

Example 60: Checkout Champ: Affiliate Update

Update affiliate information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-affiliate-update-001",
  "nodeParams": {
    "action": "affiliate_update",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "affiliateId": "AFF123"
    }
  }
}

Example 61: Checkout Champ: Query Mid Summary Report

Query mid summary report data

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-mid-summary-report-001",
  "nodeParams": {
    "action": "query_mid_summary_report",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD"
    }
  }
}

Example 62: Checkout Champ: Query Bin Approval Report

Query bin approval report data

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-bin-approval-report-001",
  "nodeParams": {
    "action": "query_bin_approval_report",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD"
    }
  }
}

Example 63: Checkout Champ: Query Retention Report

Query customer retention report data

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-retention-report-001",
  "nodeParams": {
    "action": "query_retention_report",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD"
    }
  }
}

Example 64: Checkout Champ: Query Projected Billing Report

Query projected billing report data

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-projected-billing-report-001",
  "nodeParams": {
    "action": "query_projected_billing_report",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD"
    }
  }
}

Example 65: Checkout Champ: Query Gateway

Query gateway/merchant information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-gateway-001",
  "nodeParams": {
    "action": "query_gateway",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD"
    }
  }
}

Example 66: Checkout Champ: Query Transaction Summary Report

Query transaction summary report data

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-transaction-summary-report-001",
  "nodeParams": {
    "action": "query_transaction_summary_report",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD"
    }
  }
}

Example 67: Checkout Champ: Query Order Summary Report

Query order summary report data

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-order-summary-report-001",
  "nodeParams": {
    "action": "query_order_summary_report",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD"
    }
  }
}

Example 68: Checkout Champ: Query Funnels

Query funnel/list information

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-query-funnels-001",
  "nodeParams": {
    "action": "query_funnels",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD"
    }
  }
}

Example 69: Checkout Champ: Capture Transaction

Capture (settle) a previously authorized transaction

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-capture-transaction-001",
  "nodeParams": {
    "action": "capture_transaction",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "orderId": "C3E67A9BD0"
    }
  }
}

Example 70: Checkout Champ: Update Campaign Countries

Update the list of allowed countries for a campaign

{
  "automationType": "checkoutchamp",
  "nodeId": "checkoutchamp-update-campaign-countries-001",
  "nodeParams": {
    "action": "update_campaign_countries",
    "params": {
      "loginId": "YOUR_CHECKOUTCHAMP_LOGIN_ID",
      "password": "YOUR_CHECKOUTCHAMP_PASSWORD",
      "campaignId": 29,
      "countries": "US,CA,GB"
    }
  }
}

Third-Party Documentation

https://docs.checkoutchamp.com/

Get Started

The Platform

​Overview

​Authentication

​Available Actions

​Examples

​Example 1: Checkout Champ: Import Lead

​Example 2: Checkout Champ: Preauth Order

​Example 3: Checkout Champ: Order QA

​Example 4: Checkout Champ: Rerun Declined Sale

​Example 5: Checkout Champ: Refund Order

​Example 6: Checkout Champ: Cancel Order

​Example 7: Checkout Champ: Import Order

​Example 8: Checkout Champ: Order Sales Tax

​Example 9: Checkout Champ: Order Surcharge

​Example 10: Checkout Champ: Update Fulfillment

​Example 11: Checkout Champ: Query Fulfillment

​Example 12: Checkout Champ: Confirm Order

​Example 13: Checkout Champ: Query Order

​Example 14: Checkout Champ: Import Upsale

​Example 15: Checkout Champ: Update Order

​Example 16: Checkout Champ: Order Ship Rate

​Example 17: Checkout Champ: Order Coupon

​Example 18: Checkout Champ: Resend Autoresponder

​Example 19: Checkout Champ: Create Blacklist

​Example 20: Checkout Champ: Query Customer Contracts

​Example 21: Checkout Champ: Add Customer Note

​Example 22: Checkout Champ: Update Customer Card

​Example 23: Checkout Champ: Update Customer

​Example 24: Checkout Champ: Delete Customers

​Example 25: Checkout Champ: Query Customer History

​Example 26: Checkout Champ: Query Customers

​Example 27: Checkout Champ: Query Transactions

​Example 28: Checkout Champ: Update Transaction

​Example 29: Checkout Champ: Refund Transactions

​Example 30: Checkout Champ: Composite Data Query

​Example 31: Checkout Champ: Transaction Range Select

​Example 32: Checkout Champ: Query Purchases

​Example 33: Checkout Champ: Update Purchase

​Example 34: Checkout Champ: Cancel Purchase

​Example 35: Checkout Champ: Pause Purchase

​Example 36: Checkout Champ: Refund Purchase

​Example 37: Checkout Champ: Query Product

​Example 38: Checkout Champ: Create Product

​Example 39: Checkout Champ: Update Product

​Example 40: Checkout Champ: Query Campaign

​Example 41: Checkout Champ: Create Campaign

​Example 42: Checkout Champ: Update Campaign

​Example 43: Checkout Champ: Create Campaign Product

​Example 44: Checkout Champ: Update Campaign Product

​Example 45: Checkout Champ: Create Coupon

​Example 46: Checkout Champ: Query Coupon

​Example 47: Checkout Champ: Update Coupon

​Example 48: Checkout Champ: Create Coupon Range Profile

​Example 49: Checkout Champ: Update Coupon Range Profile

​Example 50: Checkout Champ: Import Click

​Example 51: Checkout Champ: Confirm PayPal

​Example 52: Checkout Champ: Club Member Login

​Example 53: Checkout Champ: Cancel Club Membership

​Example 54: Checkout Champ: Query Club Members

​Example 55: Checkout Champ: Update Club Members

​Example 56: Checkout Champ: Reactivate Club Membership

​Example 57: Checkout Champ: Reset Club Members

​Example 58: Checkout Champ: Affiliate Query

​Example 59: Checkout Champ: Affiliate Create

​Example 60: Checkout Champ: Affiliate Update

​Example 61: Checkout Champ: Query Mid Summary Report

​Example 62: Checkout Champ: Query Bin Approval Report

​Example 63: Checkout Champ: Query Retention Report

​Example 64: Checkout Champ: Query Projected Billing Report

​Example 65: Checkout Champ: Query Gateway

​Example 66: Checkout Champ: Query Transaction Summary Report

​Example 67: Checkout Champ: Query Order Summary Report

​Example 68: Checkout Champ: Query Funnels

​Example 69: Checkout Champ: Capture Transaction

​Example 70: Checkout Champ: Update Campaign Countries

​Third-Party Documentation