Изменения в условия доставки
Описание
Позволяет внести изменения в условия доставки
URI Parameters
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| access_token | string | Токен управления доставкой отправления, получается методом delivery (см описание delivery) |
Query Parameters
Параметры запроса
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| token | string | Токен доступа к апи | |
| dates[delivery][date] | string | Начало временного интервала | |
| dates[delivery][to] | string | Конец временного интервала | |
| pvz[guid] | string | Уникальный идентификатор (GUID) ПВЗ. Если указан ПВЗ, передавать другие изменения запрещается. | |
| geography[address] | string | Новый адрес доставки | |
| geography[index] | int | Индекс доставки |
Response Parameters
Описание параметров в ответе.
delivery возвращает объект data , содержащий следующую информацию о доставке:
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| guid | string | Идентификатор накладной | |
| number | string | Номер накладной | |
| access_token | string | Сгенерированный токен для управления доставкой | |
| access_token_expire_at | string | Время окончания жизни токена по MSK (токен генерируется на 10 минут) | |
| courier_number | string | Номер курьера | |
| tracking | array | Массив трекинга по накладной (возвращается первое и последнее значения) | |
| dates | object | Информация по дате с перечнем доступных для изменения дат | |
| geography | object | Информация по географии доставки | |
| pvz | object | Информация по ПВЗ | |
| pvz_available | array |
Содержит массив возможных отделений для переадресации. По структуре каждый элемент массива повторяет элемент pvz (см Response - pvz) |
|
| time_changes | number | Число доступных изменений времени доставки | |
| address_changes | number | Число доступных изменений адреса доставки | |
| cancel_reasons | array |
Список доступных причин для отмены. Содержит информацию в виде массива объектов вида { "guid": "2f7b5572-1ffe-11ea-80d7-7cd30aec6901", "name": "Качество, брак товара" } где : guid - код причины отмены name - текстовое обозначение причины отмены |
|
| required_fields | array | Обязательные поля | |
| disabled_fields | array | Отключенные поля | |
| readdress | object |
Содержит информацию о возможности переадресации на каждый вид доставки в виде { "pvz": false, "address": true } |
|
| cargo | object |
Содержит информацию о грузе в виде: "weight" - вес отправления в кг "qty" - количество грузомест "cod" - оплата при получении |
Response - tracking
Содержит информацию о прошедших событиях
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| date | datetime |
Дата события в расширенном формате ISO 8601 Пример: 2021-03-25T14:53:25 |
|
| name | string | Наименование события, возвращает объект содержащий значения на русском (ru) и английском (en) языке | |
| info | string | Описание события, возвращает объект содержащий значения на русском (ru) и английском (en) языке |
Response - dates
Содержит информацию о времени, фактах забора и доставки
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| take | object |
Содержит информацию о заборе, где: enabled - логическая отметка совершен ли забор date - дата забора в формате ISO 8601 (YYYY‑MM‑DD) from - начало временного промежутка забора в формате ISO 8601 (HH:mm:ss) to - конец временного промежутка забора в формате ISO 8601 (HH:mm:ss) |
|
| delivery | object |
Содержит информацию о доставке, где: enabled - логическая отметка совершен ли забор date - дата доставки в формате ISO 8601 (YYYY‑MM‑DD) from - начало временного промежутка доставки в формате ISO 8601 (HH:mm:ss) to - конец временного промежутка доставки в формате ISO 8601 (HH:mm:ss) |
|
| delivery_available | array |
Содержит в себе массив доступных интервалов доставки, где: date - дата доставки в формате ISO 8601 (YYYY‑MM‑DD) intervals - содержит время доставки from / to - начало и конец временного промежутка доставки в формате ISO 8601 (HH:mm:ss) |
Response - geography
Содержит информацию о географии доставки
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| guid | string | GUID географии доставки | |
| country | string | Наименование страны доставки | |
| region | string | Наименование региона доставки | |
| city | string | Наименование города доставки | |
| address | string |
Полный адрес одной строкой Пример: 603011, обл Нижегородская, г Нижний Новгород, ул Июльских Дней, дом 9 |
|
| index | string | Индекс доставки | |
| info | string | Дополнительная информация доставки |
Response - pvz
Содержит информацию о отделении доставки
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| name | string | Наименование отделения доставки | |
| guid | string | GUID отделения доставки | |
| type_name | string | Тип сотрудничества | |
| geo | object |
Содержит информацию о координатах отделения Пример: { "latitude": "56.303351", "longitude": "43.942194" } |
|
| default | boolean | ||
| comment | string | Дополнительная информация о отделении, может иметь значение null | |
| driving_directions | string | Описание местоположения отделения | |
| services | object | Содержит информацию о лимитах и услугах предоставляемых отделением | |
| address | string | Полный адрес отделения | |
| phone | array | Массив контактных номеров телефона отделения | |
| array | Массив email номеров телефона отделения | ||
| work_time | array |
Содержит информацию о времени работы точки выдачи в виде объектов { "day": "Суббота", "from": "8:01:00", "to": "22:01:00" } для каждого активного дня недели |
Response - pvz - services
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| limits | object | Содержит информацию о ограничениях принятых на точке выдачи | |
| issuance_of_shipping | boolean | Страховка доставки | |
| payment_by_card | boolean | Оплата картой | |
| payment_by_cash | boolean | Оплата наличными | |
| receiving_sending | boolean | Возможность отправки с отделения | |
| try_on | boolean | Примерка | |
| partial_buyout | boolean | Частичный выкуп | |
| storage_life_days | number | Срок хранения | |
| fz54 | boolean | Наличие кассы | |
| partialPrePay | boolean | Частичная предоплата |
Response - pvz - services - limits
Содержит информацию о ограничениях принятых на точке выдачи
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| weight | number | Максимальный вес (кг) отправления, принимаемый точкой | |
| hight | number | Максимальная высота (см) отправления, принимаемая точкой | |
| length | number | Максимальная длинна (см) отправления, принимаемая точкой | |
| width | number | Максимальная ширина (см) отправления, принимаемая точкой | |
| qty | number | Максимальное количество мест в отправления, принимаемое точкой | |
| max_dimension | number | Максимальное измерение (см) отправления, принимаемое точкой | |
| sum_dimension | number | Максимальная сумма измерений (см) отправления, принимаемая точкой | |
| cod | number | Максимальная стоимость отправления, принимаемая точкой |
Возможные ошибки
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| {"errors": {"dates.delivery": ["Выбранная дата и интервал недоступны"]}} | object | Выбранная дата или интервал отличаются от тех, что были в ответе на запрос GET, в возможной для изменениях информации по доставке | |
| {"error": "Документ еще нельзя изменять"} | object | Накладная не проведена в базе карго |
Примеры запроса/ответа
http://lk.cse.ru/api/delivery/9760857e059ce54fd11f37b61068eb99?token=29b33f62b545462acb10728c9f3eb4b6&geography[address]=Мира57 {
"data": {
"guid": "62df69d6-6035-11ec-833a-005056bbb928",
"number": "88-495-0003118",
"access_token": "c1fc1b43f3719cf668c2d4f561a53114",
"access_token_expire_at": "2021-12-20T14:30:36",
"courier_number": "",
"tracking": [
{
"date": "2021-12-18T22:04:56",
"name": {
"ru": "Зарегистрирована накладная",
"en": "Create document"
},
"info": {
"ru": "По документу: Заказ 88-495-0003118 от 14.12.2021 18:06:52, зарегистрирована накладная: 88-495-0003118",
"en": ""
}
}
],
"dates": {
"take": {
"enabled": true,
"date": "2021-12-15",
"from": "09:00:00",
"to": "18:00:00"
},
"delivery": {
"enabled": true,
"date": "2021-12-17",
"from": "09:00:00",
"to": "18:00:00"
},
"delivery_available": [
{
"date": "2021-12-21",
"intervals": [
{
"from": "09:00:00",
"to": "18:00:00"
}
]
},
{
"date": "2021-12-22",
"intervals": [
{
"from": "09:00:00",
"to": "18:00:00"
}
]
}
//……………………………
]},
"geography": {
"guid": "d9881c7c-442b-11dc-9497-0015170f8c09",
"country": "РОССИЯ",
"region": "Нижегородская обл",
"city": "Нижний Новгород г",
"address": "603011, обл Нижегородская, г Нижний Новгород, ул Июльских Дней, дом 9",
"index": "",
"info": ""
},
"pvz": {
"name": "ПВЗ 5post на кассе Пятерочки 30EY",
"guid": "7d70ad34-017a-11eb-80dc-7cd30aec6901",
"type_name": "Agent",
"geo": {
"latitude": "56.303351",
"longitude": "43.942194"
},
"default": false,
"comment": null,
"driving_directions": "Выдача заказов осуществляется на кассе магазина «Пятёрочка»",
"services": {
"limits": {
"weight": 15,
"hight": 36,
"length": 0,
"width": 40,
"qty": 1,
"max_dimension": 120,
"sum_dimension": 0,
"cod": 100000
},
"issuance_of_shipping": true,
"payment_by_card": true,
"payment_by_cash": true,
"receiving_sending": false,
"try_on": false,
"partial_buyout": false,
"storage_life_days": 7,
"fz54": true,
"partialPrePay": false
},
"address": ", 603011, обл Нижегородская, г Нижний Новгород, ул Июльских Дней, дом 9",
"phone": [],
"email": [],
"work_time": [
{
"day": "Суббота",
"from": "8:01:00",
"to": "22:01:00"
},
{
"day": "Воскресенье",
"from": "8:01:00",
"to": "22:01:00"
},
{
"day": "Понедельник",
"from": "8:01:00",
"to": "22:01:00"
},
{
"day": "Вторник",
"from": "8:01:00",
"to": "22:01:00"
},
{
"day": "Среда",
"from": "8:01:00",
"to": "22:01:00"
},
{
"day": "Четверг",
"from": "8:01:00",
"to": "22:01:00"
},
{
"day": "Пятница",
"from": "8:01:00",
"to": "22:01:00"
}
]
},
"pvz_available": [
{
"name": "Офис Черкесск на ул. Первомайская",
"guid": "8cb28d8c-c183-11e8-80c9-7cd30aebf951",
"type_name": "Office",
"geo": {
"latitude": "44.226626",
"longitude": "42.051272"
},
"default": false,
"comment": null,
"driving_directions": "Остановка \"Первомайская\". От остановки пройти прямо, по Первомайской улице, на восток 400м. С левой стороны, на углу дома 35 на пересечении с ул.Пушкинская, вход в магазин \"Гранд\". Войти в магазин, ПВЗ во втором зале справа.",
"services": {
"limits": {
"weight": 30,
"hight": 0,
"length": 0,
"width": 0,
"qty": 0,
"max_dimension": 0,
"sum_dimension": 0,
"cod": 200000
},
"issuance_of_shipping": true,
"payment_by_card": true,
"payment_by_cash": true,
"receiving_sending": true,
"try_on": true,
"partial_buyout": true,
"storage_life_days": 14,
"fz54": true,
"partialPrePay": true
},
"address": ", 369000 Респ Карачаево-Черкесская, г Черкесск, ул Первомайская, дом 35",
"phone": [
[
"89886156567"
]
],
"email": [],
"work_time": [
{
"day": "Понедельник",
"from": "9:00:00",
"to": "18:00:00"
},
{
"day": "Вторник",
"from": "9:00:00",
"to": "18:00:00"
},
{
"day": "Среда",
"from": "9:00:00",
"to": "18:00:00"
},
{
"day": "Четверг",
"from": "9:00:00",
"to": "18:00:00"
},
{
"day": "Пятница",
"from": "9:00:00",
"to": "18:00:00"
}
]
}
//…………………………………..
],
"time_changes": 5,
"address_changes": 5,
"cancel_reasons": [
{
"guid": "2f7b5572-1ffe-11ea-80d7-7cd30aec6901",
"name": "Качество, брак товара"
},
{
"guid": "7ca03899-1ffe-11ea-80d7-7cd30aec6901",
"name": "Не подошел товар"
},
{
"guid": "892c3793-1ffe-11ea-80d7-7cd30aec6901",
"name": "Неполная комплектация заказа"
},
{
"guid": "9767d14e-1ffe-11ea-80d7-7cd30aec6901",
"name": "Нет необходимости в заказе"
},
{
"guid": "9dbaee43-1ffe-11ea-80d7-7cd30aec6901",
"name": "Не устраивают условия доставки"
},
{
"guid": "aa27ed77-1ffe-11ea-80d7-7cd30aec6901",
"name": "Долгое ожидание заказа"
}
//…………………………………..
],
"required_fields": [],
"disabled_fields": [],
"readdress": {
"pvz": false,
"address": true
},
"cargo": {
"weight": 0.1,
"qty": 1,
"cod": 0
}
}
} 