Описание API

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

Список методов

Получить список городов

Тип запроса: GET
Адрес ресурса: <Сервер>/sdd/hs/delivery_cost/cities
Формат запроса: JSON RPC 2.0
Сервис требует авторизации

Ответ содержит:

city_id: идентификтор города в системе Доброгост, тип Строка
city_name: название города, тип Строка
city_from: из данного города можно отправлять заказы, тип Булево
city_to: в данные город можно отправлять заказы, тип Булево
region: название области, тип Строка
area: регион, тип Строка
fias: код ФИАС, тип Строка

Получить стоимость, срок доставки в пункт выдачи

Тип запроса: POST
Адрес ресурса: <Сервер>/sdd/hs/delivery_cost/pvz
Формат запроса: JSON RPC 2.0
Сервис требует авторизации

Тело запроса должно содержать:
token: токен, для работы с API
id_city: идентификатор города-получателя
weight: вес заказа (необязательный, 1 кг по умолчанию)
id_city_from: город-отправитель
cod_amount: сумма наложенного платежа (не обязательный, по умолчанию без платежа)

В ответе содержится информация о возможных пунктах выдачи, сроках и стоимости доставки

pick_up_point: название пункта выдачи, тип Строка
shipping_price: стоимость доставки
delivery_period: срок доставки,
how_to_get: описание проезда до пункта
work_schedule: расписание работы
code: код пункта в системе Доброгост
sub_type_pvz: подтип пункта выдачи
cash_pay: возможно оплатить наличными
card_pay: возможно оплатить картой
prepaid: выдача предоплаченных заказов
max_weight_one_place: максимальный вес одного места
max_length: максимальная длина
max_width: максимальная ширина
max_height: максимальная высота
max_weight: максимальный вес всего заказа

Получить стоимость курьерской доставки

Тип запроса: POST
Адрес ресурса: <Сервер>/sdd/hs/delivery_cost/courier
Формат запроса: JSON RPC 2.0
Сервис требует авторизации

Тело запроса должно содержать:
token: токен, для работы с API
id_city: идентификатор города-получателя
weight: вес заказа (необязательный, 1 кг по умолчанию)
id_city_from: город-отправитель
cod_amount: сумма наложенного платежа (не обязательный, по умолчанию без платежа)

Ответ содержит:
shipping_price: стоимость курьерской доставки

Получить историю статусов заказа

Тип запроса: GET
Адрес ресурса: <Сервер>/sdd/hs/tracking/track_number/<трек-номер заказа>
Формат запроса: JSON RPC 2.0
Сервис требует авторизации

В ответе содержится информация о статусах заказа:

status: статус заказа
date: дата смена статуса,
city_from: город-отправитель,
city_to: город-получатель,
client: магазин-отправитель заказа

Создать или редактировать заказ

Тип запроса:
POST

Формат запроса:
JSON RPC 2.0

Адрес ресурса:
<Сервер>sdd/hs/jsonrpc_api/request

