List Affiliate Sales

cURL

curl --request GET \
  --url https://api.growi.io/api/public/v1/affiliate_sales \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/affiliate_sales', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/affiliate_sales",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/affiliate_sales"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/affiliate_sales")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 1947457,
      "external_id": "ORD-12345",
      "platform": "website",
      "status": "unpaid",
      "occurred_at": "2025-09-30T23:55:29.000Z",
      "total": 9999,
      "commission": 500,
      "currency": "usd",
      "sub_id": "instagram"
    }
  ],
  "meta": {
    "row_count": 150,
    "page_count": 8,
    "current_page": 1
  },
  "additional_data": {
    "total_gmv": 14245.57,
    "total_commission": 1403.31,
    "paid_commission": 500,
    "unpaid_commission": 903.31,
    "total_vat": 0,
    "total_orders": 150,
    "total_refunded_amount": 0
  }
}

{
  "error": "<string>",
  "message": "<string>"
}

GET

affiliate_sales

cURL

curl --request GET \
  --url https://api.growi.io/api/public/v1/affiliate_sales \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/affiliate_sales', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/affiliate_sales",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/affiliate_sales"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/affiliate_sales")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 1947457,
      "external_id": "ORD-12345",
      "platform": "website",
      "status": "unpaid",
      "occurred_at": "2025-09-30T23:55:29.000Z",
      "total": 9999,
      "commission": 500,
      "currency": "usd",
      "sub_id": "instagram"
    }
  ],
  "meta": {
    "row_count": 150,
    "page_count": 8,
    "current_page": 1
  },
  "additional_data": {
    "total_gmv": 14245.57,
    "total_commission": 1403.31,
    "paid_commission": 500,
    "unpaid_commission": 903.31,
    "total_vat": 0,
    "total_orders": 150,
    "total_refunded_amount": 0
  }
}

{
  "error": "<string>",
  "message": "<string>"
}

Retrieves paginated affiliate sales (conversions) for the organization. These endpoints manage conversions (affiliate sales) attributed to your creators and ambassadors. For website conversions, call with store_platform=website (no store_id required). For Shopify conversions, use store_platform=shopify_store along with your store_id. The response includes data (array of sales), meta (pagination info), and additional_data (aggregate totals like total GMV, commission breakdown, and order counts).

Request Parameters

Parameter	Type	Description	Required
`page`	Integer	Page number for pagination. Default is 1.	No
`per_page`	Integer	Number of results per page. Default is 20. Maximum is 100.	No
`start_date`	String	Filter sales from this date (MM/DD/YYYY format)	No
`end_date`	String	Filter sales until this date (MM/DD/YYYY format)	No
`search`	String	Search by customer name or email	No
`creator_id`	Integer	Filter by Growi creator/user ID	No
`creator_email`	String	Filter by creator’s email address	No
`campaign_id`	Integer	Filter by campaign ID	No
`order_id`	String	Filter by external order ID	No
`status`	String	Filter by status: `paid`, `due`, `unpaid`, `canceled`, or `refunded`	No
`affiliate_tag`	String	Filter by affiliate tag (campaign_affiliate_id tag)	No
`sub_id`	String	Filter by custom source/sub-ID tag (e.g., `instagram`, `youtube`)	No
`store_id`	String	Store identifier (required for Shopify, not needed for website)	No
`store_platform`	String	Platform type: `website` or `shopify_store`. Use `website` for website-sourced conversions.	No
`ambassador_program`	Boolean	Filter to only ambassador program sales. Default is false.	No

Request Example

curl -X GET "https://api.growi.io/api/public/v1/affiliate_sales?store_platform=website&page=1&per_page=20" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY"

With date range and status filter:

curl -X GET "https://api.growi.io/api/public/v1/affiliate_sales?store_platform=website&start_date=01/01/2025&end_date=01/31/2025&status=unpaid" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY"

Response Example

