### Commission Rate Setup Endpoints Source: https://api.goaffpro.com/docs/admin Access to commission rate setup on products and collections. ```APIDOC ## GET /admin/commissions ### Description Returns a list of all the special commission rates. ### Method GET ### Endpoint /admin/commissions ``` ```APIDOC ## POST /admin/commissions ### Description Adds a special commission rate to the commission plan. ### Method POST ### Endpoint /admin/commissions ``` ```APIDOC ## DELETE /admin/commissions/{id} ### Description Deletes the special commission rates from the commission plan. ### Method DELETE ### Endpoint /admin/commissions/{id} ``` ```APIDOC ## GET /admin/commissions/collections ### Description Retrieves a list of collections present in the store. ### Method GET ### Endpoint /admin/commissions/collections ``` ```APIDOC ## GET /admin/commissions/products ### Description Retrieves a list of products present in the store (up to 250 results). ### Method GET ### Endpoint /admin/commissions/products ``` -------------------------------- ### Config API Source: https://api.goaffpro.com/docs/admin Endpoints for accessing and managing store configuration. ```APIDOC ## GET /admin/store/config ### Description Access to store configuration. ### Method GET ### Endpoint /admin/store/config ``` ```APIDOC ## PATCH /admin/store/config ### Description Update store configuration. ### Method PATCH ### Endpoint /admin/store/config ``` ```APIDOC ## GET /admin/store/upgrade ### Description To upgrade the app to a subscription plan. ### Method GET ### Endpoint /admin/store/upgrade ``` ```APIDOC ## GET /admin/store/logs ### Description Get admin event logs. ### Method GET ### Endpoint /admin/store/logs ``` -------------------------------- ### SDK API Source: https://api.goaffpro.com/docs/admin Endpoints for public SDK access, requiring an x-goaffpro-public-token header. ```APIDOC ## GET /sdk/affiliate ### Description Access public affiliate endpoints. ### Method GET ### Endpoint /sdk/affiliate ``` ```APIDOC ## GET /sdk/affiliates ### Description Access public affiliates endpoints. ### Method GET ### Endpoint /sdk/affiliates ``` ```APIDOC ## POST /sdk/track/visit ### Description Track a user visit. ### Method POST ### Endpoint /sdk/track/visit ``` ```APIDOC ## POST /sdk/track/conversion ### Description Track a conversion. ### Method POST ### Endpoint /sdk/track/conversion ``` ```APIDOC ## POST /sdk/track/lead ### Description Track a lead. ### Method POST ### Endpoint /sdk/track/lead ``` ```APIDOC ## POST /sdk/user/login ### Description Log in to the affiliate account for the access token. ### Method POST ### Endpoint /sdk/user/login ``` ```APIDOC ## POST /sdk/user/register ### Description Sign up for a new user account in the program. ### Method POST ### Endpoint /sdk/user/register ``` ```APIDOC ## POST /sdk/user/forgot-password ### Description Sends a password reset email to the affiliate account. ### Method POST ### Endpoint /sdk/user/forgot-password ``` ```APIDOC ## POST /sdk/user/send-verification-email ### Description Sends verification link to the affiliate for verification of their email address. ### Method POST ### Endpoint /sdk/user/send-verification-email ``` ```APIDOC ## POST /sdk/user/reset-password ### Description Resets the password of the affiliate based on the supplied token. ### Method POST ### Endpoint /sdk/user/reset-password ``` ```APIDOC ## POST /sdk/user/update-password ### Description Resets the password of the affiliate based on the supplied old password. ### Method POST ### Endpoint /sdk/user/update-password ``` ```APIDOC ## GET /sdk/user ### Description Get information about logged in affiliate's profile. ### Method GET ### Endpoint /sdk/user ``` ```APIDOC ## POST /sdk/user ### Description Update the affiliate's profile. ### Method POST ### Endpoint /sdk/user ``` ```APIDOC ## GET /sdk/user/stats/aggregate ### Description Aggregates of user stats. ### Method GET ### Endpoint /sdk/user/stats/aggregate ``` ```APIDOC ## GET /sdk/user/feed/orders ### Description Feed of user orders. ### Method GET ### Endpoint /sdk/user/feed/orders ``` ```APIDOC ## GET /sdk/user/feed/payouts ### Description Feed of user payouts. ### Method GET ### Endpoint /sdk/user/feed/payouts ``` ```APIDOC ## GET /sdk/user/feed/products ### Description Feed of products available for promotion. It can take upto 24 hours for the feed of newly enrolled stores to become available to the affiliate. ### Method GET ### Endpoint /sdk/user/feed/products ``` ```APIDOC ## GET /sdk/user/feed/rewards ### Description Feed of user rewards. ### Method GET ### Endpoint /sdk/user/feed/rewards ``` ```APIDOC ## GET /sdk/user/feed/traffic ### Description Feed of user traffic. ### Method GET ### Endpoint /sdk/user/feed/traffic ``` ```APIDOC ## GET /sdk/user/feed/transactions ### Description Feed of user transactions. ### Method GET ### Endpoint /sdk/user/feed/transactions ``` ```APIDOC ## GET /sdk/user/payouts/pending ### Description Get pending payout amount (and its breakdown). ### Method GET ### Endpoint /sdk/user/payouts/pending ``` ```APIDOC ## GET /sdk/user/creatives ### Description Get creatives uploaded by the admin. ### Method GET ### Endpoint /sdk/user/creatives ``` ```APIDOC ## GET /sdk/user/commissions ### Description Get user's commission structure. ### Method GET ### Endpoint /sdk/user/commissions ``` -------------------------------- ### Connection Management Endpoints Source: https://api.goaffpro.com/docs/admin Connections between affiliate and customers for giving perpetual commission to the affiliate for the customer's orders. ```APIDOC ## GET /admin/connections ### Description Lists connections between affiliates and customers. ### Method GET ### Endpoint /admin/connections ``` ```APIDOC ## POST /admin/connections ### Description Creates a new connection between an affiliate and a customer. ### Method POST ### Endpoint /admin/connections ``` ```APIDOC ## DELETE /admin/connections/{id} ### Description Deletes a connection. ### Method DELETE ### Endpoint /admin/connections/{id} ``` -------------------------------- ### Creative Management Endpoints (Deprecated) Source: https://api.goaffpro.com/docs/admin [DEPRECATED] Access to media assets uploaded in the admin panel. Use the /admin/assets endpoints instead. ```APIDOC ## GET /admin/creatives ### Description Lists media assets uploaded in the Creatives section of the admin panel. ### Method GET ### Endpoint /admin/creatives ``` ```APIDOC ## POST /admin/creatives/preSignedUrl ### Description Returns a pre-signed URL to upload a media asset. ### Method POST ### Endpoint /admin/creatives/preSignedUrl ``` -------------------------------- ### Affiliate Management Endpoints Source: https://api.goaffpro.com/docs/admin Admin access to affiliates on your program. ```APIDOC ## GET /admin/affiliates ### Description Lists all affiliates. ### Method GET ### Endpoint /admin/affiliates ``` ```APIDOC ## POST /admin/affiliates ### Description Creates a new affiliate. ### Method POST ### Endpoint /admin/affiliates ``` ```APIDOC ## GET /admin/affiliates/search ### Description Searches for affiliates. ### Method GET ### Endpoint /admin/affiliates/search ``` ```APIDOC ## DELETE /admin/affiliates/{id} ### Description Deletes an affiliate by ID. ### Method DELETE ### Endpoint /admin/affiliates/{id} ``` ```APIDOC ## PATCH /admin/affiliates/{id} ### Description Updates an affiliate by ID. ### Method PATCH ### Endpoint /admin/affiliates/{id} ``` ```APIDOC ## GET /admin/affiliates/{id}/commissions ### Description Retrieves commissions for a specific affiliate. ### Method GET ### Endpoint /admin/affiliates/{id}/commissions ``` ```APIDOC ## GET /admin/affiliates/{id}/coupons ### Description Retrieves coupons for a specific affiliate. ### Method GET ### Endpoint /admin/affiliates/{id}/coupons ``` ```APIDOC ## POST /admin/affiliates/{id}/coupons ### Description Creates a coupon for a specific affiliate. ### Method POST ### Endpoint /admin/affiliates/{id}/coupons ``` ```APIDOC ## DELETE /admin/affiliates/{id}/coupons/{coupon_code} ### Description Deletes a coupon for a specific affiliate. ### Method DELETE ### Endpoint /admin/affiliates/{id}/coupons/{coupon_code} ``` ```APIDOC ## GET /admin/affiliates/{id}/referral_codes ### Description Retrieves referral codes for a specific affiliate. ### Method GET ### Endpoint /admin/affiliates/{id}/referral_codes ``` ```APIDOC ## PUT /admin/affiliates/{id}/referral_codes ### Description Updates referral codes for a specific affiliate. ### Method PUT ### Endpoint /admin/affiliates/{id}/referral_codes ``` ```APIDOC ## POST /admin/affiliates/{id}/referral_codes ### Description Creates a referral code for a specific affiliate. ### Method POST ### Endpoint /admin/affiliates/{id}/referral_codes ``` ```APIDOC ## DELETE /admin/affiliates/{id}/referral_codes/{referral_code} ### Description Deletes a referral code for a specific affiliate. ### Method DELETE ### Endpoint /admin/affiliates/{id}/referral_codes/{referral_code} ``` ```APIDOC ## GET /admin/affiliates/{id}/tags ### Description Retrieves tags for a specific affiliate. ### Method GET ### Endpoint /admin/affiliates/{id}/tags ``` ```APIDOC ## PUT /admin/affiliates/{id}/tags ### Description Updates tags for a specific affiliate. ### Method PUT ### Endpoint /admin/affiliates/{id}/tags ``` -------------------------------- ### Assets API Source: https://api.goaffpro.com/docs/admin Endpoints for managing the file asset library, including folders, files, and metadata. ```APIDOC ## GET /admin/assets/folders ### Description List all folders and storage stats. ### Method GET ### Endpoint /admin/assets/folders ``` ```APIDOC ## GET /admin/assets/item/{itemId} ### Description Get a single asset by ID. ### Method GET ### Endpoint /admin/assets/item/{itemId} ``` ```APIDOC ## GET /admin/assets/contents ### Description List assets in the root folder. ### Method GET ### Endpoint /admin/assets/contents ``` ```APIDOC ## GET /admin/assets/contents/{folderId} ### Description List assets inside a specific folder. ### Method GET ### Endpoint /admin/assets/contents/{folderId} ``` ```APIDOC ## POST /admin/assets ### Description Create or update an asset record. ### Method POST ### Endpoint /admin/assets ``` ```APIDOC ## POST /admin/assets/download ### Description Generate a download URL for one or more assets (zipped). ### Method POST ### Endpoint /admin/assets/download ``` ```APIDOC ## POST /admin/assets/delete ### Description Delete one or more assets. ### Method POST ### Endpoint /admin/assets/delete ``` ```APIDOC ## POST /admin/assets/move ### Description Move assets to a different folder. ### Method POST ### Endpoint /admin/assets/move ``` -------------------------------- ### User Endpoints Source: https://api.goaffpro.com/docs/admin API Endpoints for affiliates to use. ```APIDOC ## POST /user/login ### Description Logs in to get the access token. ### Method POST ### Endpoint /user/login ``` ```APIDOC ## GET /user/sites ### Description Lists stores the user is enrolled in. ### Method GET ### Endpoint /user/sites ``` ```APIDOC ## GET /user ### Description Gets information about the logged-in user profile. ### Method GET ### Endpoint /user ``` ```APIDOC ## POST /user ### Description Updates the user profile. ### Method POST ### Endpoint /user ``` ```APIDOC ## GET /user/stats/aggregate ### Description Aggregates user statistics. ### Method GET ### Endpoint /user/stats/aggregate ``` ```APIDOC ## GET /user/feed/orders ### Description Retrieves a feed of user orders. ### Method GET ### Endpoint /user/feed/orders ``` ```APIDOC ## GET /user/feed/payouts ### Description Retrieves a feed of user payouts. ### Method GET ### Endpoint /user/feed/payouts ``` ```APIDOC ## GET /user/feed/products ### Description Retrieves a feed of products available for promotion. ### Method GET ### Endpoint /user/feed/products ``` ```APIDOC ## GET /user/feed/rewards ### Description Retrieves a feed of user rewards. ### Method GET ### Endpoint /user/feed/rewards ``` ```APIDOC ## GET /user/feed/traffic ### Description Retrieves a feed of user traffic. ### Method GET ### Endpoint /user/feed/traffic ``` ```APIDOC ## GET /user/commissions ### Description Gets the commission structure. ### Method GET ### Endpoint /user/commissions ``` -------------------------------- ### Order Management Endpoints Source: https://api.goaffpro.com/docs/admin Admin access to referral orders of the affiliate. ```APIDOC ## GET /admin/orders ### Description Lists all referral orders. ### Method GET ### Endpoint /admin/orders ``` ```APIDOC ## POST /admin/orders ### Description Creates a new referral order. ### Method POST ### Endpoint /admin/orders ``` ```APIDOC ## PATCH /admin/orders/{id} ### Description Updates an existing order. ### Method PATCH ### Endpoint /admin/orders/{id} ``` ```APIDOC ## DELETE /admin/orders/{id} ### Description Deletes an order and its commission from the affiliate's account. ### Method DELETE ### Endpoint /admin/orders/{id} ``` ```APIDOC ## POST /admin/orders/recalculate/{id} ### Description Recalculates commission for the provided order ID. ### Method POST ### Endpoint /admin/orders/recalculate/{id} ``` ```APIDOC ## GET /admin/orders/system ### Description Retrieves a list of order IDs from the system for later processing. ### Method GET ### Endpoint /admin/orders/system ``` ```APIDOC ## POST /admin/orders/system ### Description Queues orders for processing. Can optionally specify an affiliate ID. ### Method POST ### Endpoint /admin/orders/system ``` -------------------------------- ### Multi-Level Marketing Endpoints Source: https://api.goaffpro.com/docs/admin Access to the multi-level marketing. ```APIDOC ## GET /admin/mlm/tree ### Description Lists the multi-level network. ### Method GET ### Endpoint /admin/mlm/tree ``` ```APIDOC ## GET /admin/mlm/parents/{affiliate_id} ### Description Lists the parent affiliate IDs for a given affiliate. ### Method GET ### Endpoint /admin/mlm/parents/{affiliate_id} ``` ```APIDOC ## POST /admin/mlm/move/{id} ### Description Moves an affiliate from one place in the tree to another. ### Method POST ### Endpoint /admin/mlm/move/{id} ``` -------------------------------- ### Reward Management Endpoints Source: https://api.goaffpro.com/docs/admin Admin access to rewards given to the affiliates (e.g., Signup bonus, Target bonus, MLM Commission etc.). ```APIDOC ## GET /admin/rewards ### Description Lists rewards given to the affiliates. ### Method GET ### Endpoint /admin/rewards ``` ```APIDOC ## POST /admin/rewards ### Description Gives rewards to the affiliates. ### Method POST ### Endpoint /admin/rewards ``` ```APIDOC ## DELETE /admin/rewards/{id} ### Description Deletes a given reward. ### Method DELETE ### Endpoint /admin/rewards/{id} ``` ```APIDOC ## PATCH /admin/rewards/{id} ### Description Updates a given reward. ### Method PATCH ### Endpoint /admin/rewards/{id} ``` -------------------------------- ### Coupons API Source: https://api.goaffpro.com/docs/admin Endpoints for managing coupons. ```APIDOC ## GET /admin/coupons ### Description List available coupons. ### Method GET ### Endpoint /admin/coupons ``` -------------------------------- ### Webhooks API Source: https://api.goaffpro.com/docs/admin Endpoints for managing webhooks to receive events from the system. ```APIDOC ## GET /admin/webhooks ### Description List configured webhooks. ### Method GET ### Endpoint /admin/webhooks ``` ```APIDOC ## POST /admin/webhooks ### Description Register a new webhook. ### Method POST ### Endpoint /admin/webhooks ``` ```APIDOC ## DELETE /admin/webhooks/:id ### Description Delete a webhook by its ID. ### Method DELETE ### Endpoint /admin/webhooks/:id ``` -------------------------------- ### Groups API Source: https://api.goaffpro.com/docs/admin Endpoints for creating and managing groups, which share common configurations for affiliates. ```APIDOC ## GET /admin/groups ### Description Lists created groups. ### Method GET ### Endpoint /admin/groups ``` ```APIDOC ## POST /admin/groups ### Description Create a new group. ### Method POST ### Endpoint /admin/groups ``` ```APIDOC ## PUT /admin/groups/{id} ### Description Updates a group. ### Method PUT ### Endpoint /admin/groups/{id} ``` ```APIDOC ## DELETE /admin/groups/{id} ### Description Deletes a group. ### Method DELETE ### Endpoint /admin/groups/{id} ``` ```APIDOC ## GET /admin/groups/{id}/members ### Description Retrieves a list of affiliate IDs who are part of this group. ### Method GET ### Endpoint /admin/groups/{id}/members ``` ```APIDOC ## POST /admin/groups/{id}/members ### Description Add a member to this group. ### Method POST ### Endpoint /admin/groups/{id}/members ``` ```APIDOC ## PUT /admin/groups/{id}/members ### Description Set affiliates who are in this group. ### Method PUT ### Endpoint /admin/groups/{id}/members ``` ```APIDOC ## DELETE /admin/groups/{id}/members/{affiliate_id} ### Description Removes the affiliate from the group. ### Method DELETE ### Endpoint /admin/groups/{id}/members/{affiliate_id} ``` -------------------------------- ### Files API Source: https://api.goaffpro.com/docs/admin Endpoints for accessing files uploaded by affiliates in their dashboard. ```APIDOC ## GET /admin/files ### Description Access to files uploaded by the affiliates in their dashboard. ### Method GET ### Endpoint /admin/files ``` ```APIDOC ## DELETE /admin/files/:id ### Description Delete a specific file by its ID. ### Method DELETE ### Endpoint /admin/files/:id ``` -------------------------------- ### Payment Management Endpoints Source: https://api.goaffpro.com/docs/admin Admin access to payments made to the affiliates. ```APIDOC ## GET /admin/payments ### Description Lists payment history. ### Method GET ### Endpoint /admin/payments ``` ```APIDOC ## POST /admin/payments ### Description Marks affiliates as paid in bulk. ### Method POST ### Endpoint /admin/payments ``` ```APIDOC ## DELETE /admin/payments/{id} ### Description Deletes a payment entry. ### Method DELETE ### Endpoint /admin/payments/{id} ``` ```APIDOC ## PATCH /admin/payments/{id} ### Description Updates a payment entry. ### Method PATCH ### Endpoint /admin/payments/{id} ``` ```APIDOC ## GET /admin/payments/requests ### Description Lists payment requests made by the affiliate from their dashboard. ### Method GET ### Endpoint /admin/payments/requests ``` ```APIDOC ## POST /admin/payments/requests ### Description Creates a new payment request. ### Method POST ### Endpoint /admin/payments/requests ``` ```APIDOC ## PATCH /admin/payments/requests/{id} ### Description Updates the status of the payment request. ### Method PATCH ### Endpoint /admin/payments/requests/{id} ``` ```APIDOC ## GET /admin/payments/pending ### Description Lists amount due to the affiliates. ### Method GET ### Endpoint /admin/payments/pending ``` ```APIDOC ## POST /admin/payments/sessions ### Description Creates a payout session. ### Method POST ### Endpoint /admin/payments/sessions ``` ```APIDOC ## GET /admin/payments/sessions ### Description Lists payout sessions. ### Method GET ### Endpoint /admin/payments/sessions ``` ```APIDOC ## POST /admin/payments/sessions/end/{session_id} ### Description Ends a payout session. ### Method POST ### Endpoint /admin/payments/sessions/end/{session_id} ``` ```APIDOC ## GET /admin/payments/transactions/unpaid ### Description Lists unpaid transactions. ### Method GET ### Endpoint /admin/payments/transactions/unpaid ``` ```APIDOC ## POST /admin/payments/transactions/pay ### Description Pays a set of transactions. ### Method POST ### Endpoint /admin/payments/transactions/pay ``` -------------------------------- ### Traffic API Source: https://api.goaffpro.com/docs/admin Endpoints for accessing affiliate traffic data. ```APIDOC ## GET /admin/traffic ### Description Access to affiliate traffic data. ### Method GET ### Endpoint /admin/traffic ``` -------------------------------- ### Public API Source: https://api.goaffpro.com/docs/admin Endpoints for accessing public data of merchants enrolled in the marketplace program. ```APIDOC ## GET /public/sites ### Description Access to public data set of the merchants enrolled in the marketplace program. ### Method GET ### Endpoint /public/sites ``` ```APIDOC ## GET /public/products ### Description Access to public product data of the merchants enrolled in the marketplace program. ### Method GET ### Endpoint /public/products ``` -------------------------------- ### Notifications API Source: https://api.goaffpro.com/docs/admin Endpoints for sending notifications. ```APIDOC ## POST /admin/notifications/send/{template_name} ### Description Send a notification using a specified template. ### Method POST ### Endpoint /admin/notifications/send/{template_name} ``` -------------------------------- ### Transactions API Source: https://api.goaffpro.com/docs/admin Endpoints for accessing transaction log entries. ```APIDOC ## GET /admin/transactions ### Description Access to transaction log entries. ### Method GET ### Endpoint /admin/transactions ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.