Partnero Example

### Partnero Universal Implementation Example with HTML Form Source: https://developers.partnero.com/guide/signup-tracking This example demonstrates the integration of the Partnero Universal snippet within an HTML page containing a sign-up form. It includes the necessary Partnero Universal setup script and a basic HTML form with fields for name, email, and password. The form submission will be tracked by Partnero. ```html Partnero Example ``` -------------------------------- ### Reject Lead Request Example (HTTP GET) Source: https://developers.partnero.com/reference/leads This example shows the HTTP GET request to reject a lead. It requires an 'id' as a query parameter. The response indicates the success or failure of the rejection, returning updated lead details. ```http GET https://api.partnero.com/v1/leads/reject?id=44 ``` -------------------------------- ### Convert Lead Request Example (HTTP GET) Source: https://developers.partnero.com/reference/leads This example shows the HTTP GET request to convert a lead. It requires an 'id' and 'commission_transaction_amount' as query parameters. The response indicates the success or failure of the conversion, returning updated lead details. ```http GET https://api.partnero.com/v1/leads/convert?id=44&commission_transaction_amount=100 ``` -------------------------------- ### Search Partners API Request Example Source: https://developers.partnero.com/reference/partners Examples of GET requests to search for partners using different query parameters like email, referral key, or partner ID. These requests are used to find specific partner records within the system. ```http GET https://api.partnero.com/v1/partners:search?email=john.doe@partnero.com GET https://api.partnero.com/v1/partners:search?key=ref_123 GET https://api.partnero.com/v1/partners:search?id=partner_123 ``` -------------------------------- ### GET Request for Listing Promotion Codes (HTTP) Source: https://developers.partnero.com/reference/promotion-codes This example shows the HTTP GET request to retrieve a list of all promotion codes. It includes the endpoint URL and potential query parameters for pagination. ```http GET https://api.partnero.com/v1/promotion-codes # Optional parameters: # limit: integer (1-250, default 15) # page: integer (default 1) ``` -------------------------------- ### JavaScript Signup Tracking Source: https://developers.partnero.com/guide/signup-tracking This JavaScript example demonstrates how to track customer signups and send data to Partnero using the `po` function, populating data from HTML form elements. ```APIDOC ## JavaScript Signup Tracking ### Description This JavaScript code snippet shows how to capture customer signup information from an HTML form and send it to Partnero using the `po` function. It prevents default form submission and uses the provided `po` method to send customer data. ### Method JavaScript (Client-side) ### Endpoint Not applicable (client-side script) ### Parameters This script interacts with HTML elements (`#form-example`, inputs with `name="name"` and `name="email"`) and uses a `po` function to send data. ### Request Example (This is a client-side script, not a direct API request example in the traditional sense. The `po` function call is the closest equivalent.) ```javascript document.addEventListener('DOMContentLoaded', function () { const form = document.getElementById('form-example'); if (form) { form.addEventListener('submit', function (event) { event.preventDefault(); const name = form.querySelector('input[name="name"]').value; const email = form.querySelector('input[name="email"]').value; if (email) { po('customers', 'signup', { data: { key: email, name: name, email: email } }); } }); } }); ``` ### Response (The response is handled by the `po` function and subsequent API call, not directly reflected in this client-side script.) ``` -------------------------------- ### Partnero API: Get Customer Referrals Response Example Source: https://developers.partnero.com/reference/referral-customers Example of a successful response when fetching a customer's referrals. It lists the referred customers with their details. ```json { "data": [ { "email": "bob.green@partnero.com", "created_at": "2025-05-09T17:44:15.000000Z", "updated_at": "2025-05-09T17:44:15.000000Z", "id": "customer_456", "name": "Bob", "surname": "Green", "approved": true, "status": "active", "custom_fields": [] }, ... ], "status": 1 } ``` -------------------------------- ### Send Signup Data to Partnero API (REST) Source: https://developers.partnero.com/guide/affiliate This example demonstrates how to send customer signup data to the Partnero API using a POST request. The payload includes partner key, customer key, email, and name. The 'partner.key' is essential for attribution and is retrieved from the 'partnero_partner' cookie. ```json { "partner": { "key": "UNIQUE_PARTNER_KEY" }, "key": "CUSTOMER_KEY", "email": "customer@partnero.com", "name": "Partnero" } ``` -------------------------------- ### GET /v1/leads/details Source: https://developers.partnero.com/reference/leads Retrieves basic details about a lead setup, including lead status, commission settings, and custom form fields. ```APIDOC ## GET /v1/leads/details ### Description Get basic details about a lead setup. At this endpoint you can get the basic information about a lead setup. This endpoint is used to get the lead status, commission settings for leads and eventually custom fields form. ### Method GET ### Endpoint https://api.partnero.com/v1/leads/details ### Parameters #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **data** (object) - Contains lead configuration details. - **leads_enabled** (string) - Indicates if leads are enabled. - **program_leads_commission_type** (string) - The type of commission applied to leads. - **leads_commission** (object) - Commission details for leads. - **currency** (string) - The currency of the commission. - **commission** (number) - The commission amount. - **commission_type** (string) - The type of commission (e.g., percent). - **leads_custom_form_fields** (array) - An array of custom fields for the lead form. - **id** (number) - The ID of the custom field. - **type** (string) - The type of the custom field (e.g., text, input, checkbox). - **title** (string) - The title of the custom field. - **text** (string) - Additional text or description for the field. - **description** (string|null) - A detailed description of the field. - **required** (boolean) - Whether the field is required. - **options** (array) - Options for select, radio, or checkbox fields. - **status** (number) - The status code of the response (1 indicates success). #### Response Example ```json { "data": { "leads_enabled": "true", "program_leads_commission_type": "follow_program_settings", "leads_commission": { "currency": "USD", "commission": 19, "commission_type": "percent" }, "leads_custom_form_fields": [ { "id": 88, "type": "text", "title": "", "text": "

