Settings

Ready-to-use workflows

01

Start using Settings

Use a dedicated API token and validate read operations with test data first.

Keep the token server-side and send it in the Authorization header.
Check required parameters and expand the request or response schema.
Handle the HTTP status and the stable error field in application errors.

PUTPut Property GETGet GETList

Data model

Data structures

Models are listed once here and can also be expanded directly from the endpoints that use them.

Property6 fields

organizationIdinteger · int64

Organization Id.

clientIdinteger · int64

Client Id.

read-only

componentstring

Component.

namestring

Name.

valuestring

Value.

valueNamestring

Value Name.

Error contract

How application errors are returned

The error code is identical in every locale, while the user-facing message is translated by the server. Build application logic around error and use localMessage for display only.

error

Stable machine-readable code for integration logic.

localMessage

Display-ready message in the API token user's language.

params

Values interpolated by the server into the localized message template.

文

localMessage uses the lang field of the user who owns the API token. The documentation language and Accept-Language header do not change it; Russian is used when the user has no language configured.

RUUser locale is ru

{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}

ENUser locale is en

{
  "error": "error_brand_already_exists",
  "localMessage": "Brand Base already exists",
  "params": {
    "name": "Base"
  }
}

Endpoints

PUT

Put Property

/api/property/

Token with write access

Put Property using PUT /api/property/.

Request body

application/json

Object fieldsProperty

Field	Type	Required	Description
`organizationId`	integer · int64	No	Organization Id.
`clientId`	integer · int64	No	Client Id.
`component`	string	No	Component.
`name`	string	No	Name.
`value`	string	No	Value.
`valueName`	string	No	Value Name.

curl --request PUT 'https://api.selsup.ru/api/property/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}'

