Отгрузка заказов
- /api/lite/pickup_dates
- /api/lite/pickup_dates/planned
- /api/lite/takeout_list
- /api/lite/takeout_list/print
/api/lite/pickup_dates
Информация о возможных датах приезда курьера
/api/lite/pickup_dates
Возвращает информацию о ближайших возможных датах приезда курьера в указанный период.
Запрос:
| Параметр | Тип\формат | Описание |
|
from |
date | Дата, начиная с которой идет поиск плановых дат приезда курьера. Включительно. |
|
to |
date |
Дата, по которую идет поиск плановых дат приезда курьера. Включительно. |
Результат запроса:
| Параметр | Тип\формат | Описание |
|
dates |
array |
Массив dates содержит только даты, в которые можно запланировать приезд курьера. |
Пример результата запроса:
{
"success": true,
"dates": [
{
"date":"2019-01-09",
"planned": true,
"intervals":[
{
"readableTimeInterval": "Весь день",
"startDateTime": "2018-02-22T09:00:00",
"startTimeHour": 9,
"startTimeMinute": 0,
"finishDateTime": "2018-02-22T18:00:00",
"finishTimeHour": 18,
"finishTimeMinute": 0,
"planned": true
},
{
"readableTimeInterval": "9 - 14",
"startDateTime": "2018-02-22T09:00:00",
"startTimeHour": 9,
"startTimeMinute": 0,
"finishDateTime": "2018-02-22T14:00:00",
"finishTimeHour": 14,
"finishTimeMinute": 0,
"planned": false
}
]
}
]
}Ошибка:
{
"success": false,
"errors": [
{
"code": 0,
"message": "Текст ошибки"
}
]
}/api/lite/pickup_dates/planned
Информация о запланированных датах приезда курьера
/api/lite/pickup_dates/planned
Возвращает информацию о всех запланированных датах приезда курьера - как будущих так и прошлых.
Результат отсортирован по датам начиная с самой свежей.
Результат запроса:
{
"success": true,
"dates": [
{
"date":"2019-01-09",
"planned": true,
"intervals":[
{
"readableTimeInterval": "Весь день",
"startDateTime": "2018-02-22T09:00:00",
"startTimeHour": 9,
"startTimeMinute": 0,
"finishDateTime": "2018-02-22T18:00:00",
"finishTimeHour": 18,
"finishTimeMinute": 0,
"planned": true
},
{
"readableTimeInterval": "9 - 14",
"startDateTime": "2018-02-22T09:00:00",
"startTimeHour": 9,
"startTimeMinute": 0,
"finishDateTime": "2018-02-22T14:00:00",
"finishTimeHour": 14,
"finishTimeMinute": 0,
"planned": false
}
]
}
]
}Ошибка:
{
"success": false,
"errors": [
{
"code": 0,
"message": "Текст ошибки"
}
]
}/api/lite/takeout_list
Получение перечня реестров отгрузки
/api/lite/takeout_list
Возвращает информацию о созданных реестрах отгрузки по данному клиенту.
Запрос:
|
Параметр
|
Тип\формат | Описание |
|
date_from |
date | Дата, начиная с которой идет поиск реестров. Включительно. (необязательный) |
|
date_to |
date |
Дата, по которую идет поиск реестров. Включительно. (необязательный) |
| id | String | Номер конкретного реестра (необязательный) |
| page | Integer | Страница (необязательный) |
| size | Integer | Число элементов на странице (необязательный) |
| order | String | Поле для сортировки (необязательный) |
Результат запроса:
{
"success": true,
"recordsTotal": 59,
"takeoutLists": [
{
"id": "1069",
"date": "2020-04-16 22:34:30",
"updateTs": "2020-04-16 23:21:03.435",
"status": "SHIPPED",
"orders": [
{
"id": "3318-1166",
"date": "2020-04-11",
"customer": "Караваева Елена Олеговна"
}
],
"takeoutDate": "2020-05-10",
"takeoutHourStart": "14:00",
"takeoutHourEnd": "18:00",
"gatherTrackingNum": "100065493",
"gatherType": "COURIER", // SELF_PICKUP
"gatherStatus": "AWAITING_CARGO", //CREATED, CARGO_SHIPPED, HOLD, CANCELED
"warehouseName": "Свой склад",
"warehouseCode": "776069fa-f578-9ceb-e773-db7b89968b5f",
"deliveryCode": "ae12b4f1-c8e5-aa52-0a68-9d102d4624fe",
"deliveryTitle": "Global Delivery",
"gatherType": "COURIER",
"comment": "комментарий",
"availableForChanges": false,
"warehouseManager": {
"name": "Склада",
"surname": "Менеджер",
"patronymic": "",
"fullName": "Осман Идракович Кишиев ",
"phone": "+79264642812",
"rawPhone": "+7 (926) 464 28 12",
"alternativePhone": "",
"email": "Info@mossmore.ru",
"post": null,
"personType": null
}
},
{
"id": "1067",
"date": "2020-04-11 17:00:09",
"updateTs": "2020-04-11 17:46:35.009",
"status": "SHIPPED",
"orders": [
{
"id": "3318-1167",
"date": "2020-04-12",
"customer": "Караваева Елена Олеговна"
}
],
"takeoutDate": "2020-05-10",
"takeoutHourStart": "09:00",
"takeoutHourEnd": "14:00",
"gatherTrackingNum": "100065493",
"gatherType": "COURIER",
"gatherStatus": "AWAITING_CARGO",
"warehouseName": "Свой склад",
"warehouseCode": "776069fa-f578-9ceb-e773-db7b89968b5f",
"deliveryCode": "ae12b4f1-c8e5-aa52-0a68-9d102d4624fe",
"deliveryTitle": "Global Delivery",
"gatherType": "COURIER",
"warehouseManager": {
"name": "Склада",
"surname": "Менеджер",
"patronymic": "",
"fullName": "Осман Идракович Кишиев ",
"phone": "+79264642812",
"rawPhone": "+7 (926) 464 28 12",
"alternativePhone": "",
"email": "Info@mossmore.ru",
"post": null,
"personType": null
}
}
]
}Ошибка:
{
"success": false,
"errors": [
{
"code": 0,
"message": "Текст ошибки"
}
]
}
Создание/редактирование реестра отгрузки
/api/lite/takeout_list
Создает или редактирует (при наличии параметра id) реестр отгрузки
Пример запроса:
{
"id": "1069",
"orders": [
{
"id": "3318-1166"
},
{
"id": "3318-1167"
}
],
"takeoutDate": "2020-05-10",
"takeoutHourStart": "14:00",
"takeoutHourEnd": "18:00",
"warehouseName": "Свой склад",
"warehouseCode": "776069fa-f578-9ceb-e773-db7b89968b5f",
"gatherType": "COURIER",
"comment": "комментарий"
}Результат:
{
"success": true,
"id": "1069"
"errors": []
}Ошибка:
{
"success": false,
"errors": [
{
"code": 0,
"message": "Текст ошибки"
}
]
}Удаление/отмена реестра отгрузки
/api/lite/takeout_list
Отменяет реестр отгрузки, все отправления в нем исключаются из реестра.
Пример запроса:
{
"id": "1069"
}Результат:
{
"success": true,
"id": "1069",
"errors": []
}Ошибка:
{
"success": false,
"errors": [
{
"code": 0,
"message": "Текст ошибки"
}
]
}
Получение ошибок выгрузки по реестру отгрузки
/api/lite/takeout_list/commit-errors
Параметр: id реестра
Результат:
{
"success": true,
"id": "1069",
"warnings": [
"3318-1167: Некорректные данные получателя"
]
"errors": []
}Ошибка:
{
"success": false,
"errors": [
{
"code": 0,
"message": "Текст ошибки"
}
]
}/api/lite/takeout_list/print
Получение печатной формы реестра отгрузки
/api/lite/takeout_list/print
/api/lite/takeout_list/print?id=[ид отгрузки]&form=act
Получение печатной формы в pdf для указанного реестра отгрузки
Параметры: id - номер реестра
form - вид печатной формы, по умолчанию "act"
Например:
/api/lite/takeout_list/print?id=1234&form=act
Печатная форма возвращается в формате base64.
Успех:
{
"success": true,
"content" : "base64data"
}Ошибка:
{
"success": false,
"errors": [
{
"code": 0,
"message": "Текст ошибки"
}
]
}