Skip to main content

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 Campaigns Club-Members Coupons Customer Fulfillment Funnels Gateway Order Payments Products Purchase Purchases Reports Transaction

Examples

Example 1: Checkout Champ: Import Lead

Add a new lead/order through the Import Lead API

Example 2: Checkout Champ: Preauth Order

Preauthorize a credit card for $1.00 on new orders

Example 3: Checkout Champ: Order QA

Approve or decline orders pending Quality Assurance

Example 4: Checkout Champ: Rerun Declined Sale

Retry billing of a declined transaction in a new sale

Example 5: Checkout Champ: Refund Order

Refund an order

Example 6: Checkout Champ: Cancel Order

Cancel an order

Example 7: Checkout Champ: Import Order

Import a new order

Example 8: Checkout Champ: Order Sales Tax

Calculate sales tax for an order

Example 9: Checkout Champ: Order Surcharge

Apply surcharge to an order

Example 10: Checkout Champ: Update Fulfillment

Update fulfillment status and tracking information

Example 11: Checkout Champ: Query Fulfillment

Query fulfillment information by order ID or fulfillment ID

Example 12: Checkout Champ: Confirm Order

Confirm an order

Example 13: Checkout Champ: Query Order

Query order details by order ID or customer ID

Example 14: Checkout Champ: Import Upsale

Import an upsale order

Example 15: Checkout Champ: Update Order

Update an existing order

Example 16: Checkout Champ: Order Ship Rate

Get shipping rate for an order

Example 17: Checkout Champ: Order Coupon

Apply a coupon code to an order

Example 18: Checkout Champ: Resend Autoresponder

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

Example 19: Checkout Champ: Create Blacklist

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

Example 20: Checkout Champ: Query Customer Contracts

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

Example 21: Checkout Champ: Add Customer Note

Add a note to a customer record

Example 22: Checkout Champ: Update Customer Card

Update credit card information for a customer

Example 23: Checkout Champ: Update Customer

Update customer information

Example 24: Checkout Champ: Delete Customers

Delete a customer record

Example 25: Checkout Champ: Query Customer History

Query customer order and transaction history

Example 26: Checkout Champ: Query Customers

Query customer information

Example 27: Checkout Champ: Query Transactions

Query transaction information by order ID or customer ID

Example 28: Checkout Champ: Update Transaction

Update transaction information

Example 29: Checkout Champ: Refund Transactions

Refund a transaction

Example 30: Checkout Champ: Composite Data Query

Query composite data

Example 31: Checkout Champ: Transaction Range Select

Select transactions within a date range

Example 32: Checkout Champ: Query Purchases

Query purchase/subscription information

Example 33: Checkout Champ: Update Purchase

Update purchase/subscription information

Example 34: Checkout Champ: Cancel Purchase

Cancel a purchase/subscription

Example 35: Checkout Champ: Pause Purchase

Pause a purchase/subscription

Example 36: Checkout Champ: Refund Purchase

Refund a purchase/subscription

Example 37: Checkout Champ: Query Product

Query product information

Example 38: Checkout Champ: Create Product

Create a new product

Example 39: Checkout Champ: Update Product

Update product information

Example 40: Checkout Champ: Query Campaign

Query campaign information

Example 41: Checkout Champ: Create Campaign

Create a new campaign

Example 42: Checkout Champ: Update Campaign

Update campaign information

Example 43: Checkout Champ: Create Campaign Product

Add a product to a campaign

Example 44: Checkout Champ: Update Campaign Product

Update product settings within a campaign

Example 45: Checkout Champ: Create Coupon

Create a new coupon

Example 46: Checkout Champ: Query Coupon

Query coupon information

Example 47: Checkout Champ: Update Coupon

Update coupon information

Example 48: Checkout Champ: Create Coupon Range Profile

Create a coupon range profile

Example 49: Checkout Champ: Update Coupon Range Profile

Update a coupon range profile

Example 50: Checkout Champ: Import Click

Import a click/tracking event for a campaign

Example 51: Checkout Champ: Confirm PayPal

Confirm a PayPal transaction

Example 52: Checkout Champ: Club Member Login

Authenticate a club member

Example 53: Checkout Champ: Cancel Club Membership

Cancel a club membership

Example 54: Checkout Champ: Query Club Members

Query club member information

Example 55: Checkout Champ: Update Club Members

Update club member information

Example 56: Checkout Champ: Reactivate Club Membership

Reactivate a cancelled club membership

Example 57: Checkout Champ: Reset Club Members

Reset club member password or credentials

Example 58: Checkout Champ: Affiliate Query

Query affiliate information

Example 59: Checkout Champ: Affiliate Create

Create a new affiliate

Example 60: Checkout Champ: Affiliate Update

Update affiliate information

Example 61: Checkout Champ: Query Mid Summary Report

Query mid summary report data

Example 62: Checkout Champ: Query Bin Approval Report

Query bin approval report data

Example 63: Checkout Champ: Query Retention Report

Query customer retention report data

Example 64: Checkout Champ: Query Projected Billing Report

Query projected billing report data

Example 65: Checkout Champ: Query Gateway

Query gateway/merchant information

Example 66: Checkout Champ: Query Transaction Summary Report

Query transaction summary report data

Example 67: Checkout Champ: Query Order Summary Report

Query order summary report data

Example 68: Checkout Champ: Query Funnels

Query funnel/list information

Example 69: Checkout Champ: Capture Transaction

Capture (settle) a previously authorized transaction

Example 70: Checkout Champ: Update Campaign Countries

Update the list of allowed countries for a campaign

Third-Party Documentation