Store creators

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

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

fetch('https://api.growi.io/api/public/v1/shopify/store_creators', 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/shopify/store_creators",
  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/shopify/store_creators"

	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/shopify/store_creators")

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

{
  "success": true,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "avatar_url": "<string>",
      "user_id": 123,
      "campaign_id": 123,
      "campaign_name": "<string>",
      "commission_rate": 123,
      "status": "<string>",
      "paid_amount": "<string>",
      "paid_externally_amount": "<string>",
      "unpaid_amount": "<string>",
      "pending_amount": "<string>",
      "active_discount_code": "<string>",
      "store_unique_tag": "<string>",
      "store_affiliate_link": "<string>"
    }
  ],
  "meta": {
    "current_page": 123,
    "row_count": 123,
    "page_count": 123
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

shopify

store_creators

Store creators

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

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

fetch('https://api.growi.io/api/public/v1/shopify/store_creators', 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/shopify/store_creators",
  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/shopify/store_creators"

	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/shopify/store_creators")

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

{
  "success": true,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "avatar_url": "<string>",
      "user_id": 123,
      "campaign_id": 123,
      "campaign_name": "<string>",
      "commission_rate": 123,
      "status": "<string>",
      "paid_amount": "<string>",
      "paid_externally_amount": "<string>",
      "unpaid_amount": "<string>",
      "pending_amount": "<string>",
      "active_discount_code": "<string>",
      "store_unique_tag": "<string>",
      "store_affiliate_link": "<string>"
    }
  ],
  "meta": {
    "current_page": 123,
    "row_count": 123,
    "page_count": 123
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

organization_id

integer

Read one of your child brands instead of the organization that owns the key. Any id that is not one of your brands answers 404.

start_date

string<date>

Sales from this day, YYYY-MM-DD. Default: all time.

end_date

string<date>

Sales through this day, YYYY-MM-DD.

platform

enum<string>

shopify (default) or your custom website store.

Available options:

shopify,

website

campaign_id

integer

Only this campaign of your organization.

campaign_scope

enum<string>

all (default), ambassador programs, or social campaigns and contracts.

Available options:

ambassador,

social,

all

creator_id

integer

Only this creator (Growi user id).

status

enum<string>

Enrollment status. Default active.

Available options:

active,

completed,

removed,

all

string

Creator name or email, or tag:CODE for a discount code.

paid_status

enum<string>

Only creators with commission in this state.

Available options:

unpaid,

paid,

paid_externally,

pending,

all

include_heavy_data

boolean

Also return revenue_generated, click_count and unique_link_clicks (slower).

sort_by

enum<string>

Sort by an amount or traffic column.

Available options:

unpaid,

revenue,

paid,

paid_externally,

pending,

page_views,

unique_clicks

sort_direction

enum<string>

desc (default) or asc.

Available options:

asc,

desc

page

integer

Page number, from 1.

per_page

integer

Rows per page, 1-100. Default 20.

Response

success

boolean

data

object[]

Show child attributes

Overview

Organization

Creators and campaigns

Content analytics

Sales and stores

Payouts

TikTok Shop

Meta ads

Deprecated

Store creators

Authorizations

Query Parameters

Response