Калькулятор стоимости услуг

Info

Console

Метод доступен для всех моделей.

Пока недоступен для продавцов Market Yandex Go.

Если вы используете 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/tariffs/calculate

Body

application/json

{
    "parameters": {
        "campaignId": 0,
        "sellingProgram": "FBY",
        "frequency": "DAILY"
    },
    "offers": [
        {
            "categoryId": 0,
            "price": 0,
            "length": 0,
            "width": 0,
            "height": 0,
            "weight": 0,
            "quantity": 1
        }
    ]
}

Name

Description

offers*

Type: CalculateTariffsOfferDTO[]

Товары, для которых нужно рассчитать стоимость услуг.
Параметры товара, для которого нужно рассчитать стоимость услуг.

Min items: 1

Max items: 200

parameters*

Type: CalculateTariffsParametersDTO

Параметры для расчета стоимости услуг.

CalculateTariffsOfferDTO

Параметры товара, для которого нужно рассчитать стоимость услуг.

Name	Description
categoryId*	Type: integer<int64> Идентификатор категории товара на Маркете. Для расчета стоимости услуг необходимо указать идентификатор листовой категории товара — той, которая не имеет дочерних категорий. Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree. Min value (exclusive): `0`
height*	Type: number Высота товара в сантиметрах. Min value (exclusive): `0`
length*	Type: number Длина товара в сантиметрах. Min value (exclusive): `0`
price*	Type: number Цена на товар в рублях. Min value (exclusive): `0`
weight*	Type: number Вес товара в килограммах. Min value (exclusive): `0`
width*	Type: number Ширина товара в сантиметрах. Min value (exclusive): `0`
quantity	Type: integer<int32> Квант продажи — количество единиц товара в одном товарном предложении. Default: `1` Min value: `1`

CalculateTariffsParametersDTO

Параметры для расчета стоимости услуг.

Name	Description
campaignId	Type: integer<int64> Идентификатор кампании. У пользователя, который выполняет запрос, должен быть доступ к этой кампании. Используйте параметр `campaignId`, если уже завершили подключение магазина на Маркете. Иначе вернется пустой список. Обязательный параметр, если не указан параметр `sellingProgram`. Совместное использование параметров приведет к ошибке. Min value: `1`
frequency	Type: PaymentFrequencyType Частота выплат. Enum: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`
sellingProgram	Type: SellingProgramType Модель размещения. Обязательный параметр, если не указан параметр `campaignId`. Совместное использование параметров приведет к ошибке. Enum: `FBY`, `FBS`, `DBS`, `EXPRESS`

PaymentFrequencyType

Частота выплат:

DAILY — ежедневно.
WEEKLY — раз в неделю.
BIWEEKLY — раз в две недели.
MONTHLY — раз в месяц.

Подробнее о графике выплат читайте в Справке Маркета для продавцов.

Type	Description
PaymentFrequencyType	Enum: `DAILY`, `WEEKLY`, `BIWEEKLY`, `MONTHLY`

SellingProgramType

Модель размещения:

FBY — FBY.
FBS — FBS.
DBS — DBS.
EXPRESS — Экспресс.

Type	Description
SellingProgramType	Enum: `FBY`, `FBS`, `DBS`, `EXPRESS`

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,
                        "parameters": [
                            {
                                "name": "string",
                                "value": "string"
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Name

Description

result

Type: CalculateTariffsResponseDTO

Стоимость услуг.

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

CalculateTariffsResponseDTO

Расчет стоимости услуг.

Name

Description

offers*

Type: CalculateTariffsOfferInfoDTO[]

Стоимость услуг.
Стоимость услуг.

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

CalculateTariffsOfferInfoDTO

Стоимость услуг.

Name

Description

offer*

Type: CalculateTariffsOfferDTO

Параметры товара, для которого нужно рассчитать стоимость услуг.

tariffs*

Type: CalculatedTariffDTO[]

Список услуг и их стоимость.

По некоторым услугам могут возвращаться несколько разных стоимостей. Например, в модели FBS стоимость услуги SORTING (обработка заказа) зависит от способа отгрузки и количества заказов в отгрузке. Подробнее о тарифах на услуги читайте в Справке Маркета для продавцов.
Информация об услугах Маркета.

CalculatedTariffDTO

Информация об услугах Маркета.

Name	Description
parameters*	Type: TariffParameterDTO[] Параметры расчета тарифа. Детали расчета конкретной услуги Маркета.
type*	Type: CalculatedTariffType Услуга Маркета. Enum: `AGENCY_COMMISSION`, `PAYMENT_TRANSFER`, `FEE`, `DELIVERY_TO_CUSTOMER`, `CROSSREGIONAL_DELIVERY`, `EXPRESS_DELIVERY`, `SORTING`, `MIDDLE_MILE`
amount	Type: number Стоимость услуги в рублях.

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
CalculatedTariffType	Enum: `AGENCY_COMMISSION`, `PAYMENT_TRANSFER`, `FEE`, `DELIVERY_TO_CUSTOMER`, `CROSSREGIONAL_DELIVERY`, `EXPRESS_DELIVERY`, `SORTING`, `MIDDLE_MILE`

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

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: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Была ли статья полезна?

Передача остатков

В кабинете