Адрес службы: GET

http://api.alemtat.kz/web/{ext}/FLFL/getDocumentById?DocumentId={DocumentId}&ApiKey={ApiKey}


Получение информации о товарном документе.

Информация о запросе

URI параметры

НаименованиеОписаниеТипДополнительная информация
DocumentId

Уникальный идентификатор товарного документа.

string

Required

ext

Формат данных. JSON или XML.

string

Нет описания

ApiKey

Выданный API-ключ

string

Обязательный

Используется для получения доступа к данным

Информация об ответе

Описание ответа

НаименованиеОписаниеТипДополнительная информация
DocumentId

Уникальный идентификатор документа.

string

Нет описания

DocumentCaption

Наименование документа.

string

Нет описания

DocumentType

Вид документа.

string

Нет описания

Number

Номер документа.

string

Нет описания

Date

Дата документа.

date

Нет описания

StationCode

Код станции которая обрабатывает документ.

string

Нет описания

CompliteStatus

Статус выполнения товарных операций по документу. Может принимать следующие значения: None: НЕ ОБРАБОТАН; Working: В ОБРАБОТКЕ; Complite: ОБРАБРТАН; Reject: Анулирован.

string

Нет описания

CompliteDate

Конечная дата выполнения товарных операций по документу.

date

Нет описания

Products

Товарные еденицы декларированные в документе.

Коллекция из DocumentProductItem

Нет описания

Operations

Товарные операции выполненные по документу.

Коллекция из ProductOperation

Нет описания

Форматы ответа

application/json, text/json

Пример:
{
  "DocumentId": "sample string 1",
  "DocumentCaption": "sample string 2",
  "DocumentType": "sample string 3",
  "Number": "sample string 4",
  "Date": "2020-11-27T03:29:12.1299727+06:00",
  "StationCode": "sample string 6",
  "CompliteStatus": "sample string 7",
  "CompliteDate": "2020-11-27T03:29:12.1299727+06:00",
  "Products": [
    {
      "Article": "sample string 1",
      "DeclareValue": 2,
      "CompileValue": 3
    },
    {
      "Article": "sample string 1",
      "DeclareValue": 2,
      "CompileValue": 3
    }
  ],
  "Operations": [
    {
      "DocumentId": "sample string 1",
      "DocumentCaption": "sample string 2",
      "Article": "sample string 3",
      "CellId": "sample string 4",
      "CellNumber": "sample string 5",
      "CellCategory": "sample string 6",
      "StationCode": "sample string 7",
      "Storage": "sample string 8",
      "OperationDate": "2020-11-27T03:29:12.1299727+06:00",
      "OperationKind": "sample string 10",
      "OperationCode": "sample string 11",
      "OperationName": "sample string 12",
      "Value": 13
    },
    {
      "DocumentId": "sample string 1",
      "DocumentCaption": "sample string 2",
      "Article": "sample string 3",
      "CellId": "sample string 4",
      "CellNumber": "sample string 5",
      "CellCategory": "sample string 6",
      "StationCode": "sample string 7",
      "Storage": "sample string 8",
      "OperationDate": "2020-11-27T03:29:12.1299727+06:00",
      "OperationKind": "sample string 10",
      "OperationCode": "sample string 11",
      "OperationName": "sample string 12",
      "Value": 13
    }
  ]
}

application/xml, text/xml

Пример:
<FulfilmentDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
  <CompliteDate>2020-11-27T03:29:12.1299727+06:00</CompliteDate>
  <CompliteStatus>sample string 7</CompliteStatus>
  <Date>2020-11-27T03:29:12.1299727+06:00</Date>
  <DocumentCaption>sample string 2</DocumentCaption>
  <DocumentId>sample string 1</DocumentId>
  <DocumentType>sample string 3</DocumentType>
  <Number>sample string 4</Number>
  <Operations>
    <ProductOperation>
      <Article>sample string 3</Article>
      <CellCategory>sample string 6</CellCategory>
      <CellId>sample string 4</CellId>
      <CellNumber>sample string 5</CellNumber>
      <DocumentCaption>sample string 2</DocumentCaption>
      <DocumentId>sample string 1</DocumentId>
      <OperationCode>sample string 11</OperationCode>
      <OperationDate>2020-11-27T03:29:12.1299727+06:00</OperationDate>
      <OperationKind>sample string 10</OperationKind>
      <OperationName>sample string 12</OperationName>
      <StationCode>sample string 7</StationCode>
      <Storage>sample string 8</Storage>
      <Value>13</Value>
    </ProductOperation>
    <ProductOperation>
      <Article>sample string 3</Article>
      <CellCategory>sample string 6</CellCategory>
      <CellId>sample string 4</CellId>
      <CellNumber>sample string 5</CellNumber>
      <DocumentCaption>sample string 2</DocumentCaption>
      <DocumentId>sample string 1</DocumentId>
      <OperationCode>sample string 11</OperationCode>
      <OperationDate>2020-11-27T03:29:12.1299727+06:00</OperationDate>
      <OperationKind>sample string 10</OperationKind>
      <OperationName>sample string 12</OperationName>
      <StationCode>sample string 7</StationCode>
      <Storage>sample string 8</Storage>
      <Value>13</Value>
    </ProductOperation>
  </Operations>
  <Products>
    <DocumentProductItem>
      <Article>sample string 1</Article>
      <CompileValue>3</CompileValue>
      <DeclareValue>2</DeclareValue>
    </DocumentProductItem>
    <DocumentProductItem>
      <Article>sample string 1</Article>
      <CompileValue>3</CompileValue>
      <DeclareValue>2</DeclareValue>
    </DocumentProductItem>
  </Products>
  <StationCode>sample string 6</StationCode>
</FulfilmentDocument>