Seller payouts
Update seller payout configuration
Partially update the existing seller payout configuration.
PUT
/
orders
/
payouts
/
config
/
{ulid}
Update seller payout configuration
curl --request PUT \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"commission_fixed_amount": 1,
"commission_percent": 50,
"hold_period_days": 16383,
"include_shipping_in_payout": true,
"include_tax_in_payout": true,
"minimum_payout_amount": 1,
"tds_percent": 50,
"tcs_percent": 50
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}"
payload = {
"commission_fixed_amount": 1,
"commission_percent": 50,
"hold_period_days": 16383,
"include_shipping_in_payout": True,
"include_tax_in_payout": True,
"minimum_payout_amount": 1,
"tds_percent": 50,
"tcs_percent": 50
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
commission_fixed_amount: 1,
commission_percent: 50,
hold_period_days: 16383,
include_shipping_in_payout: true,
include_tax_in_payout: true,
minimum_payout_amount: 1,
tds_percent: 50,
tcs_percent: 50
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}', 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://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'commission_fixed_amount' => 1,
'commission_percent' => 50,
'hold_period_days' => 16383,
'include_shipping_in_payout' => true,
'include_tax_in_payout' => true,
'minimum_payout_amount' => 1,
'tds_percent' => 50,
'tcs_percent' => 50
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}"
payload := strings.NewReader("{\n \"commission_fixed_amount\": 1,\n \"commission_percent\": 50,\n \"hold_period_days\": 16383,\n \"include_shipping_in_payout\": true,\n \"include_tax_in_payout\": true,\n \"minimum_payout_amount\": 1,\n \"tds_percent\": 50,\n \"tcs_percent\": 50\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"commission_fixed_amount\": 1,\n \"commission_percent\": 50,\n \"hold_period_days\": 16383,\n \"include_shipping_in_payout\": true,\n \"include_tax_in_payout\": true,\n \"minimum_payout_amount\": 1,\n \"tds_percent\": 50,\n \"tcs_percent\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"commission_fixed_amount\": 1,\n \"commission_percent\": 50,\n \"hold_period_days\": 16383,\n \"include_shipping_in_payout\": true,\n \"include_tax_in_payout\": true,\n \"minimum_payout_amount\": 1,\n \"tds_percent\": 50,\n \"tcs_percent\": 50\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"payout_config": {
"seller_id": "<string>",
"seller_details": {
"id": "<string>",
"legal_name": "<string>",
"trade_name": "<string>",
"business_type": "<string>",
"tax_identification_number": "<string>",
"status": "<string>",
"kyc_status": "<string>",
"logo": "<string>",
"visibility": "<string>"
},
"commission_fixed_amount": 123,
"commission_percent": 50,
"commission_type": "percent",
"created_at": "2023-11-07T05:31:56Z",
"hold_period_days": 123,
"include_shipping_in_payout": true,
"include_tax_in_payout": true,
"tcs_percent": 123,
"tds_percent": 123,
"minimum_payout_amount": 123,
"modified_at": "2023-11-07T05:31:56Z",
"store_id": "<string>",
"ulid": "<string>"
}
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"errors": {},
"content": {},
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>",
"error_id": "<string>"
}Authorizations
Body
application/json
For percent commission, commission_percent must be positive. For fixed commission, commission_fixed_amount must be positive. percent_plus_fixed requires both positive.
Was this page helpful?
⌘I
Update seller payout configuration
curl --request PUT \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"commission_fixed_amount": 1,
"commission_percent": 50,
"hold_period_days": 16383,
"include_shipping_in_payout": true,
"include_tax_in_payout": true,
"minimum_payout_amount": 1,
"tds_percent": 50,
"tcs_percent": 50
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}"
payload = {
"commission_fixed_amount": 1,
"commission_percent": 50,
"hold_period_days": 16383,
"include_shipping_in_payout": True,
"include_tax_in_payout": True,
"minimum_payout_amount": 1,
"tds_percent": 50,
"tcs_percent": 50
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
commission_fixed_amount: 1,
commission_percent: 50,
hold_period_days: 16383,
include_shipping_in_payout: true,
include_tax_in_payout: true,
minimum_payout_amount: 1,
tds_percent: 50,
tcs_percent: 50
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}', 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://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'commission_fixed_amount' => 1,
'commission_percent' => 50,
'hold_period_days' => 16383,
'include_shipping_in_payout' => true,
'include_tax_in_payout' => true,
'minimum_payout_amount' => 1,
'tds_percent' => 50,
'tcs_percent' => 50
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}"
payload := strings.NewReader("{\n \"commission_fixed_amount\": 1,\n \"commission_percent\": 50,\n \"hold_period_days\": 16383,\n \"include_shipping_in_payout\": true,\n \"include_tax_in_payout\": true,\n \"minimum_payout_amount\": 1,\n \"tds_percent\": 50,\n \"tcs_percent\": 50\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"commission_fixed_amount\": 1,\n \"commission_percent\": 50,\n \"hold_period_days\": 16383,\n \"include_shipping_in_payout\": true,\n \"include_tax_in_payout\": true,\n \"minimum_payout_amount\": 1,\n \"tds_percent\": 50,\n \"tcs_percent\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/orders/payouts/config/{ulid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"commission_fixed_amount\": 1,\n \"commission_percent\": 50,\n \"hold_period_days\": 16383,\n \"include_shipping_in_payout\": true,\n \"include_tax_in_payout\": true,\n \"minimum_payout_amount\": 1,\n \"tds_percent\": 50,\n \"tcs_percent\": 50\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"payout_config": {
"seller_id": "<string>",
"seller_details": {
"id": "<string>",
"legal_name": "<string>",
"trade_name": "<string>",
"business_type": "<string>",
"tax_identification_number": "<string>",
"status": "<string>",
"kyc_status": "<string>",
"logo": "<string>",
"visibility": "<string>"
},
"commission_fixed_amount": 123,
"commission_percent": 50,
"commission_type": "percent",
"created_at": "2023-11-07T05:31:56Z",
"hold_period_days": 123,
"include_shipping_in_payout": true,
"include_tax_in_payout": true,
"tcs_percent": 123,
"tds_percent": 123,
"minimum_payout_amount": 123,
"modified_at": "2023-11-07T05:31:56Z",
"store_id": "<string>",
"ulid": "<string>"
}
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"errors": {},
"content": {},
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>",
"details": "<string>",
"error_id": "<string>"
}