Калькуляция #

Определения #

Транзакция - в рамках опции Калькуляция, транзакцией считается один вызов API метода POST /calculator.

Счет калькуляций - счет на котором хранится остаток, и ведется учет кол-ва сделанных транзакций.

Лицевой счет - счет на котором хранится остаток, и ведется учет пополнений и списание денежных средств.

Стоимость #

Первые 10 000 транзакций в месяц - бесплатно.

Стоимость одной дополнительной транзакции составляет 0,01 руб.

Описание опции #

Ежемесячно пользователю предоставляются 10 000 бесплатных транзакций на Счет калькуляций, если эти транзакции в течение месяца не были использованы, то они не переносятся на следующий месяц. Счет калькуляций расположен на главной странице личного кабинета ApiShip.

Дополнительно пользователю начисляется 1 000 транзакций за каждый заказ, который был создан через платформу ApiShip и был физически передан курьеру или на склад службы доставки. Эти транзакции остаются у пользователя до тех пор, пока не будут использованы.

На рисунке ниже показан пример, в котором у пользователя в начале месяца было начислено 10 000 калькуляций и еще 1 000 калькуляций за переданный заказ. В то же время пользователь уже успел сделать 100 калькуляций. Итоговый баланс калькуляций у пользователя составил 10 000 + 1 000 - 100 = 10 900 калк.

При достижении 0 (нуля) – система будет списывать с Лицевого счета Пользователя сумму за произведенные с этого момента калькуляции. На рисунке ниже показан пример Лицевого счета

Начисление калькуляций #

В период с 8:00 до 9:00 был создан 1 заказ в системе ApiShip.
В период с 9:00 до 10:00 от службы доставки были получены статусы что два заказа приняты на склад.
В период с 10:00 до 11:00 от службы доставки был получен статус что курьер забрал заказ у отправителя.

Начисление калькуляций будет следующим:

В 9:30 будет начислено 0 калькуляций.
В 10:30 будет начислено 2 000 калькуляций.
В 11:30 будет списано 1 000 калькуляций.

Списание калькуляций #

Списание калькуляций происходит в течение каждого часа за предыдущий час. Сначала списываются калькуляции начисленные за создание заказов, если таких нет, то происходит списание бесплатных калькуляций.

Например, на текущем счете калькуляций осталось 1 400 калькуляций из которых 1 300 бесплатных.

В период с 8:00 до 9:00 было сделано 90 калькуляции - осталось 1 310 калькуляций из которых 1 300 бесплатных.
В период с 9:00 до 10:00 было сделано 432 калькуляции - осталось 878 калькуляций из которых 878 бесплатных.
В период с 10:00 до 11:00 было сделано 0 калькуляций - осталось 878 калькуляций из которых 878 бесплатных.

Списание со счетчика калькуляций будет следующим:

В 9:30 будет списано 90 калькуляции.
В 10:30 будет списано 432 калькуляции.
В 11:30 будет списано 0 калькуляций.

Сгорание и начисление ежемесячных бесплатных калькуляций #

В примере на конец месяца (31 декабря 23:59:59) у пользователя осталось 5 900 калькуляций, из которых 4 541 бесплатных.

В начале месяца (1 января 00:00:00) автоматически будет предоставлено 10 000 калькуляций, а не использованные 4 541 калькуляций не будут перенесены 5 900 - 4 541 + 10 000 = 11 359.

Блокирование калькуляций #

Если баланс Счета калькуляций равен 0 калк. и баланс Лицевого счет достиг -50.00 руб. - опция калькуляций блокируется и пользователь начинает в ответ метода POST /calculator получать ошибку HTTP 402 Payment Required

1
2
3
4
5
6

{
  "code": "060001",
  "message": "Необходима оплата",
  "description": "Пополните баланс для использования сервиса калькуляции",
  "moreInfo": "Вопросы пишите на адрес support@apiship.ru"
}

1
2
3
4
5
6
7

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <code>060001</code>
    <message>Необходима оплата</message>
    <description>Пополните баланс для использования сервиса калькуляции</description>
    <moreInfo>Вопросы пишите на адрес support@apiship.ru</moreInfo>
</response>