# Отгрузка заказов

# /api/lite/pickup_dates

### <span style="color: #000000;">Информация о возможных датах приезда курьера</span>

<span style="color: #000000;">/api/lite/pickup\_dates</span>

Возвращает информацию о ближайших возможных датах приезда курьера в указанный период.

#### **Запрос**:

<table class="relative-table wrapped confluenceTable tablesorter tablesorter-default stickyTableHeaders" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%A2%D0%B8%D0%BF%5C%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%82-" role="grid" style="width: 99.9068%; padding: 0px;"><tbody aria-live="polite" aria-relevant="all"><tr><td style="width: 33.3333%;">**Параметр**</td><td style="width: 33.3333%;">**Тип\\формат**</td><td style="width: 95.9271%;">**Описание**</td></tr><tr role="row"><td class="confluenceTd" style="width: 33.3333%;">from

</td><td class="confluenceTd" style="width: 33.3333%;">date</td><td class="confluenceTd" style="width: 95.9271%;">Дата, начиная с которой идет поиск плановых дат приезда курьера. Включительно.</td></tr><tr role="row"><td class="confluenceTd" style="width: 33.3333%;">to

</td><td class="confluenceTd" style="width: 33.3333%;">date</td><td class="confluenceTd" style="width: 95.9271%;">Дата, по которую идет поиск плановых дат приезда курьера. Включительно.

</td></tr></tbody></table>

#### **Результат запроса:**

<table class="relative-table wrapped confluenceTable tablesorter tablesorter-default stickyTableHeaders" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%A2%D0%B8%D0%BF%5C%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%82--0" role="grid" style="width: 100.001%; padding: 0px;"><tbody aria-live="polite" aria-relevant="all"><tr><td style="width: 33.3333%;">**Параметр**</td><td style="width: 33.3333%;">**Тип\\формат**</td><td style="width: 95.9271%;">**Описание**</td></tr><tr role="row"><td class="confluenceTd" style="width: 33.3333%;">dates

</td><td class="confluenceTd" style="width: 33.3333%;">array</td><td class="confluenceTd" style="width: 95.9271%;">Массив dates содержит только даты, в которые можно запланировать приезд курьера.

</td></tr></tbody></table>

#### **Пример результата запроса:**

```JSON
{
    "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
                }
            ]
        }
    ]
}
```

#### **Ошибка:** 

```JSON
{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}
```

# /api/lite/pickup_dates/planned

### <span style="color: #000000;">Информация о запланированных датах приезда курьера</span>

<span style="color: #000000;">/api/lite/pickup\_dates/planned</span>

Возвращает информацию о всех запланированных датах приезда курьера - как будущих так и прошлых.

Результат отсортирован по датам начиная с самой свежей.

#### **Результат запроса:**

```JSON
{
    "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                   
                }
            ]
        }
    ]
}
```

#### **Ошибка:** 

```JSON
{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}
```

# /api/lite/takeout_list

### <span style="color: #000000;">Получение перечня реестров отгрузки</span>

<span style="color: #000000;">/api/lite/takeout\_list</span>

Возвращает информацию о созданных реестрах отгрузки по данному клиенту.

#### **Запрос:**

<table class="relative-table wrapped confluenceTable tablesorter tablesorter-default" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%C2%A0-%D0%A2%D0%B8%D0%BF%5C%D1%84%D0%BE%D1%80%D0%BC%D0%B0" role="grid" style="width: 812px;"><tbody aria-live="polite" aria-relevant="all"><tr><td style="width: 102px;">**Параметр**</td><td style="width: 106px;">**Тип\\формат**</td><td style="width: 604px;">**Описание**</td></tr><tr role="row"><td class="confluenceTd" style="width: 102px;">date\_from

</td><td class="confluenceTd" style="width: 106px;">date</td><td class="confluenceTd" style="width: 604px;">Дата, начиная с которой идет поиск реестров. Включительно. (необязательный)</td></tr><tr role="row"><td class="confluenceTd" style="width: 102px;">date\_to

</td><td class="confluenceTd" style="width: 106px;">date</td><td class="confluenceTd" style="width: 604px;">Дата, по которую идет поиск реестров. Включительно.

(необязательный)

</td></tr><tr role="row"><td class="confluenceTd" style="width: 102px;">id</td><td class="confluenceTd" style="width: 106px;">String</td><td class="confluenceTd" style="width: 604px;">Номер конкретного реестра (необязательный)</td></tr><tr role="row"><td class="confluenceTd" style="width: 102px;">page</td><td class="confluenceTd" style="width: 106px;">Integer</td><td class="confluenceTd" style="width: 604px;">Страница (необязательный)</td></tr><tr role="row"><td class="confluenceTd" style="width: 102px;">size</td><td class="confluenceTd" style="width: 106px;">Integer</td><td class="confluenceTd" style="width: 604px;">Число элементов на странице (необязательный)</td></tr><tr role="row"><td class="confluenceTd" style="width: 102px;">order</td><td class="confluenceTd" style="width: 106px;">String</td><td class="confluenceTd" style="width: 604px;">Поле для сортировки (необязательный)</td></tr></tbody></table>

#### **Результат запроса**:

```JSON
{   
    
    "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
            }
        }
    ]
}
```

#### **Ошибка:** 

```JSON
{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}
```

### <span style="color: #000000;">Создание/редактирование реестра отгрузки</span>

<span style="color: #000000;"> /api/lite/takeout\_list</span>

Создает или редактирует (при наличии параметра id) реестр отгрузки

#### **Пример запроса:**

```JSON
{          
            "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": "комментарий"  
}
```

#### **Результат:** 

```JSON
{
"success": true,
"id": "1069"
"errors": []
}
```

#### **Ошибка:** 

```JSON
{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}
```

###  

### <span style="color: #000000;">Удаление/отмена реестра отгрузки</span>

<span style="color: #000000;">/api/lite/takeout\_list</span>

Отменяет реестр отгрузки, все отправления в нем исключаются из реестра.

#### **Пример запроса:**

```JSON
{          
     "id": "1069"
}
```

#### **Результат:** 

```JSON
{
"success": true,
"id": "1069",
"errors": []
}
```

#### **Ошибка:** 

```JSON
{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}
```

### <span style="color: #000000;">Получение ошибок выгрузки по реестру отгрузки</span>

<span style="color: #000000;">/api/lite/takeout\_list/commit-errors</span>

Параметр: id реестра

#### **Результат:** 

```JSON
{
"success": true,
"id": "1069",
"warnings": [
    "3318-1167: Некорректные данные получателя"
]
"errors": []
}
```

#### **Ошибка:** 

```JSON
{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}
```

# /api/lite/takeout_list/print

### <span style="color: #000000;">Получение печатной формы реестра отгрузки</span>

<span style="color: #000000;">/api/lite/takeout\_list/print</span>

`/api/lite/takeout_list/print?id=[ид отгрузки]&form=act`

Получение печатной формы в pdf для указанного реестра отгрузки

Параметры: id - номер реестра

form - вид печатной формы, по умолчанию "act"

Например:

`/api/lite/takeout_list/print?id=1234&form=act`

Печатная форма возвращается в формате base64.

#### **Успех:**

```JSON
{
  "success": true, 
  "content" : "base64data"
     
}
```

#### **Ошибка:** 

```JSON
{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}
```