### Query documentation via HTTP GET Source: https://docs.explodely.com/llms.txt Perform a GET request to the documentation index with 'ask' and 'goal' parameters to receive a direct answer and relevant excerpts. ```http GET https://docs.explodely.com/api/sales-api-affiliate-beta.md?ask=&goal= ``` -------------------------------- ### GET /v1/aff/sale Source: https://docs.explodely.com/api/sales-api-affiliate-beta.md Fetches sales data using a GET request. ```APIDOC ## GET /v1/aff/sale ### Description Fetches sales data for an affiliate account using a GET request. ### Method GET ### Endpoint https://api.explodely.com/v1/aff/sale ### Parameters #### Query Parameters - **username** (string) - Required - Your Explodely affiliate account username - **apikey** (string) - Required - Your Explodely affiliate account API key - **apiaction** (string) - Required - Must be set to "getsalebyget" - **startdate** (string) - Required - Start date in DD-mmm-YYYY format - **enddate** (string) - Required - End date in DD-mmm-YYYY format - **testsale** (string) - Optional - Set as "no" to exclude test sales ### Response #### Success Response (200) - **data** (object) - Sales data object #### Error Response - **error** (string) - Error message (e.g., "invalidapikey", "invalid_username") ``` -------------------------------- ### GET https://explodely.com/api/v1/aff Source: https://docs.explodely.com/api/private-affiliate-payouts.md Sets a private affiliate payout for a specific affiliate and product. ```APIDOC ## GET https://explodely.com/api/v1/aff ### Description Sets a private affiliate payout for a specific affiliate and product. ### Method GET ### Endpoint https://explodely.com/api/v1/aff ### Parameters #### Query Parameters - **username** (string) - Required - Your Explodely account username - **apikey** (string) - Required - Your Explodely account API key - **apiaction** (string) - Required - Must be set to "addprivatepayout" - **affid** (string) - Required - The Explodely affiliate username - **productid** (string) - Required - Product ID or "allproducts" - **comm** (number) - Required - Commission percentage (1-80) ### Response #### Success Response (200) - **payoutadded** (string) - Returns "ok" when the payout is added. #### Error Responses - **error** (string) - Returns error codes: "invalidapikey", "invalid_sellerid", "invalid_affid", "invalid_productid", "unauthorized_access", "comm_range_1_80", "comm_not_numeric", or "payout_exists" ``` -------------------------------- ### GET/POST https://api.explodely.com/v1/sale Source: https://docs.explodely.com/api/sales-api-seller-beta.md Fetch sales data from the Explodely seller account using either GET or POST methods. ```APIDOC ## GET/POST https://api.explodely.com/v1/sale ### Description Search and fetch sales data through your Explodely seller account. ### Endpoint https://api.explodely.com/v1/sale ### Parameters #### Query/Request Parameters - **username** (string) - Required - Your Explodely account username - **apikey** (string) - Required - Your Explodely account API key - **apiaction** (string) - Required - Set as "getsale" for POST or "getsalebyget" for GET - **startdate** (string) - Optional - Start date in DD-mmm-YYYY format - **enddate** (string) - Optional - End date in DD-mmm-YYYY format - **customeremail** (string) - Optional - Email of the customer to search sales ### Response #### Success Response (200) - **sales data** (object) - Returns sales data object upon successful fetch #### Error Responses - **{"error":"invalidapikey"}** - Returned when authentication fails - **{"error":"invalid_sellerid"}** - Returned when the username is not a valid seller account ``` -------------------------------- ### GET https://explodely.com/api/v1/rebill Source: https://docs.explodely.com/api/pause-rebill-api.md Delays the next rebill date for a specified order ID. ```APIDOC ## GET https://explodely.com/api/v1/rebill ### Description Delays the next rebill date for an Explodely order by a specified number of days. ### Method GET ### Endpoint https://explodely.com/api/v1/rebill ### Parameters #### Query Parameters - **username** (string) - Required - Your Explodely account username - **apikey** (string) - Required - Your Explodely account API key - **apiaction** (string) - Required - Must be set to "delayrebill" - **mainorderid** (string) - Required - The initial order ID of the Explodely rebill sale - **delaydays** (integer) - Required - Number of days the next rebill should be delayed by (max 30) ### Response #### Success Response (200) - **rebillcancel** (string) - Confirmation status - **mainorderid** (string) - The order ID processed #### Response Example { "rebillcancel": "done", "mainorderid": "236084113" } ``` -------------------------------- ### GET https://explodely.com/api/v1/rebill Source: https://docs.explodely.com/api/cancel-rebill.md Cancels rebills associated with a specific main order ID. ```APIDOC ## GET https://explodely.com/api/v1/rebill ### Description Cancels the rebills associated with the provided main order ID. ### Method GET ### Endpoint https://explodely.com/api/v1/rebill ### Parameters #### Query Parameters - **username** (string) - Required - Your Explodely account username - **apikey** (string) - Required - Your Explodely account API key - **apiaction** (string) - Required - Must be set to "cancelrebill" - **mainorderid** (string) - Required - The initial order ID of the Explodely rebill sale ### Response #### Success Response (200) - **rebillcancel** (string) - Status of the cancellation ("done") - **mainorderid** (string) - The main order ID processed #### Error Responses - **error** (string) - "invalidapikey" (Authentication failed) - **error** (string) - "invalid_mainorderid" (Order ID is invalid) - **error** (string) - "unauthorized_access" (Order ID does not belong to the user) ### Response Example { "rebillcancel": "done", "mainorderid": "236084113" } ``` -------------------------------- ### POST https://explodely.com/api/v1/aff Source: https://docs.explodely.com/api/create-affiliate-referral-contract.md Creates a new affiliate referral contract (second tier affiliate contract) by sending the required parameters via a POST request. ```APIDOC ## POST https://explodely.com/api/v1/aff ### Description Creates a new affiliate referral contract (second tier affiliate contract) for a partner. ### Method POST ### Endpoint https://explodely.com/api/v1/aff ### Parameters #### Request Body - **username** (string) - Required - Your Explodely account username - **apikey** (string) - Required - Your Explodely account API key - **apiaction** (string) - Required - Must be set to "createaffcontract" - **contract_name** (string) - Required - Contract name for your records - **partner_username** (string) - Required - Explodely affiliate ID of the partner - **product** (string) - Required - Explodely product ID or "allproducts" - **commission** (number) - Required - Percentage of your share the partner will get (up to 80) - **start_date** (string) - Optional - Start date in format dd-mmm-yyyy (default: starts right away) - **end_date** (string) - Optional - End date in format dd-mmm-yyyy (default: active unless terminated) - **max_earnings** (number) - Optional - Value of contract sales after which the contract will expire - **max_sales** (number) - Optional - Number of contract sales after which the contract will expire - **comments** (string) - Optional - Comments visible inside Explodely seller contracts section - **activate** (string) - Optional - Activate contract immediately if set as "yes" (default: "no") - **mutual_termination** (string) - Optional - If set as "yes", the contract terminates after both partner approval (default: "yes") ### Response #### Success Response (200) - **contract_created** (string) - Status indicator ("ok") - **contractid** (string) - The ID of the created contract #### Error Responses - **error** (string) - Returns "invalidapikey", "invalid_partnerusername", "partner_contract_exists", "duplicate_contract", "contract_exists", "commission_limit_exceeded", or "failed" ``` -------------------------------- ### POST /v1/aff/sale Source: https://docs.explodely.com/api/sales-api-affiliate-beta.md Fetches sales data using a POST request. ```APIDOC ## POST /v1/aff/sale ### Description Fetches sales data for an affiliate account using a POST request. ### Method POST ### Endpoint https://api.explodely.com/v1/aff/sale ### Parameters #### Request Body - **username** (string) - Required - Your Explodely affiliate account username - **apikey** (string) - Required - Your Explodely affiliate account API key - **apiaction** (string) - Required - Must be set to "getsale" - **startdate** (string) - Required - Start date in DD-mmm-YYYY format - **enddate** (string) - Required - End date in DD-mmm-YYYY format - **testsale** (string) - Optional - Set as "no" to exclude test sales ### Response #### Success Response (200) - **data** (object) - Sales data object #### Error Response - **error** (string) - Error message (e.g., "invalidapikey", "invalid_username") ``` -------------------------------- ### POST https://explodely.com/api/v1/aff Source: https://docs.explodely.com/api/create-affiliate-user.md Creates a new affiliate user account on Explodely. ```APIDOC ## POST https://explodely.com/api/v1/aff ### Description Creates a new affiliate account on the Explodely system. ### Method POST ### Endpoint https://explodely.com/api/v1/aff ### Parameters #### Request Body - **username** (string) - Required - Your Explodely account username - **apikey** (string) - Required - Your Explodely account API key - **apiaction** (string) - Required - Must be set to "createuser" - **affusername** (string) - Required - Username of affiliate account you wish to create - **userpass** (string) - Required - Password of affiliate account - **fname** (string) - Required - First name of affiliate user - **lname** (string) - Required - Last name of affiliate user - **email** (string) - Required - Email of affiliate user - **ipadd** (string) - Required - IP address of affiliate user ### Response #### Success Response (200) - **usercreated** (string) - Returns "ok" when the affiliate account has been created. #### Error Responses - **error** (string) - "invalidapikey" (Authentication failed) - **error** (string) - "field_empty" (One or more fields are empty) - **error** (string) - "username_exists" (The provided affusername already exists) ``` -------------------------------- ### POST https://explodely.com/api/v1/aff Source: https://docs.explodely.com/api/add-affiliate-to-affiliate-referral-contract.md Adds an affiliate to an affiliate referral contract using the specified parameters. ```APIDOC ## POST https://explodely.com/api/v1/aff ### Description Adds an affiliate to an affiliate referral contract on Explodely. ### Method POST ### Endpoint https://explodely.com/api/v1/aff ### Parameters #### Request Body - **username** (string) - Required - Your Explodely account username - **apikey** (string) - Required - Your Explodely account API key - **apiaction** (string) - Required - Must be set to "addafftoaffcontract" - **contractid** (string) - Required - Explodely affiliate referral contract ID - **affid** (string) - Required - Explodely affiliate account username to be added ### Response #### Success Response (200) - **added** (string) - Returns "ok" when the affiliate has been successfully added. #### Error Responses - **error** (string) - "invalidapikey" (Authentication failed) - **error** (string) - "invalid_contractid" (Invalid contract ID) - **error** (string) - "invalid_affid" (Invalid affiliate ID) - **error** (string) - "affid_exists" (Affiliate already exists in a contract) - **error** (string) - "unauthorized_contract_access" (Contract does not belong to the API account) ``` -------------------------------- ### SALE ISN Payload Source: https://docs.explodely.com/isn-for-affiliates/sale-isn.md The parameters sent to the affiliate's ISN listener when a sale is generated. ```APIDOC ## SALE ISN Notification ### Description Explodely.com sends a SALE type ISN to the affiliate's configured listener within a few minutes of a successful sale. ### Parameters - **orderid** (string) - Order ID of the sale - **transactiontype** (string) - Set to 'sale' - **seller** (string) - Explodely.com seller ID - **pid** (string) - Sale product ID - **ptype** (string) - Type of sale (frontend, upsell, downsell) - **customerName** (string) - Customer Full Name - **amount** (string) - Affiliate share of the sale - **saletimedate** (string) - Sale Time & Date (HH:MM:SS DD-MMM-YYYY) - **saletimestamp** (string) - Machine timestamp of sale - **tid** (string) - Tracking ID from the affiliate link - **affcup** (string) - Custom parameter from the affiliate link - **country** (string) - 2 Digit ISO Country Code of the customer ``` -------------------------------- ### POST Parameters for Checkout Prefill Source: https://docs.explodely.com/articles/prefill-checkout-page-fields.md Details on the parameters used to prefill customer information on the Explodely checkout page. ```APIDOC ## POST Parameters ### Description Pass these parameters to your Explodely product payment URL to prefill customer information fields. ### Parameters - **checkout_email** (string) - Optional - Prefills the customer email address field. - **checkout_name** (string) - Optional - Prefills the customer full name field. - **checkout_zipcode** (string) - Optional - Prefills the customer zip code field. ``` -------------------------------- ### POST https://explodely.com/api/v1/aff Source: https://docs.explodely.com/api/edit-affiliate-referral-contract.md Updates the commission percentage for a specified affiliate referral contract. ```APIDOC ## POST https://explodely.com/api/v1/aff ### Description Updates the commission/percentage share of an affiliate referral contract. ### Method POST ### Endpoint https://explodely.com/api/v1/aff ### Parameters #### Request Body - **username** (string) - Required - Your Explodely account username - **apikey** (string) - Required - Your Explodely account API key - **apiaction** (string) - Required - Must be set to "editaffcontract" - **contractid** (string) - Required - Explodely affiliate referral contract ID - **affcomm** (number) - Required - The percentage of your sale share the partner should get (up to 80) ### Response #### Success Response (200) - **contract_edited** (string) - Returns "ok" when the contract has been successfully edited. #### Error Responses - **error** (string) - "invalidapikey" (Authentication failed) - **error** (string) - "invalid_contractid" (Contract ID is invalid) - **error** (string) - "unauthorized_contract_access" (Contract does not belong to the account) - **error** (string) - "invalid_affcomm" (Commission percentage is invalid or exceeds 80% limit) ``` -------------------------------- ### Decline Webhook Event Source: https://docs.explodely.com/webhooks/decline-webhook.md Details regarding the data points sent by the Explodely decline webhook. ```APIDOC ## Decline Webhook ### Description This webhook is triggered when a purchase attempt is declined by a buyer. Explodely pushes specific data points to your configured webhook URL. ### Data Points - **Customer Name** - Buyer's Name - **Customer Email** - Buyer's Email - **Product ID** - Product ID of the decline ``` -------------------------------- ### Pass TPA ID via PHP Source: https://docs.explodely.com/articles/third-party-affiliates-tpa.md Dynamically inject the affiliate ID from a URL parameter into an Explodely payment link using PHP. ```PHP ”>Click Here To Pay ``` -------------------------------- ### POST https://explodely.com/api/v1/aff Source: https://docs.explodely.com/api/edit-private-affiliate-payout.md Updates the commission percentage for a private affiliate payout. ```APIDOC ## POST https://explodely.com/api/v1/aff ### Description Updates the commission percentage for a private affiliate payout associated with a specific product or all products. ### Method POST ### Endpoint https://explodely.com/api/v1/aff ### Parameters #### Request Body - **username** (string) - Required - Your Explodely account username - **apikey** (string) - Required - Your Explodely account API key - **apiaction** (string) - Required - Must be set to "editaffprivatepayout" - **affid** (string) - Required - The affiliate ID of the private payout to edit - **productid** (string) - Required - The exact product ID or "allproducts" - **comm** (number) - Required - The commission percentage (1-80) ### Response #### Success Response (200) - **private_payout_edited** (string) - Returns "ok" upon successful update #### Error Responses - **error** (string) - "invalidapikey" (Authentication failed) - **error** (string) - "invalid_sellerid" (Invalid username) - **error** (string) - "invalid_affcomm" (Invalid commission value) - **error** (string) - "invalid_private_payout" (Payout not found) ``` -------------------------------- ### SALE IPN Notification Source: https://docs.explodely.com/ipn-for-sellers/sale-ipn.md Details the parameters sent to the seller's IPN listener when a sale transaction occurs. ```APIDOC ## SALE IPN Notification ### Description Explodely.com sends a SALE type IPN to your registered IPN listener endpoint within a few minutes of a transaction. The payload contains details about the order, customer, and product. ### Parameters - **orderid** (string) - Order ID of the transaction - **type** (string) - Set to "sale" - **productId** (string) - Explodely Product ID - **productName** (string) - Name of the product - **customerName** (string) - Customer Full Name - **customerEmail** (string) - Customer Email - **customerPhone** (string) - Customer Phone Number - **affiliate** (string) - Affiliate ID (if applicable) - **amount** (string) - Amount of sale - **vat** (string) - Sales tax amount - **saletimedate** (string) - Sale Time & Date (HH:MM:SS DD-MMM-YYYY) - **saletimestamp** (string) - Machine timestamp - **zipcode** (string) - Customer ZIP Code - **country** (string) - 2 Digit ISO Country Code - **billdesc** (string) - Descriptor for customer charge - **custom1-5** (string) - Custom parameter values - **obselected** (string) - "yes" if order bump is selected - **ipadd** (string) - Customer IP address ### Rebill Parameters - **rebill** (string) - "yes" for rebill sales - **mainorderid** (string) - Order ID of the initial sale ### Physical Product Parameters - **shipfullname** (string) - Shipping Full Name - **shipaddress1** (string) - Shipping Street Address - **shipaddress2** (string) - Shipping Apt/Suite/Other - **shipcity** (string) - Shipping City - **shipstate** (string) - Shipping State - **shipcountry** (string) - Shipping Country Code (2 Digit ISO) - **shipzipcode** (string) - Shipping Address Zip Code ``` -------------------------------- ### Authentication Requirements Source: https://docs.explodely.com/api/authentication.md Explodely API requests require authentication via username and API key parameters. ```APIDOC ## Authentication ### Description To authenticate your access to the API, you must include your account credentials in your API requests. ### Parameters - **username** (string) - Required - Your Explodely account username. - **apikey** (string) - Required - The API key associated with your Explodely account. ``` -------------------------------- ### Refund IPN Notification Source: https://docs.explodely.com/ipn-for-sellers/refund-ipn.md Details the parameters sent to your IPN listener when a refund occurs. ```APIDOC ## Refund IPN Notification ### Description Explodely.com sends a POST request to your configured IPN listener when a transaction is refunded. The notification includes details about the original transaction and the refund amount. ### Parameters - **orderid** (string) - Order ID of the Explodely.com sale transaction - **type** (string) - Set to 'refund' - **productId** (string) - Explodely.com Product ID of the transaction - **customerName** (string) - Customer Full Name - **customerEmail** (string) - Customer Email - **customerPhone** (string) - Customer Phone Number - **affiliate** (string) - Explodely.com affiliate ID (if any) - **amount** (string) - Amount of refund (in negative) - **refundtimedate** (string) - Refund Time & Date In Format HH:MM:SS DD-MMM-YYYY - **refundtimestamp** (string) - Machine timestamp of refund - **zipcode** (string) - ZIP Code of a customer - **country** (string) - Country Code (2 Digit ISO) Of The Customer - **billdesc** (string) - Descriptor For The Customer Charge - **custom1** (string) - Custom parameter 1 value - **custom2** (string) - Custom parameter 2 value - **custom3** (string) - Custom parameter 3 value - **custom4** (string) - Custom parameter 4 value - **custom5** (string) - Custom parameter 5 value ``` -------------------------------- ### Pass TPA ID via HTML and JavaScript Source: https://docs.explodely.com/articles/third-party-affiliates-tpa.md Use JavaScript to capture a URL parameter and redirect the user to an Explodely payment link with the TPA ID appended. ```HTML Click Here To Pay
``` ```JavaScript ``` -------------------------------- ### Sale Webhook Data Payload Source: https://docs.explodely.com/webhooks/sale-webhook.md This webhook pushes specific data points to your configured webhook URL whenever a sale is generated. ```APIDOC ## Sale Webhook Data Points ### Description Explodely triggers this webhook when a sale is generated. The following data points are pushed to your configured webhook URL: - **Order ID** - Explodely Order ID of the sale - **Customer Name** - Name of customer - **Customer Email** - Email of customer - **Customer Phone** - Phone number of customer - **Amount** - Amount of the sale - **Product ID** - Product ID of the sale - **Product Name** - Product Name of the sale - **Tracking ID** - Tracking ID (if any associated with the sale) - **Affiliate** - Affiliate ID (if any associated with the sale) - **Zip Code** - ZIP code of the buyer - **Country Code** - Country code of the buyer - **Bill Description** - The charge descriptor on the buyers payment method - **IP Address** - IP of the buyer - **Order Bump Selected** - Set as "yes" if the sale has add on selected ``` -------------------------------- ### Rebill Webhook Data Points Source: https://docs.explodely.com/webhooks/rebill-webhook.md The following data points are pushed to your configured webhook URL when a rebill occurs. ```APIDOC ## Rebill Webhook Data ### Description This webhook event is triggered when a rebill is generated for any sale. The system pushes the following data points to the configured webhook URL. ### Data Points - **Order ID** (string) - The unique identifier of the rebill sale. - **Customer Name** (string) - The name of the buyer. - **Customer Email** (string) - The email address of the buyer. - **Customer Phone** (string) - The phone number of the buyer. - **Product ID** (string) - The unique identifier of the product associated with the rebill. - **Main Order ID** (string) - The original Explodely Order ID of the initial sale. ``` -------------------------------- ### Chargeback Webhook Data Payload Source: https://docs.explodely.com/webhooks/chargeback-webhook.md Details the data points sent by Explodely when a chargeback event is triggered. ```APIDOC ## Chargeback Webhook Payload ### Description This webhook is triggered when a chargeback is generated for a sale. Explodely pushes the following data points to your configured webhook URL. ### Data Points - **Order ID** (string) - Explodely order ID of the sale - **Customer Name** (string) - Buyer's name - **Customer Email** (string) - Buyer's email - **Customer Phone** (string) - Buyer's phone - **Amount** (number) - Sale amount - **Product ID** (string) - Product ID of the sale - **Product Name** (string) - Product name - **Tracking ID** (string) - Tracking ID of the sale (if any) - **Affiliate** (string) - Affiliate ID of the sale (if any) - **Zip Code** (string) - ZIP Code of buyer - **Country Code** (string) - Country code of buyer - **Bill Description** (string) - Descriptor on payment method of buyer - **IP Address** (string) - Buyer's IP address ``` -------------------------------- ### Refund Webhook Data Payload Source: https://docs.explodely.com/webhooks/refund-webhook.md Details regarding the data points pushed by the Explodely refund webhook when a refund occurs. ```APIDOC ## Refund Webhook Payload ### Description This webhook is triggered when a refund is generated in your account. Explodely pushes the following data points to your configured webhook URL. ### Data Points - **Order ID** (string) - Explodely order ID of the sale - **Customer Name** (string) - Buyer's name - **Customer Email** (string) - Buyer's email - **Customer Phone** (string) - Buyer's phone - **Amount** (number) - Refund amount - **Product ID** (string) - Product ID of the refund - **Product Name** (string) - Product name - **Tracking ID** (string) - Tracking ID of the sale (if any) - **Affiliate** (string) - Affiliate ID of the sale (if any) - **Zip Code** (string) - ZIP Code of buyer - **Country Code** (string) - Country code of buyer - **Bill Description** (string) - Descriptor on payment method of buyer - **IP Address** (string) - Buyer's IP address ``` -------------------------------- ### Rebill Cancel IPN Notification Source: https://docs.explodely.com/ipn-for-sellers/rebill-cancel-ipn.md Details the parameters sent in the POST request when a rebill is cancelled. ```APIDOC ## Rebill Cancel IPN Notification ### Description When a rebill is cancelled, the system sends a notification to your configured IPN refund URL (or main IPN URL if the refund URL is not set). ### Parameters - **mainorderid** (string) - The order ID of the initial/main rebill transaction. - **type** (string) - The notification type, which will be 'rebillcancel'. - **canceltimedate** (string) - The cancel time and date in the format HH:MM:SS DD-MMM-YYYY. - **canceltimestamp** (string) - The machine timestamp of the cancellation. ``` -------------------------------- ### Rebill Cancel Webhook Payload Source: https://docs.explodely.com/webhooks/rebill-cancel-webhook.md Details regarding the data points pushed to your webhook URL when a rebill is cancelled. ```APIDOC ## Rebill Cancel Webhook ### Description This webhook is triggered when a rebill is cancelled in your Explodely account. Explodely pushes the following data points to your configured webhook URL. ### Data Points - **Customer Name** - Buyer's Name - **Customer Email** - Buyer's Email - **Customer Phone** - Buyer's Phone - **Product ID** - Product ID of the rebill sale - **Main Order ID** - Explodely Order ID of the main (initial) rebill sale ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.