Адрес службы: GET
http://api.alemtat.kz/web/{ext}/FLFL/getDocuments?StationCode={StationCode}&DocumentType={DocumentType}&CompliteStatus={CompliteStatus}&BeginDate={BeginDate}&Skip={Skip}&Take={Take}&ApiKey={ApiKey}
Получение списка товарных документов. Список имеет обратный порядок (В начале указаны последнии документы).
Информация о запросе
URI параметры
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| StationCode |
Код станции по которой запрашиваются товарные документы. По умолчанию возвращаются товарные документы по всем станциям. |
string |
Нет описания |
| DocumentType |
Вид товарного документа. Ограничевает выборку по виду товарного документа. По умолчанию возвращаются все товарные документы. Виды товарных докумеентов слудующие: IncomingAct - АКТ ПРИЕМА; OutcomingAct - АКТ СПИСАНИЯ; MovingAct - АКТ ПЕРЕМЕЩЕНИЯ; Order - ЗАКАЗ; ROrder - ВОЗВРАТ |
string |
Нет описания |
| CompliteStatus |
Статус товарного документа. Может принимать следующие значения: None: НЕ ОБРАБОТАН; Working: В ОБРАБОТКЕ; Complite: ОБРАБРТАН; Reject: Анулирован. По умолчанию возвращаются товарные документы с любым статусом. |
string |
Нет описания |
| BeginDate |
Начальная дата. Ограничивает список получаемых товарных документов задавая их начальную дату, по умолчанию будет возвращатся полный список. Формат: "yyyy-MM-dd". |
string |
Нет описания |
| Skip |
Пропустить. Кол-во записей которое необходимо пропустить в результирующей выборке. По умолчанию имеет значение "0". |
integer |
Default value is 0 |
| Take |
Кол-во записей в результирующей выборке. По умолчанию имеет значение "100". Не может превышать заначение "500". |
integer |
Default value is 100 |
| ext |
Формат данных. JSON или XML. |
string |
Нет описания |
| ApiKey |
Выданный API-ключ |
string |
Обязательный Используется для получения доступа к данным |
Информация об ответе
Описание ответа
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| FullCount |
Кол-во записей всего. |
integer |
Нет описания |
| Skipped |
Кол-во пропущеных записей. |
integer |
Нет описания |
| Count |
Кол-во записей в полученом списке. |
integer |
Нет описания |
| Items |
Список товарных документов. |
Коллекция из FulfilmentDocumentShort |
Нет описания |
Форматы ответа
application/json, text/json
{
"FullCount": 1,
"Skipped": 2,
"Count": 3,
"Items": [
{
"DocumentId": "sample string 1",
"Number": "sample string 2",
"Date": "2026-02-11T02:01:17.2547103+05:00",
"DocumentType": "sample string 4",
"StationCode": "sample string 5",
"CompliteStatus": "sample string 6",
"CompliteDate": "2026-02-11T02:01:17.2547103+05:00"
},
{
"DocumentId": "sample string 1",
"Number": "sample string 2",
"Date": "2026-02-11T02:01:17.2547103+05:00",
"DocumentType": "sample string 4",
"StationCode": "sample string 5",
"CompliteStatus": "sample string 6",
"CompliteDate": "2026-02-11T02:01:17.2547103+05:00"
}
]
}
application/xml, text/xml
<ResultListFulfilmentDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
<Count>3</Count>
<FullCount>1</FullCount>
<Items>
<FulfilmentDocumentShort>
<CompliteDate>2026-02-11T02:01:17.2547103+05:00</CompliteDate>
<CompliteStatus>sample string 6</CompliteStatus>
<Date>2026-02-11T02:01:17.2547103+05:00</Date>
<DocumentId>sample string 1</DocumentId>
<DocumentType>sample string 4</DocumentType>
<Number>sample string 2</Number>
<StationCode>sample string 5</StationCode>
</FulfilmentDocumentShort>
<FulfilmentDocumentShort>
<CompliteDate>2026-02-11T02:01:17.2547103+05:00</CompliteDate>
<CompliteStatus>sample string 6</CompliteStatus>
<Date>2026-02-11T02:01:17.2547103+05:00</Date>
<DocumentId>sample string 1</DocumentId>
<DocumentType>sample string 4</DocumentType>
<Number>sample string 2</Number>
<StationCode>sample string 5</StationCode>
</FulfilmentDocumentShort>
</Items>
<Skipped>2</Skipped>
</ResultListFulfilmentDocument>