const response = await fetch('https://api.selsup.ru/api/property/', {
  method: 'PUT',
  headers: {
    Authorization: process.env.SELSUP_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "organizationId": 1001,
    "clientId": 1001,
    "component": "string",
    "name": "Example",
    "value": "string",
    "valueName": "Example"
  }),
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const response: Response = await fetch('https://api.selsup.ru/api/property/', {
  method: 'PUT',
  headers: {
    Authorization: process.env.SELSUP_API_TOKEN!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "organizationId": 1001,
    "clientId": 1001,
    "component": "string",
    "name": "Example",
    "value": "string",
    "valueName": "Example"
  }),
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

import os
import requests

response = requests.put(
    'https://api.selsup.ru/api/property/',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
    json={
        'organizationId': 1001,
        'clientId': 1001,
        'component': 'string',
        'name': 'Example',
        'value': 'string',
        'valueName': 'Example'
    },
)
response.raise_for_status()

<?php

$payload = <<<'JSON'
{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}
JSON;

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/property/',
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN'), 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => $payload,
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

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

func main() {
    req, err := http.NewRequest("PUT", "https://api.selsup.ru/api/property/", strings.NewReader(`{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}`))
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))
    req.Header.Set("Content-Type", "application/json")

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/property/"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .header("Content-Type", "application/json")
            .method("PUT", HttpRequest.BodyPublishers.ofString("""
{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}
"""))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Success response

200

The response has no body.

Errors7

Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑

401auth_required

Authentication required

Authorization is missing, empty, or contains an invalid token.

400error_access_denied

Insufficient permissions

The token exists, but its role cannot perform this operation.

500error_unknown

Unexpected error

Internal failure. Save the request time and contact support; do not blindly retry a mutation.

400error_cant_extract_tariffs

Unable to retrieve tariffs. Please contact support

Endpoint-specific error. Use the stable error_cant_extract_tariffs code in application logic; localMessage contains the translation shown above.

400error_invalid_currency_source

The specified currency rate source is not supported

Endpoint-specific error. Use the stable error_invalid_currency_source code in application logic; localMessage contains the translation shown above.

400error_invalid_stock_distribution_rules

Invalid stock distribution rules: check shares from 0 to 1 and stock thresholds.

Endpoint-specific error. Use the stable error_invalid_stock_distribution_rules code in application logic; localMessage contains the translation shown above.

400error_no_client

The client was not found or has been deleted. Write to support

Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.

GET

Get

/api/property/{organizationId}/{component}

Token with read access

Get using GET /api/property/{organizationId}/{component}.

Path parameters

Field	Type	Required	Description
`organizationId`	integer · int64	Yes	Organization Id.
`component`	string	Yes	Component.

curl --request GET 'https://api.selsup.ru/api/property/1001/string' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/property/1001/string', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN },
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const result = await response.json();

const response: Response = await fetch('https://api.selsup.ru/api/property/1001/string', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN! },
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

const result: unknown = await response.json();

import os
import requests

response = requests.get(
    'https://api.selsup.ru/api/property/1001/string',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()
result = response.json()

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/property/1001/string',
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN')],
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

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

func main() {
    req, err := http.NewRequest("GET", "https://api.selsup.ru/api/property/1001/string", nil)
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/property/1001/string"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Success response

200

"string"

Errors32

Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑

401auth_required

Authentication required

Authorization is missing, empty, or contains an invalid token.

400error_access_denied

Insufficient permissions

The token exists, but its role cannot perform this operation.

500error_unknown

Unexpected error

Internal failure. Save the request time and contact support; do not blindly retry a mutation.

400error_base_creating

Your cabinet is being created, wait a few minutes until complete cabinet creation

Endpoint-specific error. Use the stable error_base_creating code in application logic; localMessage contains the translation shown above.

400error_cant_extract_tariffs

Unable to retrieve tariffs. Please contact support

Endpoint-specific error. Use the stable error_cant_extract_tariffs code in application logic; localMessage contains the translation shown above.

400error_cant_receive_stocks

failed to retrieve stock levels

Endpoint-specific error. Use the stable error_cant_receive_stocks code in application logic; localMessage contains the translation shown above.

400error_client_branding_failed

Could not load or save branding settings.

Endpoint-specific error. Use the stable error_client_branding_failed code in application logic; localMessage contains the translation shown above.

400error_fbs_marking_code_unsupported

Fbs marking code unsupported

Endpoint-specific error. Use the stable error_fbs_marking_code_unsupported code in application logic; localMessage contains the translation shown above.

400error_fulfillment_client_access_denied

Fulfillment client access denied

Endpoint-specific error. Use the stable error_fulfillment_client_access_denied code in application logic; localMessage contains the translation shown above.

400error_fulfillment_client_contract_required

Accept the contract to access operations.

Endpoint-specific error. Use the stable error_fulfillment_client_contract_required code in application logic; localMessage contains the translation shown above.

400error_fulfillment_request_invalid

Fulfillment request invalid

Endpoint-specific error. Use the stable error_fulfillment_request_invalid code in application logic; localMessage contains the translation shown above.

400error_header_logo_upload_failed

Could not upload the logo. Please try again.

Endpoint-specific error. Use the stable error_header_logo_upload_failed code in application logic; localMessage contains the translation shown above.

400error_income_not_found

No vendor order found{id}

Endpoint-specific error. Use the stable error_income_not_found code in application logic; localMessage contains the translation shown above.

400error_integration_cell_mapping_invalid

Integration cell mapping invalid

Endpoint-specific error. Use the stable error_integration_cell_mapping_invalid code in application logic; localMessage contains the translation shown above.

400error_no_client

The client was not found or has been deleted. Write to support

Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.

400error_no_price_for_order_product

Price not specified for product: {name}

Endpoint-specific error. Use the stable error_no_price_for_order_product code in application logic; localMessage contains the translation shown above.

400error_no_quantity_for_order_product

Product quantity not specified: {name}

Endpoint-specific error. Use the stable error_no_quantity_for_order_product code in application logic; localMessage contains the translation shown above.

400error_order_not_found

Order not found

Endpoint-specific error. Use the stable error_order_not_found code in application logic; localMessage contains the translation shown above.

400error_organization_create_failed

There was a problem when creating an organization. Please contact support

Endpoint-specific error. Use the stable error_organization_create_failed code in application logic; localMessage contains the translation shown above.

400error_organization_exists

Organization already established

Endpoint-specific error. Use the stable error_organization_exists code in application logic; localMessage contains the translation shown above.

400error_organization_not_found

Organization not found

Endpoint-specific error. Use the stable error_organization_not_found code in application logic; localMessage contains the translation shown above.

400error_ozon_fbo_workflow_not_found

Ozon FBO workflow {id} was not found

Endpoint-specific error. Use the stable error_ozon_fbo_workflow_not_found code in application logic; localMessage contains the translation shown above.

400error_reload

The authorization session has expired, refresh the browser page. If the update does not help, try deleting the cookies for the site

Endpoint-specific error. Use the stable error_reload code in application logic; localMessage contains the translation shown above.

400error_settlement_invalid

Settlement invalid

Endpoint-specific error. Use the stable error_settlement_invalid code in application logic; localMessage contains the translation shown above.

400error_subscription_expired

Your subscription has expired. Pay the tariff to continue using the service.

Endpoint-specific error. Use the stable error_subscription_expired code in application logic; localMessage contains the translation shown above.

400error_supply_not_found

Delivery not found: {name}

Endpoint-specific error. Use the stable error_supply_not_found code in application logic; localMessage contains the translation shown above.

400error_token_expired_or_revoked

API token revoked or entered incorrectly

Endpoint-specific error. Use the stable error_token_expired_or_revoked code in application logic; localMessage contains the translation shown above.

400error_transport_waybill_invalid

Check the transport waybill data.

Endpoint-specific error. Use the stable error_transport_waybill_invalid code in application logic; localMessage contains the translation shown above.

400error_transport_waybill_source

A transport waybill is unavailable for this shipment or supply.

Endpoint-specific error. Use the stable error_transport_waybill_source code in application logic; localMessage contains the translation shown above.

400error_user_does_not_have_this_organization

The user does not have access to this organization

Endpoint-specific error. Use the stable error_user_does_not_have_this_organization code in application logic; localMessage contains the translation shown above.

400error_warehouse_not_found

Warehouse not found

Endpoint-specific error. Use the stable error_warehouse_not_found code in application logic; localMessage contains the translation shown above.

400error_warehouse_setup_unavailable

Warehouse setup unavailable

Endpoint-specific error. Use the stable error_warehouse_setup_unavailable code in application logic; localMessage contains the translation shown above.

GET

List

/api/property/list/{component}

Token with read access

List using GET /api/property/list/{component}.

Path parameters

Field	Type	Required	Description
`component`	string	Yes	Component.

Query parameters

Field	Type	Required	Description
`organizationId`	integer · int64	No	Organization Id.

curl --request GET 'https://api.selsup.ru/api/property/list/string' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/property/list/string', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN },
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const result = await response.json();

const response: Response = await fetch('https://api.selsup.ru/api/property/list/string', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN! },
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

const result: unknown = await response.json();

import os
import requests

response = requests.get(
    'https://api.selsup.ru/api/property/list/string',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()
result = response.json()

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/property/list/string',
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN')],
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

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

func main() {
    req, err := http.NewRequest("GET", "https://api.selsup.ru/api/property/list/string", nil)
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/property/list/string"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Success response

200

Array item structure Property[]

Field	Type	Required	Description
`organizationId`	integer · int64	No	Organization Id.
`clientId`	integer · int64	No	Client Id.
`component`	string	No	Component.
`name`	string	No	Name.
`value`	string	No	Value.
`valueName`	string	No	Value Name.

[
  "string"
]

Errors34

Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑

401auth_required

Authentication required

Authorization is missing, empty, or contains an invalid token.

400error_access_denied

Insufficient permissions

The token exists, but its role cannot perform this operation.

500error_unknown

Unexpected error

Internal failure. Save the request time and contact support; do not blindly retry a mutation.

400error_bad_request

Incorrect request format

Endpoint-specific error. Use the stable error_bad_request code in application logic; localMessage contains the translation shown above.

400error_base_creating

Your cabinet is being created, wait a few minutes until complete cabinet creation

Endpoint-specific error. Use the stable error_base_creating code in application logic; localMessage contains the translation shown above.

400error_cabinet_access_denied

Access to this cabinet is not available.

Endpoint-specific error. Use the stable error_cabinet_access_denied code in application logic; localMessage contains the translation shown above.

400error_cant_extract_tariffs

Unable to retrieve tariffs. Please contact support

Endpoint-specific error. Use the stable error_cant_extract_tariffs code in application logic; localMessage contains the translation shown above.

400error_container_log_read_failed

Container log read failed

Endpoint-specific error. Use the stable error_container_log_read_failed code in application logic; localMessage contains the translation shown above.

400error_container_log_request_invalid

Container log request invalid

Endpoint-specific error. Use the stable error_container_log_request_invalid code in application logic; localMessage contains the translation shown above.

400error_empty_first_name

Name Not Specified

Endpoint-specific error. Use the stable error_empty_first_name code in application logic; localMessage contains the translation shown above.

400error_empty_last_name

Surname not specified

Endpoint-specific error. Use the stable error_empty_last_name code in application logic; localMessage contains the translation shown above.

400error_empty_organization_form

organization form not specified

Endpoint-specific error. Use the stable error_empty_organization_form code in application logic; localMessage contains the translation shown above.

400error_empty_organization_inn

Organization TIN not specified

Endpoint-specific error. Use the stable error_empty_organization_inn code in application logic; localMessage contains the translation shown above.

400error_empty_organization_name

Organization name not specified

Endpoint-specific error. Use the stable error_empty_organization_name code in application logic; localMessage contains the translation shown above.

400error_empty_position_name

Job title not specified

Endpoint-specific error. Use the stable error_empty_position_name code in application logic; localMessage contains the translation shown above.

400error_fulfillment_client_access_denied

Fulfillment client access denied

Endpoint-specific error. Use the stable error_fulfillment_client_access_denied code in application logic; localMessage contains the translation shown above.

400error_fulfillment_client_contract_required

Accept the contract to access operations.

Endpoint-specific error. Use the stable error_fulfillment_client_contract_required code in application logic; localMessage contains the translation shown above.

400error_fulfillment_document_error

Could not generate the document. Check the parameters and operation contents.

Endpoint-specific error. Use the stable error_fulfillment_document_error code in application logic; localMessage contains the translation shown above.

400error_fulfillment_request_invalid

Fulfillment request invalid

Endpoint-specific error. Use the stable error_fulfillment_request_invalid code in application logic; localMessage contains the translation shown above.

400error_income_not_found

No vendor order found{id}

Endpoint-specific error. Use the stable error_income_not_found code in application logic; localMessage contains the translation shown above.

400error_max_page

Page number cannot be greater than 100,000

Endpoint-specific error. Use the stable error_max_page code in application logic; localMessage contains the translation shown above.

400error_no_client

The client was not found or has been deleted. Write to support

Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.

400error_no_price_for_order_product

Price not specified for product: {name}

Endpoint-specific error. Use the stable error_no_price_for_order_product code in application logic; localMessage contains the translation shown above.

400error_no_quantity_for_order_product

Product quantity not specified: {name}

Endpoint-specific error. Use the stable error_no_quantity_for_order_product code in application logic; localMessage contains the translation shown above.

400error_order_not_found

Order not found

Endpoint-specific error. Use the stable error_order_not_found code in application logic; localMessage contains the translation shown above.

400error_organization_create_failed

There was a problem when creating an organization. Please contact support

Endpoint-specific error. Use the stable error_organization_create_failed code in application logic; localMessage contains the translation shown above.

400error_organization_exists

Organization already established

Endpoint-specific error. Use the stable error_organization_exists code in application logic; localMessage contains the translation shown above.

400error_position_exists

A position with this title already exists

Endpoint-specific error. Use the stable error_position_exists code in application logic; localMessage contains the translation shown above.

400error_reload

The authorization session has expired, refresh the browser page. If the update does not help, try deleting the cookies for the site

Endpoint-specific error. Use the stable error_reload code in application logic; localMessage contains the translation shown above.

400error_subscription_expired

Your subscription has expired. Pay the tariff to continue using the service.

Endpoint-specific error. Use the stable error_subscription_expired code in application logic; localMessage contains the translation shown above.

400error_warehouse_not_found

Warehouse not found

Endpoint-specific error. Use the stable error_warehouse_not_found code in application logic; localMessage contains the translation shown above.

400error_wrong_crm_token

incorrect CRM token

Endpoint-specific error. Use the stable error_wrong_crm_token code in application logic; localMessage contains the translation shown above.

400error_wrong_inn

Incorrectly specified TIN of the organization, length 10 or 12 digits

Endpoint-specific error. Use the stable error_wrong_inn code in application logic; localMessage contains the translation shown above.

400error_wrong_version

Version is incorrect

Endpoint-specific error. Use the stable error_wrong_version code in application logic; localMessage contains the translation shown above.

Ready-to-use workflows

Start using Settings

Data structures

How application errors are returned

Endpoints

Put Property

Request body

Success response

Get

Path parameters

Success response

List

Path parameters

Query parameters

Success response

Token for test requests

Real request parameters

Live API response