SelSup Developers
Публичный API · API Reference
Методы раздела «Вебхуки»: точные маршруты, параметры, тела запросов и раскрываемые структуры ответов.
Страница собрана в отдельный редактируемый контракт. Перед операциями записи проверяйте примеры на тестовых данных.
/api/webhook
Готовые сценарии
Используйте отдельный API-токен и сначала проверяйте операции чтения на тестовых данных.
Модель данных
Модели перечислены отдельно и раскрываются также непосредственно у методов, где они используются.
idinteger · int32Идентификатор вебхука, отдается после создания
namestringНазвание вебхука
urlstringАдрес сайта, куда будет отправляться запрос
typesstring[]Список типов
clientIdinteger · int64Поле clientId.
organizationIdinteger · int64Организация для которой создается webhook
Контракт ошибок
Код ошибки одинаков для всех локалей, а текст для пользователя переводится сервером. Поэтому бизнес-логику стройте по error, а localMessage используйте только для отображения.
errorСтабильный машинный код ошибки для логики интеграции.
localMessageГотовое сообщение на языке пользователя API-токена.
paramsЗначения
Язык localMessage определяется полем lang пользователя, которому принадлежит API-токен. Язык страницы документации и заголовок Accept-Language его не переключают; если язык пользователя не указан, используется русский.
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}{
"error": "error_brand_already_exists",
"localMessage": "Brand Base already exists",
"params": {
"name": "Base"
}
}Методы
/api/webhook/Возвращает список всех вебхуков, которые созданы в аккаунте клиента
curl --request GET 'https://api.selsup.ru/api/webhook/' \
--header 'Authorization: YOUR_API_TOKEN'const response = await fetch('https://api.selsup.ru/api/webhook/', {
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/webhook/', {
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/webhook/',
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/webhook/',
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/webhook/", 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/webhook/"))
.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());
}
}Webhook[]
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id |
integer · int32 | Нет | Идентификатор вебхука, отдается после создания |
name |
string | Нет | Название вебхука |
url |
string | Нет | Адрес сайта, куда будет отправляться запрос |
types |
string[] | Нет | Список типов |
clientId |
integer · int64 | Нет | Поле clientId. |
organizationId |
integer · int64 | Нет | Организация для которой создается webhook |
[
"string"
]Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
auth_requiredЗаголовок Authorization отсутствует, пуст или содержит недействительный токен.
error_access_deniedТокен существует, но его роль не позволяет выполнить операцию.
error_unknownВнутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
error_subscription_expiredПерсональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.
/api/webhook/Создает новую подписку на события. В настоящий момент можно получать следующие события: CREATE_ORDER, ORDER, ORDER_STATUS, CREATE_PRODUCT, STOCK,которые передаются в параметре types: ["CREATE_ORDER"]
application/jsonWebhook| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id |
integer · int32 | Нет | Идентификатор вебхука, отдается после создания |
name |
string | Нет | Название вебхука |
url |
string | Нет | Адрес сайта, куда будет отправляться запрос |
types |
string[] | Нет | Список типов |
clientId |
integer · int64 | Нет | Поле clientId. |
organizationId |
integer · int64 | Нет | Организация для которой создается webhook |
curl --request POST 'https://api.selsup.ru/api/webhook/' \
--header 'Authorization: YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}'const response = await fetch('https://api.selsup.ru/api/webhook/', {
method: 'POST',
headers: {
Authorization: process.env.SELSUP_API_TOKEN,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}),
});
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/webhook/', {
method: 'POST',
headers: {
Authorization: process.env.SELSUP_API_TOKEN!,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}),
});
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.post(
'https://api.selsup.ru/api/webhook/',
headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
json={
'id': 1001,
'name': 'Example',
'url': 'https://example.com',
'types': 'string',
'clientId': 1001,
'organizationId': 1001
},
)
response.raise_for_status()
result = response.json()<?php
$payload = <<<'JSON'
{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}
JSON;
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://api.selsup.ru/api/webhook/',
CURLOPT_CUSTOMREQUEST => 'POST',
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("POST", "https://api.selsup.ru/api/webhook/", strings.NewReader(`{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}`))
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/webhook/"))
.header("Authorization", System.getenv("SELSUP_API_TOKEN"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}
"""))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}Webhook
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id |
integer · int32 | Нет | Идентификатор вебхука, отдается после создания |
name |
string | Нет | Название вебхука |
url |
string | Нет | Адрес сайта, куда будет отправляться запрос |
types |
string[] | Нет | Список типов |
clientId |
integer · int64 | Нет | Поле clientId. |
organizationId |
integer · int64 | Нет | Организация для которой создается webhook |
{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
auth_requiredЗаголовок Authorization отсутствует, пуст или содержит недействительный токен.
error_access_deniedТокен существует, но его роль не позволяет выполнить операцию.
error_unknownВнутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
error_empty_typeПерсональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_type; localMessage содержит приведённый выше перевод.
error_empty_urlПерсональная ошибка этого метода. Для программной логики используйте стабильный код error_empty_url; localMessage содержит приведённый выше перевод.
error_invalid_urlПерсональная ошибка этого метода. Для программной логики используйте стабильный код error_invalid_url; localMessage содержит приведённый выше перевод.
error_subscription_expiredПерсональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.
/api/webhook/{webhookId}Позволяет удалить подписку на события, чтобы отменить получение уведомлений
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
webhookId |
integer · int64 | Да | Поле webhookId. |
curl --request DELETE 'https://api.selsup.ru/api/webhook/1001' \
--header 'Authorization: YOUR_API_TOKEN'const response = await fetch('https://api.selsup.ru/api/webhook/1001', {
method: 'DELETE',
headers: { Authorization: process.env.SELSUP_API_TOKEN },
});
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/webhook/1001', {
method: 'DELETE',
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');
}import os
import requests
response = requests.delete(
'https://api.selsup.ru/api/webhook/1001',
headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://api.selsup.ru/api/webhook/1001',
CURLOPT_CUSTOMREQUEST => 'DELETE',
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("DELETE", "https://api.selsup.ru/api/webhook/1001", 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/webhook/1001"))
.header("Authorization", System.getenv("SELSUP_API_TOKEN"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}Тело ответа пустое.
Прикладные ошибки обычно возвращаются как JSON с полями error, localMessage и params. Ориентируйтесь на error; локализованный текст может меняться. Как API возвращает прикладные ошибки ↑
auth_requiredЗаголовок Authorization отсутствует, пуст или содержит недействительный токен.
error_access_deniedТокен существует, но его роль не позволяет выполнить операцию.
error_unknownВнутренняя ошибка. Сохраните время запроса и обратитесь в поддержку, не повторяя мутацию вслепую.
error_subscription_expiredПерсональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.