Клиентский API

API позволяет передавать заказы и в ответ получать стоимость доставки, а также статусы их выполнения. Для доступа необходимо получить логин/пароль – запросите на info@courierist.ru

Актуальная документация представлена ниже.

 Документация по API

Список изменений

Версия
Дата
Версия
1.15 28.02.2024
  1. При создании поручений добавлены поля is_required_on_cancel для обязательности при отказе и required_min_sum для указания минимальной суммы выкупа
1.14 13.11.2023
  1. Добавлено поле Location.pin для передачи пинкода курьеру для забора груза и Location.otp для предзаполнения кодов подтверждения получателем при выдаче
1.13 04.09.2023
  1. Добавлено поле Order.is_opening_package_allowed и Order.is_is_fitting_allowed для разрешения/запрета возможности вскрытия заводской упаковки, а также проверки/примерки
1.12 29.06.2023
  1. Добавлено поле Shipment.is_excise для возможности передавать признак подакцизного товара для печати в чеке
1.11 06.06.2023
  1. Добавлено поле Order.is_partial_delivering для разрешения/запрета возможности частичной доставки
1.10 29.05.2023
  1. Добавлены поля location.reason при получении ответа в методах получения и поиска заказов
  2. Удалён метод Получение всех заказов (запрос GET:https://my.courierist.com/api/v1/order/get-all)
1.9 02.03.2023
  1. Добавлены поля в Shipment для печати данных поставщика в чеке
1.8 02.02.2023
  1. Добавлен метод настройки и проверки вебхука
1.7 29.12.2022
  1. Добавлен метод метод получения этикеток в PDF
1.6 13.12.2022
  1. Добавлено поле Shipment.barcode для передачи штрихкодов товаров в формате EAN-13
1.5 26.08.2022
  1. Добавлен поиск по массиву order.id в метод Поиск заказов
1.4 15.10.2021
  1. Добавлено поле Добавлено поле Shipment.type_id, и метод получения доступных Типов груза.
  2. Добавлено поле Contact.email
1.3.1 22.04.2021
  1. В Создании Заказов и Поиске Заказов в ответе добавлено поле trackingLink со сслыкой на страницу отслеживания статуса адреса
1.3 16.11.2020
  1. В Поиске Заказов в ответе location.history заменен на location.tracking
1.2.7 16.08.2020
  1. Добавлено поле Shipment.legal_vat для добавления товаров, не облагающихся НДС, у компаний на ОСНО.
1.2.6 14.02.2020
  1. Добавлено поле Shipment.marking_code, Shipment.marking_type для передачи маркировки товаров
1.2.5 29.12.2019
  1. Добавлено поле Assignment.comment
1.2.4 18.12.2019
  1. Метод обновления параметра is_manual_processing в Location по номеру заказа Order.id
1.2.3 03.12.2019
  1. Добавлена возможность указывать в заказе контактное лицо для решения нестандартных ситуаций по заказу
1.2.2 27.10.2019
  1. Метод обновления параметров Location
1.2.1 23.10.2019
  1. В ответ метода Поиск заказов добавлена информация о назначенных курьерах couriers
1.2 10.09.2019
  1. Добавлена возможность добавлять/заменять грузы в заказе и поручения в адресе, если ни один из адресов заказа не имеет финального статуса
1.1.4 11.07.2019
  1. Добавлено поле Assignment.tax_rate для указания ставки НДС
1.1.3 24.06.2019
  1. Вес Shipment.weight теперь принимает 3 знака после запятой вместо 2 ранее.
  2. Добавлено поле Shipment.tax_unit_type, определяющее формулу расчета наложенного платежа.
  3. Изменена проверка корректности Shipment.price и Shipment.tax_item_price в зависимости от Shipment.tax_unit_type
1.1.2 28.02.2019
  1. Добавлены поля Location address_details, address_type_id, address_place и метод получения списка LocationType
  2. В Поиск заказов добавлена возможность искать по массиву “codes” 
  3. Добавлена возможность вносить Location.prepayment, предоплаченная сумма наложенного платежа
1.1.1 22.02.2019
  1. Исправлена ошибка в ответ на отмену заказа. Теперь возвращается и массив location (раньше не возвращался).
1.1.0 01.02.2019
  1. Внесена зависимость наложенного платежа от количества в shipment:
    наложенный платеж - сумма за всё количество (unit), ₽, 2 знака после запятой, разделитель - точка.
    Должно точно соответствовать price = tax_item_price * unit
1.0.0 01.06.2017
  1. Первая версия протокола