List commissions

GET

commissions

List commissions

curl --request GET \
  --url https://api.velocity.shop/commissions/ \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.velocity.shop/commissions/', 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.velocity.shop/commissions/",
  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.velocity.shop/commissions/"

	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.velocity.shop/commissions/")

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

[
  {
    "amount": "<string>",
    "currency_code": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "level": -1,
    "modified": "2023-11-07T05:31:56Z",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_shopify_id": 123,
    "order_shopify_po_number": "<string>",
    "order_name": "<string>",
    "order_processed_at": "2023-11-07T05:31:56Z",
    "order_customer_name": "<string>",
    "order_company_name": "<string>",
    "order_company_location_name": "<string>",
    "order_total_price_amount": "<string>",
    "order_total_price_currency_code": "<string>",
    "order_responsible_service_rep_name": "<string>",
    "origin": "team",
    "realized_at": "2023-11-07T05:31:56Z",
    "realization_event": "order_placed",
    "service_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "service_category_is_archived": true,
    "service_category_name": "<string>",
    "service_rep_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "service_rep_name": "<string>"
  }
]

Authorizations

Authorization

string

header

required

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

Query Parameters

category_ids

string

Filter results by a comma-separated list of category IDs.

include_unrealized

boolean

default:false

Include commissions that are not yet realized.

limit

integer

default:20

Number of results to return per page.

Required range: x <= 100

offset

integer

The initial index from which to return the results.

order_end_datetime

string<date-time>

Only include commissions for orders processed at or before this time.

order_id

string<uuid>

Filter results by an order ID.

order_shopify_ids

string

Filter results by a comma-separated list of Shopify order IDs (e.g., 6417313005602).

order_start_datetime

string<date-time>

Only include commissions for orders processed at or after this time.

origins

enum<string>[]

Filter results by a comma-separated list of origins.

Available options:

manual,

override,

ownership,

rep_override,

team

realization_events

enum<string>[]

Filter results by a comma-separated list of realization events.

Available options:

order_placed,

refund,

terms_payment

realized_end_datetime

string<date-time>

Only include commissions realized at or before this time.

realized_start_datetime

string<date-time>

Only include commissions realized at or after this time.

rep_ids

string

Filter results by a comma-separated list of rep IDs.

Response

200 - application/json

amount

string<decimal>

required

Pattern: ^-?\d{0,10}(?:\.\d{0,3})?$

currency_code

string

required

Required string length: 3

string<uuid>

required

read-only

level

integer

required

Required range: -2147483648 <= x <= 2147483647

modified

string<date-time>

required

read-only

order_id

string<uuid>

required

order_shopify_id

integer

required

read-only

order_shopify_po_number

string | null

required

read-only

order_name

string

required

read-only

order_processed_at

string<date-time>

required

read-only

order_customer_name

string | null

required

read-only

order_company_name

string | null

required

read-only

order_company_location_name

string | null

required

read-only

order_total_price_amount

string | null

required

read-only

order_total_price_currency_code

string | null

required

read-only

order_responsible_service_rep_name

string | null

required

read-only

origin

enum<string>

required

team - Team
override - Override
ownership - Ownership
rep_override - Rep Override
manual - Manual

Available options:

team,

override,

ownership,

rep_override,

manual

realized_at

string<date-time> | null

required

read-only

realization_event

enum<string>

required

order_placed - Order Placed
refund - Refund
terms_payment - Terms Payment

Available options:

order_placed,

refund,

terms_payment

service_category_id

string<uuid>

required

service_category_is_archived

boolean

required

read-only

service_category_name

string

required

read-only

service_rep_id

string<uuid>

required

service_rep_name

string

required

read-only

List commissions

curl --request GET \
  --url https://api.velocity.shop/commissions/ \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.velocity.shop/commissions/', 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.velocity.shop/commissions/",
  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.velocity.shop/commissions/"

	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.velocity.shop/commissions/")

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

[
  {
    "amount": "<string>",
    "currency_code": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "level": -1,
    "modified": "2023-11-07T05:31:56Z",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_shopify_id": 123,
    "order_shopify_po_number": "<string>",
    "order_name": "<string>",
    "order_processed_at": "2023-11-07T05:31:56Z",
    "order_customer_name": "<string>",
    "order_company_name": "<string>",
    "order_company_location_name": "<string>",
    "order_total_price_amount": "<string>",
    "order_total_price_currency_code": "<string>",
    "order_responsible_service_rep_name": "<string>",
    "origin": "team",
    "realized_at": "2023-11-07T05:31:56Z",
    "realization_event": "order_placed",
    "service_category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "service_category_is_archived": true,
    "service_category_name": "<string>",
    "service_rep_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "service_rep_name": "<string>"
  }
]

Home

API Reference

Authorizations

Query Parameters

Response