Store creators summary

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

import requests

url = "https://api.growi.io/api/public/v1/shopify/store_creators/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

	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/summary")

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": {
    "pending_amount": "<string>",
    "unpaid_amount": "<string>",
    "unpaid_commission": "<string>",
    "paid_amount": "<string>",
    "total_vat": "<string>",
    "raw_pending_amount": 123,
    "raw_unpaid_amount": 123,
    "raw_unpaid_commission": 123,
    "raw_paid_amount": 123,
    "raw_total_vat": 123
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

shopify

store_creators

summary

Store creators summary

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

import requests

url = "https://api.growi.io/api/public/v1/shopify/store_creators/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

	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/summary")

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": {
    "pending_amount": "<string>",
    "unpaid_amount": "<string>",
    "unpaid_commission": "<string>",
    "paid_amount": "<string>",
    "total_vat": "<string>",
    "raw_pending_amount": 123,
    "raw_unpaid_amount": 123,
    "raw_unpaid_commission": 123,
    "raw_paid_amount": 123,
    "raw_total_vat": 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.

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 summary

Authorizations

Query Parameters

Response