Swagger API Личный кабинет Центр поддержки

Термины и определения #

JSON — универсальный текстовый формат обмена данными, представляющий собой набор.

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

ИМ — интернет-магазин.

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

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

ЛК — личный кабинет.

Место (грузоместо, упаковка) — неделимая единица груза, отправляемая ИМ (может быть несколько в одном заказе).

НП — наложенный платеж. Сумма, которую получатель должен оплатить при получении посылки. После оплаты получателем, сумма НП перечисляется отправителю. За перевод взимается плата в соответствии с тарифами СД.

ОС — оценочная стоимость. Сумма на которую страхуется отправление, если иное не предусмотрено договором с СД.

Отправитель — физическое или юридическое лицо, передавшее в СД оправление для осуществления дальнейшей его доставки получателю.

ПВЗ — пункт самовывоза отправления получателем.

Получатель — физическое или юридическое лицо, указанное в накладной СД в качестве получателя отправления.

СД — служба доставки.

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

ФИО — фамилия, имя и отчество.

ШК — штрих-код.