Калькулятор стоимости услуг
Метод доступен для всех моделей.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- pricing — Управление ценами
- pricing:read-only — Просмотр цен
- finance-and-accounting — Просмотр финансовой информации и отчётности
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всех данных
Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги.
Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.
В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.
| ⚙️ Лимит: 100 запросов в минуту |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/tariffs/calculate
Body
application/json
{
"parameters": {
"campaignId": 0,
"sellingProgram": "FBY",
"frequency": "DAILY",
"currency": "RUR"
},
"offers": [
{
"categoryId": 0,
"price": 0,
"length": 0,
"width": 0,
"height": 0,
"weight": 0,
"quantity": 1
}
]
}
|
Name |
Description |
|
offers* |
Type: CalculateTariffsOfferDTO[] Товары, для которых нужно рассчитать стоимость услуг. Min items: Max items: |
|
parameters* |
Type: CalculateTariffsParametersDTO Параметры для расчета стоимости услуг. |
CalculateTariffsOfferDTO
Параметры товара, для которого нужно рассчитать стоимость услуг.
|
Name |
Description |
|
categoryId* |
Type: integer<int64> Идентификатор категории товара на Маркете. Для расчета стоимости услуг необходимо указать идентификатор листовой категории товара. Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST v2/categories/tree. Min value (exclusive): |
|
height* |
Type: number Высота товара в сантиметрах. Min value (exclusive): |
|
length* |
Type: number Длина товара в сантиметрах. Min value (exclusive): |
|
price* |
Type: number Цена товара в рублях. Min value (exclusive): |
|
weight* |
Type: number Вес товара в килограммах. Min value (exclusive): |
|
width* |
Type: number Ширина товара в сантиметрах. Min value (exclusive): |
|
quantity |
Type: integer<int32> Квант продажи — количество единиц товара в одном товарном предложении. Default: Min value: |
CalculateTariffsParametersDTO
Параметры для расчета стоимости услуг.
|
Name |
Description |
|
campaignId |
Type: integer<int64> Идентификатор кампании. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах. У пользователя, который выполняет запрос, должен быть доступ к этой кампании. Используйте параметр Обязательный параметр, если не указан параметр Min value: |
|
currency |
Type: CurrencyType Коды валют:
Enum: |
|
frequency |
Type: PaymentFrequencyType Частота выплат. Enum: |
|
sellingProgram |
Type: SellingProgramType Модель размещения:
Enum: |
CurrencyType
Коды валют:
RUR— российский рубль.UAH— украинская гривна.BYR— белорусский рубль.KZT— казахстанский тенге.UZS— узбекский сум.
|
Type |
Description |
|
Enum: |
PaymentFrequencyType
Частота выплат:
DAILY— ежедневно.WEEKLY— раз в неделю.BIWEEKLY— раз в две недели.MONTHLY— раз в месяц.
Подробнее о графике выплат читайте в Справке Маркета для продавцов.
|
Type |
Description |
|
Enum: |
SellingProgramType
Модель размещения:
FBY— FBY.FBS— FBS.DBS— DBS.EXPRESS— Экспресс.
|
Type |
Description |
|
Enum: |
Responses
200 OK
Стоимость услуг.
Body
application/json
{
"status": "OK",
"result": {
"offers": [
{
"offer": {
"categoryId": 0,
"price": 0,
"length": 0,
"width": 0,
"height": 0,
"weight": 0,
"quantity": 1
},
"tariffs": [
{
"type": "AGENCY_COMMISSION",
"amount": 0,
"currency": "RUR",
"parameters": [
{
"name": "string",
"value": "string"
}
]
}
]
}
]
}
}
|
Name |
Description |
|
status* |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
|
result |
Type: CalculateTariffsResponseDTO Стоимость услуг. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
|
Type |
Description |
|
Enum: |
CalculateTariffsResponseDTO
Расчет стоимости услуг.
|
Name |
Description |
|
offers* |
Type: CalculateTariffsOfferInfoDTO[] Стоимость услуг. |
CalculateTariffsOfferInfoDTO
Стоимость услуг.
|
Name |
Description |
|
offer* |
Type: CalculateTariffsOfferDTO Параметры товара, для которого нужно рассчитать стоимость услуг. |
|
tariffs* |
Type: CalculatedTariffDTO[] Список услуг и их стоимость. По некоторым услугам могут возвращаться несколько разных стоимостей. Например, в модели FBS стоимость услуги |
CalculatedTariffDTO
Информация об услугах Маркета.
|
Name |
Description |
|
parameters* |
Type: TariffParameterDTO[] Параметры расчета тарифа. |
|
type* |
Type: CalculatedTariffType Услуга Маркета. Enum: |
|
amount |
Type: number Стоимость услуги в рублях. |
|
currency |
Type: CurrencyType Коды валют:
Enum: |
TariffParameterDTO
Детали расчета конкретной услуги Маркета.
|
Name |
Description |
|
name* |
Type: string Название параметра. |
|
value* |
Type: string Значение параметра. |
CalculatedTariffType
Услуга Маркета:
-
AGENCY_COMMISSION— прием платежа покупателя. -
PAYMENT_TRANSFER— перевод платежа покупателя. -
FEE— размещение товара на Маркете. -
DELIVERY_TO_CUSTOMER— доставка покупателю. -
CROSSREGIONAL_DELIVERY— доставка в федеральный округ, город или населенный пункт. -
EXPRESS_DELIVERY— экспресс-доставка покупателю. -
SORTING— обработка заказа. -
MIDDLE_MILE— средняя миля.
Подробнее об услугах Маркета читайте в Справке Маркета для продавцов.
|
Type |
Description |
|
Enum: |
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code* |
Type: string Код ошибки. |
|
message |
Type: string Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
404 Not Found
Запрашиваемый ресурс не найден. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.
Категория, у которой нет дочерних.