Text custom field

", "description": null, "required": false, "options": [] }, { "id": 89, "type": "input", "title": "Input custom field", "text": "", "description": null, "required": true, "options": [] } ] }, "status": 1 } ``` ``` -------------------------------- ### Get Program Overview API Request Source: https://developers.partnero.com/reference/program This snippet shows the HTTP request to get the program overview. It uses the GET method on the /v1/program/overview endpoint. No specific request body or headers are required for this operation. ```HTTP GET https://api.partnero.com/v1/program/overview ``` -------------------------------- ### Partnero API GET Request Example: Get Customer's Balance Source: https://developers.partnero.com/reference/referral-transactions This example demonstrates how to make a GET request to retrieve a specific customer's balance using their unique identifier. It shows the endpoint URL structure. ```http GET https://api.partnero.com/v1/customers/customer_123/balance ``` -------------------------------- ### List of Customers Response Example Source: https://developers.partnero.com/reference/referral-customers Provides an example of the response structure when retrieving a list of customers. Includes the `data` array containing customer objects, along with pagination links and metadata. ```JSON { "data": [ { "email": "alice.brown@partnero.com", "created_at": "2025-05-09T17:42:13.000000Z", "updated_at": "2025-05-09T17:42:13.000000Z", "id": "customer_123", "name": "Alice", "surname": "Brown", "approved": true, "status": "active", "custom_fields": [] }, { "email": "bob.green@partnero.com", "created_at": "2025-05-09T17:44:15.000000Z", "updated_at": "2025-05-09T17:44:15.000000Z", "id": "customer_456", "name": "Bob", "surname": "Green", "approved": true, "status": "active", "custom_fields": [] } ], "links": { "first": "https://api.partnero.com/v1/customers?page=1", "last": null, "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "path": "https://api.partnero.com/v1/customers", "per_page": 10, "to": 2 }, "status": 1 } ``` -------------------------------- ### Search Subscriber by Email (HTTP Request Example) Source: https://developers.partnero.com/reference/subscribers Example of an HTTP GET request to search for a subscriber using their email address. This endpoint allows filtering subscribers based on provided query parameters. ```http GET https://api.partnero.com/v1/subscribers:search?email=ross.geller@partnero.com ``` -------------------------------- ### Partnero Universal JavaScript Snippet Source: https://developers.partnero.com/guide/referral Install this snippet on your website to track referral visits, set cookies, and attribute signups correctly. It should be placed just before the closing `` tag. ```APIDOC ## Partnero Universal JavaScript Snippet ### Description This script enables Partnero to track referral visits and signups on your website, ensuring accurate attribution of referred users. ### Usage Paste this snippet into your website's HTML just before the closing `` tag. ### Code Example ```html ``` ``` -------------------------------- ### Partnero API: Get Customer Transactions Response Example Source: https://developers.partnero.com/reference/referral-customers Example of a successful response for customer transactions. Includes transaction details such as key, action, amount, and timestamps. ```json { "data": [ { "key": "transaction_456_1", "action": "sale", "amount": 99.99, "customer": "customer_123", "referred_customer": "customer_456", "credit": false, "is_currency": false, "amount_units": null, "created_at": "2025-05-12T15:43:55.000000Z", "deleted_at": null, "rewards": [] }, ... ], "status": 1 } ``` -------------------------------- ### GET /v1/customers/{id}/balance Source: https://developers.partnero.com/guide/referral Retrieves the balance information for a specific customer. Requires the customer's unique ID. ```APIDOC ## GET /v1/customers/{id}/balance ### Description Retrieves the balance information for a specific customer. Requires the customer's unique ID. ### Method GET ### Endpoint https://api.partnero.com/v1/customers/(:id)/balance ### Parameters #### Path Parameters - **id** (string) - Required - Must provide unique customer identifier. ### Response #### Success Response (200) - **data** (object) - Contains customer and balance details. - **customer** (object) - Details of the customer. - **email** (string) - Customer's email address. - **created_at** (string) - Timestamp of customer creation. - **updated_at** (string) - Timestamp of last customer update. - **name** (string) - Customer's name. - **key** (string) - Customer's unique referral key. - **status** (string) - Customer's status (e.g., 'active'). - **referring_customer** (object|null) - Information about the referring customer. - **referrals_count** (integer) - The number of referrals made by this customer. - **metadata** (object) - Custom metadata associated with the customer. - **date_of_birth** (string) - Customer's date of birth in `YYYY-MM-DD` format. - **balance** (array) - An array representing the customer's balance. The structure of elements within this array is not specified in the provided text. - **status** (integer) - API status indicator (e.g., 1 for success). #### Response Example ```json { "data": { "customer": { "email": "gediminas@partnero.com", "created_at": "2023-05-19T09:04:33.000000Z", "updated_at": "2023-05-19T09:04:33.000000Z", "name": "Customer", "key": "referring_customer", "status": "active", "referring_customer": null, "referrals_count": 1, "metadata": { "date_of_birth": "1993-05-19" } }, "balance": [] }, "status": 1 } ``` ``` -------------------------------- ### Partnero Universal JavaScript Snippet for Tracking Source: https://developers.partnero.com/guide/affiliate Install the Partnero Universal JavaScript snippet on your website to track referral visits and signups, attributing them to the correct partners. ```APIDOC ## Install Partnero Universal JS Snippet ### Description Embed the Partnero Universal JavaScript snippet into your website's HTML to track referral links and set cookies for partner attribution. ### Method Client-side JavaScript ### Endpoint Not Applicable (Embedded in HTML) ### Request Example ```html ``` ### Response - Sets `partnero_partner` cookie with `UNIQUE_PARTNER_KEY` when a user visits with a referral URL (e.g., `yourwebsite.com?aff=UNIQUE_PARTNER_KEY`). ``` -------------------------------- ### Customer Data Response Example Source: https://developers.partnero.com/reference/referral-customers Illustrates the structure of a customer data object as returned by the API, including fields like email, name, ID, status, and referral information. This example shows a customer who is not a referring customer. ```JSON { "data": { "email": "alice.brown@partnero.com", "created_at": "2025-05-09T17:42:13.000000Z", "updated_at": "2025-05-09T17:42:13.000000Z", "name": "Alice", "id": "customer_123", "surname": "Brown", "tos": true, "approved": true, "status": "active", "custom_fields": [], "referring_customer": null, "referrals_count": 0, "metadata": { "date_of_birth": null }, "referral_link": "https://partnero.com?ref=ref_123", "referral_links": [ "https://partnero.com?ref=ref_123" ] }, "status": 1 } ``` -------------------------------- ### Partnero API: Customer Search Response Example Source: https://developers.partnero.com/reference/referral-customers Example of a successful response when searching for customers. It includes customer data, pagination links, and metadata. ```json { "data": [ { "email": "alice.brown@partnero.com", "created_at": "2025-05-09T17:42:13.000000Z", "updated_at": "2025-05-09T17:42:13.000000Z", "id": "customer_123", "name": "Alice", "surname": "Brown", "approved": true, "status": "active", "custom_fields": [] } ], "links": { "first": "https://api.partnero.com/v1/customers:search?page=1", "last": null, "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "path": "https://api.partnero.com/v1/customers:search", "per_page": 10, "to": 1 }, "status": 1 } ``` -------------------------------- ### Archive Partner API Request Example Source: https://developers.partnero.com/reference/partners Example of a POST request to archive an existing partner. The request targets the partner's ID in the URL. This action moves the partner to an archived state. ```http POST https://api.partnero.com/v1/partners/partner_123/archive ``` -------------------------------- ### GET /v1/customers/{id} Source: https://developers.partnero.com/guide/referral Fetches the details of a specific customer. You need to provide either the customer's unique ID or their unique key to retrieve their information. ```APIDOC ## GET /v1/customers/{id} ### Description Fetches the details of a specific customer. You need to provide either the customer's unique ID or their unique key to retrieve their information. ### Method GET ### Endpoint https://api.partnero.com/v1/customers/(:id) ### Parameters #### Path Parameters - **id** (string) - Required - Must provide unique customer identifier. ### Response #### Success Response (200) - **data** (object) - Contains the customer details. - **email** (string) - Customer's email address. - **created_at** (string) - Timestamp of customer creation. - **updated_at** (string) - Timestamp of last customer update. - **name** (string) - Customer's name. - **key** (string) - Customer's unique referral key. - **status** (string) - Customer's status (e.g., 'active'). - **referring_customer** (object|null) - Information about the referring customer, or null if none. - **referrals_count** (integer) - The number of referrals made by this customer. - **metadata** (object) - Custom metadata associated with the customer. - **date_of_birth** (string) - Customer's date of birth in `YYYY-MM-DD` format. - **status** (integer) - API status indicator (e.g., 1 for success). #### Response Example ```json { "data": { "email": "customer@partnero.com", "created_at": "2023-05-19T09:04:33.000000Z", "updated_at": "2023-05-19T09:04:33.000000Z", "name": "Customer", "key": "referring_customer", "status": "active", "referring_customer": null, "referrals_count": 1, "metadata": { "date_of_birth": "1993-05-19" } }, "status": 1 } ``` ``` -------------------------------- ### GET /v1/program/overview Source: https://developers.partnero.com/reference/referral-program Retrieves a comprehensive overview of the program, including key performance indicators and program details. ```APIDOC ## GET /v1/program/overview ### Description Retrieves a comprehensive overview of the program, including key performance indicators and program details such as total customers, sales, revenue, and participation rates. ### Method GET ### Endpoint https://api.partnero.com/v1/program/overview ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **status** (integer) - Indicates the success of the API call. - **data** (object) - Contains the program overview details. - **program** (object) - Details about the program itself. - **id** (integer) - The internal ID of the program. - **public_id** (string) - The public identifier for the program. - **website** (string) - The website associated with the program. - **initial** (string) - An initial code or identifier for the program. - **type** (string) - The type of program (e.g., "Referral"). - **name** (string) - The name of the program. - **created_at** (string) - The date the program was created (YYYY-MM-DD). - **last_edited** (string) - The date the program was last edited (YYYY-MM-DD). - **active_rewards** (integer) - The number of currently active rewards. - **total_customers** (integer) - The total number of customers. - **total_customers_before** (integer) - The total number of customers before the current period. - **total_customers_growth** (integer) - The growth percentage in total customers. - **total_referring_customers** (integer) - The total number of referring customers. - **total_referring_customers_before** (integer) - The total number of referring customers before the current period. - **total_referring_customers_growth** (integer) - The growth percentage in total referring customers. - **total_referred_customers** (integer) - The total number of referred customers. - **total_referred_customers_before** (integer) - The total number of referred customers before the current period. - **total_referred_customers_growth** (integer) - The growth percentage in total referred customers. - **total_sales** (integer) - The total number of sales. - **total_sales_before** (integer) - The total number of sales before the current period. - **total_sales_growth** (integer) - The growth percentage in total sales. - **participation** (number) - The current participation rate. - **participation_before** (number) - The participation rate before the current period. - **participation_growth** (number) - The growth percentage in participation. - **total_revenue_from_sales** (object) - The total revenue generated from sales. - **usd** (string) - The total revenue in USD (e.g., "$411.97"). #### Response Example { "status": 1, "data": { "program": { "id": 1, "public_id": "MOBTGEKX", "website": "https://example.com", "initial": "A0", "type": "Referral", "name": "Api Test 001", "created_at": "2025-04-30", "last_edited": "2025-04-30" }, "active_rewards": 2, "total_customers": 4, "total_customers_before": 4, "total_customers_growth": 0, "total_referring_customers": 1, "total_referring_customers_before": 1, "total_referring_customers_growth": 0, "total_referred_customers": 3, "total_referred_customers_before": 3, "total_referred_customers_growth": 0, "total_sales": 3, "total_sales_before": 3, "total_sales_growth": 0, "participation": 25, "participation_before": 25, "participation_growth": 0, "total_revenue_from_sales": { "usd": "$411.97" } } } ``` ``` -------------------------------- ### Handle Not Found Response (HTTP Example) Source: https://developers.partnero.com/reference/subscribers Example of an HTTP response indicating that a requested resource was not found. This typically occurs when trying to access a subscriber that does not exist. ```http Response Code: 404 Not Found ``` -------------------------------- ### GET /v1/program Source: https://developers.partnero.com/reference/nrp-program Fetches the overview of a specific program. ```APIDOC ## GET /v1/program ### Description Get program overview. ### Method GET ### Endpoint https://api.partnero.com/v1/program ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **data** (object) - Contains program details. - **id** (string) - Unique identifier for the program. - **name** (string) - Name of the program. - **esp_type** (string) - Type of the ESP (External Service Provider). - **esp_type_name** (string) - Display name of the ESP type. - **total_subscribers** (integer) - Total number of subscribers for the program. - **total_referring** (integer) - Total number of referring users. - **total_referred** (integer) - Total number of referred users. - **created_at** (string) - Timestamp when the program was created. - **status** (integer) - Indicates the success of the operation (1 for success). #### Response Example { "data": { "id": "HTA1FEFM", "name": "Api Test 001", "esp_type": "custom", "esp_type_name": "Custom", "total_subscribers": 1, "total_referring": 0, "total_referred": 0, "created_at": "2025-04-30T15:15:12.000000Z" }, "status": 1 } ``` -------------------------------- ### Partnero API Single Transaction JSON Example Source: https://developers.partnero.com/guide/affiliate Example JSON payload for creating a single sales transaction in Partnero. Includes essential fields like customer key, transaction key, amount, product details, and action type. ```JSON { "customer": { "key": "CUSTOMER_KEY" }, "key": "transaction_123", "amount": 99.99, "product_id": "prod_123", "product_type": "monthly", "action": "sale" } ``` -------------------------------- ### Fetch Single Transaction API Request Example (HTTP) Source: https://developers.partnero.com/reference/transactions This is an example of an HTTP GET request to fetch a single transaction using its unique key. The `{key}` placeholder should be replaced with the actual transaction identifier. ```http GET https://api.partnero.com/v1/transactions/{key} # Request example GET https://api.partnero.com/v1/transactions/transaction_123 ``` -------------------------------- ### Create Lead Request Body Example Source: https://developers.partnero.com/reference/leads An example JSON payload for creating a new lead. It includes the lead's 'name' and 'email', a 'partner' object with the partner's key, and a 'cfields' object containing values for custom form fields, identified by their respective IDs. This demonstrates the required structure for lead creation requests. ```json { "name": "Alice Brown", "email": "alice.brown@partnero.com", "partner": { "key": "ref_123" }, "cfields": { "89": "Explicabo Porro dol 11", "90": "Ratione praesentium 11", "91": [ "chbx1", "chbx3" ], "92": "radio2", "93": "select1", "94": "HR" } } ``` -------------------------------- ### Search Subscriber Response Example (HTTP) Source: https://developers.partnero.com/reference/subscribers Example of a successful HTTP response when searching for a subscriber. The response body contains the subscriber's details if found, along with pagination and meta information. ```http Response Code: 200 OK { "data": [ { "id": "ross.geller@partnero.com", "name": "Ross Geller", "email": "ross.geller@partnero.com", "is_referred": false, "tos": true, "marketing_consent": true, "status": "Active", "approved": true, "portal_link": "https://partnero.referral.site/portal/JwSK/gwLwK/8f8crG6gcoaRHgQO", "share_link": "https://partnero.referral.site/share/gwLwK/JvdC1", "referrals_count": 0, "reward": [], "created_at": "2025-05-12T22:03:20.000000Z", "updated_at": "2025-05-12T22:03:22.000000Z", "deleted_at": null } ], "links": { "first": "https://api.partnero.com/v1/subscribers:search?page=1", "last": null, "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "path": "https://api.partnero.com/v1/subscribers:search", "per_page": 10, "to": 1 }, "status": 1 } ``` -------------------------------- ### Get Lead Details API Endpoint Source: https://developers.partnero.com/reference/leads Retrieves basic details about a lead setup, including lead status, commission settings, and custom form fields. This endpoint requires no request body and returns a JSON object containing lead configuration data. It's useful for understanding the current lead setup and available custom fields. ```http GET https://api.partnero.com/v1/leads/details ``` -------------------------------- ### Fetch Coupon API Example Request Source: https://developers.partnero.com/reference/coupons This snippet provides an example of how to fetch a specific coupon by replacing the {uuid_code} placeholder with the actual coupon identifier in the URL. ```http GET https://api.partnero.com/v1/coupons/coupon_123 ``` -------------------------------- ### GET /v1/customers/{id}/referrals Source: https://developers.partnero.com/guide/referral Retrieves a list of referrals made by a specific customer. Requires the customer's unique ID. ```APIDOC ## GET /v1/customers/{id}/referrals ### Description Retrieves a list of referrals made by a specific customer. Requires the customer's unique ID. ### Method GET ### Endpoint https://api.partnero.com/v1/customers/(:id)/referrals ### Parameters #### Path Parameters - **id** (string) - Required - Must provide unique customer identifier. ### Response #### Success Response (200) - **data** (array) - An array of referral objects. - Each object contains: - **email** (string) - Email of the referred customer. - **created_at** (string) - Timestamp of referral creation. - **updated_at** (string) - Timestamp of last referral update. - **key** (string) - Unique key of the referred customer. - **name** (string) - Name of the referred customer. - **status** (string) - Status of the referred customer (e.g., 'active'). - **status** (integer) - API status indicator (e.g., 1 for success). #### Response Example ```json { "data": [ { "email": "referred-customer-3@partnero.com", "created_at": "2023-05-19T09:04:51.000000Z", "updated_at": "2023-05-19T09:04:51.000000Z", "key": "referred_customer_3", "name": "Referred customer", "status": "active" }, { "email": "referred-customer-4@partnero.com", "created_at": "2023-05-19T09:15:05.000000Z", "updated_at": "2023-05-19T09:15:05.000000Z", "key": "referred_customer_4", "name": "Referred customer", "status": "active" } ], "status": 1 } ``` ``` -------------------------------- ### GET /v1/program/overview Source: https://developers.partnero.com/reference/program Retrieves the overview of the program, including various statistics like total partners, total purchases, total signups, and reward/revenue information. It also includes current program settings. ```APIDOC ## GET /v1/program/overview ### Description Retrieves the overview of the program, including various statistics like total partners, total purchases, total signups, and reward/revenue information. It also includes current program settings. ### Method GET ### Endpoint https://api.partnero.com/v1/program/overview ### Parameters #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **status** (integer) - Indicates the status of the request (e.g., 1 for success). - **data** (object) - Contains the program overview data. - **program** (object) - Details about the program itself. - **id** (integer) - The internal ID of the program. - **public_id** (string) - The public identifier for the program. - **website** (string) - The website associated with the program. - **initial** (string) - An initial or code for the program. - **type** (string) - The type of the program (e.g., "Affiliate"). - **name** (string) - The name of the program. - **created_at** (string) - The date the program was created. - **last_edited** (string) - The date the program was last edited. - **total_partners** (string) - The total number of partners. - **total_partners_growth** (integer) - The growth rate of total partners. - **total_purchases** (string) - The total number of purchases. - **total_purchases_growth** (integer) - The growth rate of total purchases. - **total_signups** (string) - The total number of signups. - **total_signups_growth** (integer) - The growth rate of total signups. - **total_paid_accounts** (string) - The total number of paid accounts. - **total_paid_accounts_growth** (integer) - The growth rate of total paid accounts. - **total_reward** (object) - The total reward amount. - **usd** (string) - The total reward in USD. - **total_reward_growth** (integer) - The growth rate of total reward. - **total_revenue** (object) - The total revenue amount. - **usd** (string) - The total revenue in USD. - **total_revenue_growth** (integer) - The growth rate of total revenue. - **affiliate_referred_visitors_clicks** (string) - Number of clicks from referred visitors. - **affiliate_referred_visitors_clicks_growth** (integer) - Growth rate of referred visitor clicks. - **click_to_signup_conversion** (string) - The conversion rate from click to signup. - **click_to_signup_conversion_growth** (integer) - Growth rate of click to signup conversion. - **signup_to_sale_conversion** (string) - The conversion rate from signup to sale. - **signup_to_sale_conversion_growth** (integer) - Growth rate of signup to sale conversion. - **total_paid** (array) - Array of total paid amounts (format may vary). - **total_pending** (array) - Array of total pending amounts (format may vary). - **overview_program_current_settings** (object) - Current settings for the program overview. - **commission_description** (string) - Description of the commission structure. - **program_name** (string) - The name of the program. - **program_initials** (string) - Initials or code for the program. - **program_type_title** (string) - The title of the program type. - **partner_portal_url** (string) - URL for the partner portal. - **currency** (string) - The currency used. - **cookie_lifetime** (string) - The cookie lifetime in days. - **payout_threshold** (integer) - The payout threshold amount. #### Response Example ```json { "status": 1, "data": { "program": { "id": 1, "public_id": "MOBTGEKX", "website": "https://example.com", "initial": "A0", "type": "Affiliate", "name": "Api Test 001", "created_at": "2025-04-30", "last_edited": "2025-04-30" }, "total_partners": "3", "total_partners_growth": 0, "total_purchases": "10", "total_purchases_growth": 0, "total_signups": "3", "total_signups_growth": 0, "total_paid_accounts": "3", "total_paid_accounts_growth": 0, "total_reward": { "usd": "$337.47" }, "total_reward_growth": 0, "total_revenue": { "usd": "$1,124.90" }, "total_revenue_growth": 0, "affiliate_referred_visitors_clicks": "0", "affiliate_referred_visitors_clicks_growth": 0, "click_to_signup_conversion": "0", "click_to_signup_conversion_growth": 0, "signup_to_sale_conversion": "100", "signup_to_sale_conversion_growth": 0, "total_paid": [ "0" ], "total_pending": [ "0" ], "overview_program_current_settings": { "commission_description": "30%, lifetime", "program_name": "Api Test 001", "program_initials": "A0", "program_type_title": "Affiliate", "partner_portal_url": "https://apitest001.partneroapp.site", "currency": "USD", "cookie_lifetime": "7", "payout_threshold": 0 } } } ``` ``` -------------------------------- ### Partnero API Multiple Transactions JSON Example Source: https://developers.partnero.com/guide/affiliate Example JSON payload for creating multiple sales transactions in Partnero within a single request. This is useful for batch processing sales data. ```JSON { "customer": { "key": "CUSTOMER_KEY" }, "transactions": [ { "key": "transaction_123", "amount": 99.99, "action": "sale" }, { "key": "transaction_456", "amount": 199.99, "action": "sale" } ] } ``` -------------------------------- ### Partnero API: Create Transaction Request Example (With Customer Create) Source: https://developers.partnero.com/guide/transaction-tracking This example demonstrates creating a transaction and a new customer simultaneously using the Partnero API. It utilizes the 'create_customer' option and specifies partner details for customer creation. ```json { "key": "transaction_123", "amount": 99.99, "product_id": "prod_123", // optional "product_type": "monthly", // optional "action": "sale", "options": { "create_customer": true // use this option to create a customer and a transaction at the same time }, "customer": { "key": "CUSTOMER_KEY" "partner": { "id": "UNIQUE_PARTNER_ID" // use this option to create a customer and a transaction at the same time } }, } ``` -------------------------------- ### Customer Data with Referring Customer Example Source: https://developers.partnero.com/reference/referral-customers Demonstrates the customer data structure when a customer has a referring customer. The `referring_customer` field will contain the details of the customer who referred them. ```JSON { "data": { "email": "bob.green@partnero.com", "created_at": "2025-05-09T17:44:15.000000Z", "updated_at": "2025-05-09T17:44:15.000000Z", "name": "Bob", "id": "customer_456", "surname": "Green", "tos": true, "approved": true, "status": "active", "custom_fields": [], "referring_customer": { "email": "alice.brown@partnero.com", "created_at": "2025-05-09T17:42:13.000000Z", "updated_at": "2025-05-09T17:42:13.000000Z", "name": "Alice", "id": "customer_123", "surname": "Brown", "tos": true, "approved": true, "status": "active", "custom_fields": [], "referring_customer": null, "referrals_count": 1, "metadata": { "date_of_birth": null } }, "referrals_count": 0, "metadata": { "date_of_birth": null }, "referral_link": "https://partnero.com?ref=ref_456", "referral_links": [ "https://partnero.com?ref=ref_456" ] }, "status": 1 } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.