{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}Публичный API · Справочник API
Биллинг
Операции биллинга за выбранный период.
Операции биллинга для фулфилмента.
/api/billing/find
Модель данных
Структуры данных
Поля объектов, которые используются в запросах и ответах этого раздела.
Billing17 полей
idinteger · int64Идентификатор биллинга. Проставляется автоматически
namestringНаименование операции биллинга
productIdinteger · int64Идентификатор товара, для которого рассчитан биллинг
itemIdinteger · int64привязка к единице хранения на складе
orderIdinteger · int64Заказ по которому был рассчитан биллинг
pricenumber · doubleПоле price.
volumeinteger · int32объем для операций, которые зависят от объема
weightinteger · int32Поле weight.
quantityinteger · int32Поле quantity.
totalPricenumber · doubleПоле totalPrice.
tariffIdinteger · int64идентификатор тарифа для хранения или короба
linkedClientIdinteger · int64идентификатор клиента фулфилмента
clientIdinteger · int64идентификатор клиента самого фулфилмента
fromstring · date-timeдата тарификации от
tostring · date-timeдата тарификации до
datestring · date-timeдата операции
userIdinteger · int64идентификатор пользователя фулфилмента, который добавил операцию
FindResponseBilling1 полей
rowsBilling[]Строки с результатом поиска
Ошибки
Обработка ошибок
При ошибке API возвращает её код в поле error и сообщение на языке пользователя в localMessage. Проверяйте код error в программе, а localMessage показывайте пользователю.
errorКод ошибки для обработки в программе.
localMessageСообщение на языке пользователя, которому принадлежит токен.
paramsЗначения, которые сервер подставил в сообщение об ошибке.
Язык localMessage определяется полем lang пользователя, которому принадлежит API-токен. Язык страницы документации и заголовок Accept-Language его не переключают; если язык пользователя не указан, используется русский.
{
"error": "error_brand_already_exists",
"localMessage": "Brand Base already exists",
"params": {
"name": "Base"
}
}Методы
Методы
Получение операций биллинга за период
/api/billing/findВозвращает данные как для клиента так и для фулфилмента
Параметры запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
from |
string · date-time | Нет | Поле from. |
to |
string · date-time | Нет | Поле to. |
limit |
integer · int32 | Нет | Ограничение на количество записей. Максимальное значение - 500 |
page |
integer · int32 | Нет | Номер страницы начиная с 1 |
count |
boolean | Нет | Возвратить в ответе общее количество записей |
sortBy |
string | Нет | Поле сортировки записей. Работает только при получении списка. |
ascending |
boolean | Нет | Порядок сортировки - по возрастанию?. Работает только при получении списка. |
curl --request GET 'https://api.selsup.ru/api/billing/find?limit=50&page=1' \
--header 'Authorization: YOUR_API_TOKEN'
const response = await fetch('https://api.selsup.ru/api/billing/find?limit=50&page=1', {
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/billing/find?limit=50&page=1', {
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/billing/find?limit=50&page=1',
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/billing/find?limit=50&page=1',
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/billing/find?limit=50&page=1", 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/billing/find?limit=50&page=1"))
.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());
}
}
Успешный ответ
200
Поля объекта
FindResponseBilling
| Поле | Тип | Обязательно | Описание | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
rows |
Billing[] | Нет | Строки с результатом поиска | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Структура элемента массива
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id |
integer · int64 | Нет | Идентификатор биллинга. Проставляется автоматически |
name |
string | Нет | Наименование операции биллинга |
productId |
integer · int64 | Нет | Идентификатор товара, для которого рассчитан биллинг |
itemId |
integer · int64 | Нет | привязка к единице хранения на складе |
orderId |
integer · int64 | Нет | Заказ по которому был рассчитан биллинг |
price |
number · double | Нет | Поле price. |
volume |
integer · int32 | Нет | объем для операций, которые зависят от объема |
weight |
integer · int32 | Нет | Поле weight. |
quantity |
integer · int32 | Нет | Поле quantity. |
totalPrice |
number · double | Нет | Поле totalPrice. |
tariffId |
integer · int64 | Нет | идентификатор тарифа для хранения или короба |
linkedClientId |
integer · int64 | Нет | идентификатор клиента фулфилмента |
clientId |
integer · int64 | Нет | идентификатор клиента самого фулфилмента |
from |
string · date-time | Нет | дата тарификации от |
to |
string · date-time | Нет | дата тарификации до |
date |
string · date-time | Нет | дата операции |
userId |
integer · int64 | Нет | идентификатор пользователя фулфилмента, который добавил операцию |
{
"rows": "string"
}Ошибки6
При ошибке проверьте HTTP-статус и тело ответа. Поле error содержит код ошибки, localMessage — сообщение для пользователя, params — дополнительные сведения. Обработка ошибок ↑
auth_requiredЗаголовок Authorization отсутствует, пуст или содержит недействительный токен.
error_access_deniedТокен существует, но его роль не позволяет выполнить операцию.
error_unknownНе удалось выполнить запрос из-за внутренней ошибки. Если запрос изменял данные, проверьте результат перед повторной отправкой. Для обращения в поддержку сохраните время запроса и полученный ответ.
error_cant_extract_tariffsПерсональная ошибка этого метода. Для программной логики используйте стабильный код error_cant_extract_tariffs; localMessage содержит приведённый выше перевод.
error_no_clientПерсональная ошибка этого метода. Для программной логики используйте стабильный код error_no_client; localMessage содержит приведённый выше перевод.
error_subscription_expiredПерсональная ошибка этого метода. Для программной логики используйте стабильный код error_subscription_expired; localMessage содержит приведённый выше перевод.