{
  "data": [
    {
      "id": 1947457,
      "external_id": "ORD-12345",
      "platform": "website",
      "status": "unpaid",
      "occurred_at": "2025-09-30T23:55:29.000Z",
      "total": 9999,
      "commission": 500,
      "currency": "usd"
    }
  ],
  "meta": {
    "row_count": 150,
    "page_count": 8,
    "current_page": 1
  },
  "additional_data": {
    "total_gmv": 14245.57,
    "total_commission": 1403.31,
    "paid_commission": 500.00,
    "unpaid_commission": 903.31,
    "total_vat": 0.0,
    "total_orders": 150,
    "total_refunded_amount": 0.0
  }
}

Response Fields

Field	Type	Description
`data`	Array	Array of affiliate sale objects
`data[].id`	Integer	Unique Growi identifier for the sale
`data[].external_id`	String	External order ID (your system’s order identifier)
`data[].platform`	String	Source platform: `website`, `shopify`, etc.
`data[].status`	String	Sale status: `paid`, `due`, `unpaid`, `canceled`, or `refunded`
`data[].occurred_at`	String	ISO 8601 timestamp when the sale occurred
`data[].total`	Integer	Total order amount in cents
`data[].commission`	Integer	Commission amount in cents
`data[].currency`	String	Currency code (e.g., `usd`, `eur`)
`data[].sub_id`	String	Custom source/sub-ID tag captured on the sale (e.g., `instagram`)
`meta`	Object	Pagination metadata
`meta.row_count`	Integer	Total number of sales matching the query
`meta.page_count`	Integer	Total number of pages available
`meta.current_page`	Integer	Current page number
`additional_data`	Object	Aggregate totals for the query
`additional_data.total_gmv`	Number	Total Gross Merchandise Value in dollars
`additional_data.total_commission`	Number	Total commission amount in dollars
`additional_data.paid_commission`	Number	Commission already paid out in dollars
`additional_data.unpaid_commission`	Number	Commission not yet paid in dollars
`additional_data.total_vat`	Number	Total VAT amount in dollars
`additional_data.total_orders`	Integer	Total number of orders
`additional_data.total_refunded_amount`	Number	Total refunded amount in dollars

Use Cases

This endpoint is useful for:

Conversions Dashboard: Build a real-time dashboard showing all affiliate-attributed sales
Data Warehouse Sync: Export conversion data to your analytics or data warehouse
Payout Reconciliation: Verify commission amounts before processing creator payouts
Creator Performance: Filter by creator_id or creator_email to analyze individual creator performance
Campaign Analytics: Filter by campaign_id to measure campaign-specific conversion metrics
Financial Reporting: Use additional_data totals for GMV and commission reporting

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

default:1

Page number for pagination. Default is 1.

per_page

integer

default:20

Number of results per page. Default is 20. Maximum is 100.

Required range: x <= 100

start_date

string<date>

Filter sales from this date (MM/DD/YYYY format)

end_date

string<date>

Filter sales until this date (MM/DD/YYYY format)

string

Search by customer name or email

creator_id

integer

Filter by Growi creator/user ID

creator_email

string<email>

Filter by creator's email address

campaign_id

integer

Filter by campaign ID

order_id

string

Filter by external order ID

status

enum<string>

Filter by sale status

Available options:

paid,

due,

unpaid,

canceled,

refunded

affiliate_tag

string

Filter by affiliate tag

sub_id

string

Filter by custom source/sub-ID tag (e.g., instagram, youtube)

store_id

string

Store identifier (required for Shopify, not needed for website)

store_platform

enum<string>

Platform type: website or shopify_store

Available options:

website,

shopify_store

ambassador_program

boolean

default:false

Filter to only ambassador program sales

Response

Affiliate sales retrieved successfully

data

object[]

Show child attributes

Get Started

Essentials

API Documentation

Tracking Events

Stats API

TikTok Shop API

Organization API

Conversions API

Request Parameters

Request Example

Response Example

Response Fields

Use Cases

Authorizations

Query Parameters

Response

​Request Parameters

​Request Example

​Response Example

​Response Fields

​Use Cases

Authorizations

Query Parameters

Response

Request Parameters

Request Example

Response Example

Response Fields

Use Cases