{"id":14525,"date":"2023-09-26T15:04:16","date_gmt":"2023-09-26T15:04:16","guid":{"rendered":"http:\/\/a8759758b2.nxcli.io\/?post_type=docs&p=14525"},"modified":"2026-09-02T22:19:50","modified_gmt":"2026-09-02T22:19:50","password":"","slug":"developpeurs","status":"publish","type":"docs","link":"https:\/\/couponaffiliates.com\/fr\/docs\/developers\/","title":{"rendered":"D\u00e9veloppeurs : Extraits de code et ressources"},"content":{"rendered":"\n

The REST API is wcusage\/v2<\/code>. Enable it under Coupon Affiliates > Admin Tools > API<\/strong>, then see API & Webhooks<\/a> for merchant setup (keys, scopes, webhooks) and the API documentation<\/a> for authentication, routes, payloads and examples.<\/p>\n\n\n\n

Below are PHP snippets and resources that customers have asked for. They are not a substitute for the REST API reference.<\/p>\n\n\n\n

Database Tables<\/h2>\n\n\n\n

The plugin does have its own database tables that you can get certain data from:<\/p>\n\n\n\n

wcusage_activity – Activity log.<\/p>\n\n\n\n

wcusage_campaigns – Referral URL campaigns.<\/p>\n\n\n\n

wcusage_clicks – Referral URL clicks log.<\/p>\n\n\n\n

wcusage_directlinks – Direct link tracking domains.<\/p>\n\n\n\n

wcusage_mlainvites – Multi-Level affiliates invites.<\/p>\n\n\n\n

wcusage_payouts – Commission Payouts<\/p>\n\n\n\n

wcusage_register – Affiliate registration applications.<\/p>\n\n\n\n

Affiliate Orders<\/h2>\n\n\n\n

Get all affiliate orders for a coupon, without certain data range. This returns an array of data including the total calculations for all the orders, and all the individual orders.<\/p>\n\n\n\n

$orders = wcusage_wh_getOrderbyCouponCode( $coupon_code, $start_date, $end_date, '', 1 );<\/code><\/pre>\n\n\n\n
Order Data<\/h2>\n\n\n\n
You can get an array of affiliate related data for a certain order via this function. This returns an array of data including the commission earnings.<\/p>\n\n\n\n
$order_data = wcusage_calculate_order_data( $order_id, $coupon_code, 0, 1 );<\/code><\/pre>\n\n\n\n
To get the commission from the order for example:<\/p>\n\n\n\n
$commission = $order_data['totalcommission'];<\/code><\/pre>\n\n\n\n
Affiliate URL<\/h2>\n\n\n\n
Get the affiliate URL for a coupon via the following function:<\/p>\n\n\n\n
$coupon_code = ""; \/\/ Set the coupon code name here.\n$affiliate_url = wcusage_get_affiliate_url($coupon_code);<\/code><\/pre>\n\n\n\n
Or if you want to build your own custom URL here’s an example:<\/p>\n\n\n\n
$coupon_code = ""; \/\/ Set the coupon code name here.\n$prefix = wcusage_get_setting_value('wcusage_field_urls_prefix', 'coupon');\n$affiliate_url = get_home_url() . "?" . $prefix . "=" . $coupon_code;<\/code><\/pre>\n\n\n\n
Total Sales and Commission<\/h2>\n\n\n\n
Get the total sales and commission earned by a certain coupon, without a certain date range. Leave $start_date empty to get all sales.<\/em><\/p>\n\n\n\n
$orders = wcusage_wh_getOrderbyCouponCode( $coupon_code, $start_date, $end_date, '', 1 );\n$total_orders = $orders['total_orders']; \/\/ Total Sales\n$total_discounts = $orders['full_discount']; \/\/ Total Discounts\n$total_commission = $orders['total_commission']; \/\/ Total Commission\n$order_count = $orders['total_count']; \/\/ Orders Count<\/code><\/pre>\n\n\n\n
Unpaid Commission<\/h2>\n\n\n\n
Get the total unpaid commission for an affiliate coupon.<\/p>\n\n\n\n
$coupon_id = ""; \/\/ Set the coupon code ID here.\n$unpaid_commission = get_post_meta( $coupon_id, 'wcu_text_unpaid_commission', true );<\/code><\/pre>\n\n\n\n
Hook (Action): New Affiliate Registration Submitted<\/h2>\n\n\n\n
When there is a new affiliate registration, it will run the “wcusage_hook_registration_new” hook that will pass the registration ID, user ID, and coupon code.<\/p>\n\n\n\n
You could therefore call this hook to automatically accept the registration under certain conditions with the “wcusage_set_registration_status” function. For example this will automatically accept the registration if the users role is “example”:<\/p>\n\n\n\n
add_action( 'wcusage_hook_registration_new', 'trigger_wcusage_hook_registration_new', 10, 3 );\nfunction trigger_wcusage_hook_registration_new( $registration_id, $user_id, $coupon_code ) {\n    $user_info = get_userdata( $user_id );\n    $roles = $user_info->roles;\n\n    if ( in_array( 'example', $roles ) ) {\n        wcusage_set_registration_status( 'accepted', $registration_id, $user_id, $coupon_code, '', '' );\n    }\n}<\/code><\/pre>\n\n\n\n
Hook (Action): New Affiliate Accepted<\/h2>\n\n\n\n
When a new affiliate is accepted and added to your program, it will run the “wcusage_hook_affiliate_register_accepted” that will pass the following:<\/p>\n\n\n\n
    \n
  • $id – Registration ID.<\/li>\n\n\n\n
  • $userid – User ID.<\/li>\n\n\n\n
  • $coupon_code – Coupon Code.<\/li>\n\n\n\n
  • $message – The registration acceptance message.<\/li>\n\n\n\n
  • $status – The status of their registration.<\/li>\n<\/ul>\n\n\n\n
    add_action( 'wcusage_hook_affiliate_register_accepted', 'trigger_wcusage_hook_registration_accepted', 10, 5 );\nfunction trigger_wcusage_hook_registration_accepted( $id, $userid, $coupon_code, $message, $status ) {\n\/\/ Your code here.\n}<\/code><\/pre>\n\n\n\n
    Legacy v1 API<\/h2>\n\n\n\n
    The original three endpoints under woo-coupon-usage\/v1<\/code> are still registered for existing integrations. They require a WordPress administrator<\/strong> role. They are not the current API. New integrations should use wcusage\/v2<\/code>.<\/p>\n\n\n\n
    GET<\/strong> \/wp-json\/woo-coupon-usage\/v1\/coupon-info<\/code> with coupon_id<\/code>. Returns coupon_name<\/code>, unpaid_commission<\/code>, and pending_payouts<\/code>.<\/p>\n\n\n\n
    GET<\/strong> \/wp-json\/woo-coupon-usage\/v1\/users-coupons<\/code> with user<\/code> (the login name). Returns coupon IDs assigned to that user, with unpaid commission.<\/p>\n\n\n\n
    POST<\/strong> \/wp-json\/woo-coupon-usage\/v1\/request-payout<\/code> with coupon_id<\/code> and user<\/code> (login). Returns 1<\/code> on success or 0<\/code> on failure. PRO.<\/p>\n\n\n\n
    Need help with a custom function? Feel free to contact us and we may be able to point you in the right direction.<\/p>\n","protected":false},"excerpt":{"rendered":"
    The REST API is wcusage\/v2. Enable it under Coupon Affiliates > Admin Tools > API, then see API & Webhooks for merchant setup (keys, scopes, webhooks) and the API documentation for authentication, routes, payloads and examples. Below are PHP snippets and resources that customers have asked for. They are not a substitute for the REST […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","footnotes":"","_links_to":"","_links_to_target":""},"doc_category":[136],"doc_tag":[],"class_list":["post-14525","docs","type-docs","status-publish","hentry","doc_category-developers","wpbf-post"],"year_month":"2026-09","word_count":697,"total_views":"3820","reactions":{"happy":"0","normal":"0","sad":"0"},"author_info":{"display_name":"Elliot Sowersby","author_link":"#"},"doc_category_info":[{"term_name":"Developers","term_url":"https:\/\/couponaffiliates.com\/fr\/docs-category\/developers\/"}],"doc_tag_info":[],"taxonomy_info":{"doc_category":[{"value":136,"label":"Developers"}]},"featured_image_src_large":false,"comment_info":0,"knowledge_base_info":[],"knowledge_base_slug":[],"_links":{"self":[{"href":"https:\/\/couponaffiliates.com\/fr\/wp-json\/wp\/v2\/docs\/14525","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/couponaffiliates.com\/fr\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/couponaffiliates.com\/fr\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/couponaffiliates.com\/fr\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/couponaffiliates.com\/fr\/wp-json\/wp\/v2\/comments?post=14525"}],"version-history":[{"count":25,"href":"https:\/\/couponaffiliates.com\/fr\/wp-json\/wp\/v2\/docs\/14525\/revisions"}],"predecessor-version":[{"id":24609,"href":"https:\/\/couponaffiliates.com\/fr\/wp-json\/wp\/v2\/docs\/14525\/revisions\/24609"}],"wp:attachment":[{"href":"https:\/\/couponaffiliates.com\/fr\/wp-json\/wp\/v2\/media?parent=14525"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/couponaffiliates.com\/fr\/wp-json\/wp\/v2\/doc_category?post=14525"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/couponaffiliates.com\/fr\/wp-json\/wp\/v2\/doc_tag?post=14525"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}