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

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

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить, для какого товара рассчитана стоимость услуги.

Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.

В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.

⚙️ Лимит: 100 запросов в минуту

Request

POST

https://api.partner.market.yandex.ru/v2/tariffs/calculate

Body

application/json
{
  "parameters": {
    "campaignId": 1,
    "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: 1

Max items: 200

Example
[
  {
    "categoryId": 0,
    "price": 0,
    "length": 0,
    "width": 0,
    "height": 0,
    "weight": 0,
    "quantity": 1
  }
]

parameters

Type: CalculateTariffsParametersDTO

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

Параметры для расчета стоимости услуг. Обязательно необходимо указать параметр campaignId либо sellingProgram. Совместное использование параметров приведет к ошибке.

Example
{
  "campaignId": 1,
  "sellingProgram": "FBY",
  "frequency": "DAILY",
  "currency": "RUR"
}

CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Type: integer

Min value: 1

SellingProgramType

Модель работы:

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

Type: string

Enum: FBY, FBS, DBS, EXPRESS, LAAS

PaymentFrequencyType

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

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

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

Type: string

Enum: DAILY, WEEKLY, BIWEEKLY, MONTHLY

CurrencyType

Коды валют:

  • RUR — российский рубль.
  • UAH — украинская гривна.
  • BYR — белорусский рубль.
  • KZT — казахстанский тенге.
  • UZS — узбекский сум.

Type: string

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

CalculateTariffsParametersDTO

Параметры для расчета стоимости услуг. Обязательно необходимо указать параметр campaignId либо sellingProgram. Совместное использование параметров приведет к ошибке.

Name

Description

campaignId

Type: CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Min value: 1

Example: 1

currency

Type: CurrencyType

Валюта, в которой рассчитывается услуга.

Значение по умолчанию: RUR.

Коды валют:

  • RUR — российский рубль.
  • UAH — украинская гривна.
  • BYR — белорусский рубль.
  • KZT — казахстанский тенге.
  • UZS — узбекский сум.

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

frequency

Type: PaymentFrequencyType

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

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

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

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

Enum: DAILY, WEEKLY, BIWEEKLY, MONTHLY

sellingProgram

Type: SellingProgramType

Модель работы.

Для продавцов Market Yandex Go недоступны модели DBS и Экспресс.

Обязательный параметр, если не указан параметр campaignId. Совместное использование параметров приведет к ошибке.

Модель работы:

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

Enum: FBY, FBS, DBS, EXPRESS, LAAS
Example
{
  "campaignId": 1,
  "sellingProgram": "FBY",
  "frequency": "DAILY",
  "currency": "RUR"
}

CalculateTariffsOfferDTO

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

Name

Description

categoryId

Type: integer

Идентификатор категории товара на Маркете.

Для расчета стоимости услуг необходимо указать идентификатор листовой категории товара.

Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST v2/categories/tree.

Min value: 0

Exclusive min: true

height

Type: number

Высота товара в сантиметрах.

Min value: 0

Exclusive min: true

length

Type: number

Длина товара в сантиметрах.

Min value: 0

Exclusive min: true

price

Type: number

Цена товара в рублях.

Min value: 0

Exclusive min: true

weight

Type: number

Вес товара в килограммах.

Min value: 0

Exclusive min: true

width

Type: number

Ширина товара в сантиметрах.

Min value: 0

Exclusive min: true

quantity

Type: integer

Квант продажи — количество единиц товара в одном товарном предложении.

Default: 1

Min value: 1
Example
{
  "categoryId": 0,
  "price": 0,
  "length": 0,
  "width": 0,
  "height": 0,
  "weight": 0,
  "quantity": 1
}

Responses

200 OK

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

Body

application/json
{
  "status": "OK",
  "result": {
    "offers": [
      {
        "offer": {},
        "tariffs": [
          null
        ]
      }
    ]
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    result

    Type: CalculateTariffsResponseDTO

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

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

    Example
    {
  "offers": [
    {
      "offer": {
        "categoryId": 0,
        "price": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "quantity": 1
      },
      "tariffs": [
        {
          "type": "AGENCY_COMMISSION",
          "amount": 0.5,
          "currency": "RUR",
          "parameters": [
            null
          ]
        }
      ]
    }
  ]
}
    Example
    {
  "result": {
    "offers": [
      {
        "offer": {
          "categoryId": 0,
          "price": 0,
          "length": 0,
          "width": 0,
          "height": 0,
          "weight": 0,
          "quantity": 1
        },
        "tariffs": [
          {}
        ]
      }
    ]
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR
Example
{
  "status": "OK"
}

CalculatedTariffType

Услуга Маркета:

  • AGENCY_COMMISSION — прием платежа покупателя.

  • PAYMENT_TRANSFER — перевод платежа покупателя.

  • FEE — размещение товара на Маркете.

  • DELIVERY_TO_CUSTOMER — доставка покупателю.

  • CROSSREGIONAL_DELIVERY — доставка в федеральный округ, город или населенный пункт.

  • EXPRESS_DELIVERY — экспресс-доставка покупателю.

  • SORTING — обработка заказа.

  • MIDDLE_MILE — средняя миля.

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

Type: string

Enum: AGENCY_COMMISSION, PAYMENT_TRANSFER, FEE, DELIVERY_TO_CUSTOMER, CROSSREGIONAL_DELIVERY, EXPRESS_DELIVERY, SORTING, MIDDLE_MILE

TariffParameterDTO

Детали расчета конкретной услуги Маркета.

Name

Description

name

Type: string

Название параметра.

Example: example

value

Type: string

Значение параметра.

Example: example
Example
{
  "name": "example",
  "value": "example"
}

CalculatedTariffDTO

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

Name

Description

parameters

Type: TariffParameterDTO[]

Параметры расчета тарифа.

Example
[
  {
    "name": "example",
    "value": "example"
  }
]

type

Type: CalculatedTariffType

Услуга Маркета.

Услуга Маркета:

  • AGENCY_COMMISSION — прием платежа покупателя.

  • PAYMENT_TRANSFER — перевод платежа покупателя.

  • FEE — размещение товара на Маркете.

  • DELIVERY_TO_CUSTOMER — доставка покупателю.

  • CROSSREGIONAL_DELIVERY — доставка в федеральный округ, город или населенный пункт.

  • EXPRESS_DELIVERY — экспресс-доставка покупателю.

  • SORTING — обработка заказа.

  • MIDDLE_MILE — средняя миля.

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

Enum: AGENCY_COMMISSION, PAYMENT_TRANSFER, FEE, DELIVERY_TO_CUSTOMER, CROSSREGIONAL_DELIVERY, EXPRESS_DELIVERY, SORTING, MIDDLE_MILE

amount

Type: number

Стоимость услуги в рублях.

currency

Type: CurrencyType

Валюта, в которой рассчитывается услуга.

Коды валют:

  • RUR — российский рубль.
  • UAH — украинская гривна.
  • BYR — белорусский рубль.
  • KZT — казахстанский тенге.
  • UZS — узбекский сум.

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE
Example
{
  "type": "AGENCY_COMMISSION",
  "amount": 0.5,
  "currency": "RUR",
  "parameters": [
    {
      "name": "example",
      "value": "example"
    }
  ]
}

CalculateTariffsOfferInfoDTO

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

Name

Description

offer

Type: CalculateTariffsOfferDTO

Информация о товаре, которую вы передали в запросе для расчета стоимости услуг.

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

Example
{
  "categoryId": 0,
  "price": 0,
  "length": 0,
  "width": 0,
  "height": 0,
  "weight": 0,
  "quantity": 1
}

tariffs

Type: CalculatedTariffDTO[]

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

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

Example
[
  {
    "type": "AGENCY_COMMISSION",
    "amount": 0.5,
    "currency": "RUR",
    "parameters": [
      {
        "name": "example",
        "value": "example"
      }
    ]
  }
]
Example
{
  "offer": {
    "categoryId": 0,
    "price": 0,
    "length": 0,
    "width": 0,
    "height": 0,
    "weight": 0,
    "quantity": 1
  },
  "tariffs": [
    {
      "type": "AGENCY_COMMISSION",
      "amount": 0.5,
      "currency": "RUR",
      "parameters": [
        {
          "name": "example",
          "value": "example"
        }
      ]
    }
  ]
}

CalculateTariffsResponseDTO

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

Name

Description

offers

Type: CalculateTariffsOfferInfoDTO[]

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

Example
[
  {
    "offer": {
      "categoryId": 0,
      "price": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "quantity": 1
    },
    "tariffs": [
      {
        "type": "AGENCY_COMMISSION",
        "amount": 0.5,
        "currency": "RUR",
        "parameters": [
          {}
        ]
      }
    ]
  }
]
Example
{
  "offers": [
    {
      "offer": {
        "categoryId": 0,
        "price": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "weight": 0,
        "quantity": 1
      },
      "tariffs": [
        {
          "type": "AGENCY_COMMISSION",
          "amount": 0.5,
          "currency": "RUR",
          "parameters": [
            null
          ]
        }
      ]
    }
  ]
}

400 Bad Request

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

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

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

403 Forbidden

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

404 Not Found

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

420 Method Failure

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

No longer supported, please use an alternative and newer version.

Категория, у которой нет дочерних.

Предыдущая
Передача остатков
Следующая
В кабинете