Создать или обновить заказ:
client: токен клиента.
orders: массив заказов.
— — order_id: номер заказа — уникальный номер в рамках одного клиента. Максимальная длина — 25 символов.
— — city_from: город отправки — возможные значения: уникальный код города в системе СДД / наименование города в системе СДД / индекс города / КОД КЛАДР города. При пустом значении, город будет определен по данным контрагента.
— — region_to: регион доставки — используется для более точного определения города доставки. Возможные значения: уникальный код региона в системе СДД / наименование региона в системе СДД / КОД КЛАДР региона.
— — city_to: город доставки — возможные значения: уникальный код города в системе СДД / наименование города в системе СДД / индекс города / КОД КЛАДР города. При наличии указанного Региона доставки, поиск будет осуществляться внутри указанного региона.
— — delivery_date: дата доставки — ориентировочная дата доставки. Предпочтительные форматы: «2013-10-25» / «25.10.2013».
— — delivery_address: адрес получателя — адрес для курьерской доставки. Используется при пустом значении поля «Пункт выдачи».
— — delivery_time_from: интервал доставки (с) — нижняя граница интервала доставки. Целое число. Используется при пустом значении поля «Пункт выдачи».
— — delivery_time_to: интервал доставки (до) — верхняя граница интервала доставки. Целое число. Используется при пустом значении поля «Пункт выдачи».
— — pickup_place: пункт выдачи — возможные значения: уникальный код пункт в системе СДД / наименование пункта выдачи в системе СДД / адрес пункта выдачи в системе СДД. Принадлежность указываемого пункта выдачи указанному городу доставки — обязательна.
— — cod_amount: сумма наложенного платежа*** — стоимость заказа без учета скидок и наценок. Должна быть равна сумме всех товаров текущего заказа.
— — insurance_amount: сумма страховая — оценочная стоимость заказа. Используется для страховки.
— — recipient_name: ФИО получателя — данные получателя. Обязательно к заполнению.
— — recipient_phone: телефон получателя — номер телефона получателя для связи и отправки СМС. Предпочтительный формат: «70001112233». Обязательно к заполнению.
— — recipient_email: электронный адрес получателя для отправки копии чека.
— — comment: комментарий — произвольный комментарий для службы доставки.
— — partial_allowed: частичный выкуп разрешен — признак определяющий возможность частичной реализации заказа. Варианты: «да» / 1, «нет» / 0. По умолчанию: 0.
— — without_receipt: чек не нужен — признак определяющий вид договора. Варианты: «да» / 1, «нет» / 0. По умолчанию: 0.
— — cfd_amount: сумма услуги «Доставка» для получателя —
— — reset_cfd_threshold: минимальный порог для бесплатной услуги «Доставка» – значение, при достижении которого сумма услуги «Доставка» для получателя не будет взиматься. При пустом значении или значении поля равным 0, сумма услуги «Доставка» будет взыматься безусловно.
— — cfd_required: обязательная оплата услуги «Доставка» при полном отказе — признак определяющий обязательность взимания суммы услуги «Доставка» при полном отказе от выкупа. Варианты: «да» / 1, «нет» / 0. По умолчанию: 0.
— — discount_amount: сумма скидки для получателя —
— — enable_discount_threshold: минимальный порог для использования скидки – значение, при достижении которого сумма скидки для получателя будет вычитаться из итоговой суммы выкупа. При пустом значении или значении поля равным 0, сумма скидки для получателя будет вычитаться из итоговой суммы выкупа безусловно.
— — order_barcode: штрихкод — уникальный штрихкод заказа. Максимальная длина — 200 символов. При пустом значении штрихкод будет сгенерирован системой. Формат сгенерированного штрихкода: Code128B.
— — quantity_place: количество мест в заказе — При пустом значении бедет записано как 1.
— — zabor: признак забора — признак определяющий доставка это или забор. Варианты: «да» / 1, «нет» / 0. По умолчанию: 0.
— — is_tarificated_sms: SMS-уведомление получателя — признак услуги СМС-уведомления. Варианты: «да» / 1, «нет» / 0. По умолчанию: 0.
— — phone_sms: Телефон получателя для SMS. +7 + Число 10 символов
— — approval_date: Согласование доставки оператором call-центра — признак услуги согласования даты доставки. Варианты: «да» / 1, «нет» / 0. По умолчанию: 0.
— — admission_to_the_pvz: Оповещение о поступлении заказа в ПВЗ оператором call-центра — признак услуги оповещения о поступлении в ПВЗ. Варианты: «да» / 1, «нет» / 0. По умолчанию: 0.
— — site: поле Сайт. Максимальная длина — 100 символов.
— — payment_cards_allowed: Оплата картами разрешена . Варианты: «да» / 1, «нет» / 0. По умолчанию: 0.
— — items: массив товаров
— — — vendor_code: артикул — значение для поиска соответствующего товара в базе. В случае отсутствия в БД — товар создается. Обязательно к заполнению.
— — — name: наименование — значение используется при создании товара, когда поиск по артикулу не дал результатов. Обязательно к заполнению.
— — — count: количество — количество единиц передаваемого товара. Строго положительное, целое число. Обязательно к заполнению.
— — — price: цена — стоимость одной(!) единицы товара. Пустое поле приравнивается к нулю.
— — — nds: ставка НДС — ставка НДС для указанной позиции товара. Варианты: 0, 10, 18, 20 и пустое поле. По умолчанию: «НДС не облагается».
— — — item_barcode: штрихкод товара — уникальный штрихкод товара. Используется для отличия товаров с общим артикулом, но разными штрихкодами. Максимальная длина: 200 символов.

Город











Ищем партнёров
Для получения подробной информации об открытии представительства позвоните по номеру 8 (800) 201 68 51 (звонок бесплатный) или заполните заявку.