Адрес службы: POST
http://api.alemtat.kz/web/{ext}/WayBill/regWayBills
Регистрация отправлений по Манифесту передачи.
Информация о запросе
URI параметры
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| ext |
Формат данных. JSON или XML. |
string |
Нет описания |
Параметры запроса
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| Manifest |
Манифест передачи отправлений |
ManifestUniversalInfo_API |
Нет описания |
| Shipments |
Список отправлений по манифесту |
Коллекция из ManifestShipment_API |
Нет описания |
| ApiKey |
Выданный API-ключ |
string |
Обязательный Используется для получения доступа к данным |
Форматы запроса
application/json, text/json
Пример:
{
"Manifest": {
"Number": "sample string 1",
"Date": "sample string 2",
"Card": "sample string 3",
"ReceivingStation": "sample string 4",
"FromLocality": "sample string 5",
"FromAddressDetail": "sample string 6",
"Appointment": "sample string 7",
"ConditionsType": 8
},
"Shipments": [
{
"WayBill": {
"Number": "sample string 1",
"Barcode": "sample string 2",
"Recipient": {
"Company": "sample string 1",
"Contact": "sample string 2",
"INN": "sample string 3",
"Tel": "sample string 4",
"email": "sample string 5",
"LocalityCode": "sample string 6",
"LocalityName": "sample string 7",
"Zip": "sample string 8",
"AddressDetail": "sample string 9"
},
"CodeOfPV": "sample string 3",
"Service": "sample string 4",
"Specification": "sample string 5",
"Place": 6,
"Weight": 7.0,
"VWeight": 8.0,
"DeclareAmount": 9.0,
"Content": "sample string 10",
"Tnved": "sample string 11",
"DeliveryDatePlan": "2024-04-26T13:00:53.3565034+05:00",
"AdditInfo": "sample string 12",
"Places": [
{
"Barcode": "sample string 1",
"Weight": 2.0,
"Height": 3.0,
"Width": 4.0,
"Length": 5.0,
"Volume": 6.0,
"Content": "sample string 7"
},
{
"Barcode": "sample string 1",
"Weight": 2.0,
"Height": 3.0,
"Width": 4.0,
"Length": 5.0,
"Volume": 6.0,
"Content": "sample string 7"
}
]
},
"CashAssigment": {
"RNumber": "sample string 1",
"Amount": 2.0
},
"Products": [
{
"Article": "sample string 1",
"Description": "sample string 2",
"Quantity": 3
},
{
"Article": "sample string 1",
"Description": "sample string 2",
"Quantity": 3
}
]
},
{
"WayBill": {
"Number": "sample string 1",
"Barcode": "sample string 2",
"Recipient": {
"Company": "sample string 1",
"Contact": "sample string 2",
"INN": "sample string 3",
"Tel": "sample string 4",
"email": "sample string 5",
"LocalityCode": "sample string 6",
"LocalityName": "sample string 7",
"Zip": "sample string 8",
"AddressDetail": "sample string 9"
},
"CodeOfPV": "sample string 3",
"Service": "sample string 4",
"Specification": "sample string 5",
"Place": 6,
"Weight": 7.0,
"VWeight": 8.0,
"DeclareAmount": 9.0,
"Content": "sample string 10",
"Tnved": "sample string 11",
"DeliveryDatePlan": "2024-04-26T13:00:53.3565034+05:00",
"AdditInfo": "sample string 12",
"Places": [
{
"Barcode": "sample string 1",
"Weight": 2.0,
"Height": 3.0,
"Width": 4.0,
"Length": 5.0,
"Volume": 6.0,
"Content": "sample string 7"
},
{
"Barcode": "sample string 1",
"Weight": 2.0,
"Height": 3.0,
"Width": 4.0,
"Length": 5.0,
"Volume": 6.0,
"Content": "sample string 7"
}
]
},
"CashAssigment": {
"RNumber": "sample string 1",
"Amount": 2.0
},
"Products": [
{
"Article": "sample string 1",
"Description": "sample string 2",
"Quantity": 3
},
{
"Article": "sample string 1",
"Description": "sample string 2",
"Quantity": 3
}
]
}
]
}
application/xml, text/xml
Пример:
<ParamRegWayBills xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
<Manifest>
<Appointment>sample string 7</Appointment>
<Card>sample string 3</Card>
<ConditionsType>8</ConditionsType>
<Date>sample string 2</Date>
<FromAddressDetail>sample string 6</FromAddressDetail>
<FromLocality>sample string 5</FromLocality>
<Number>sample string 1</Number>
<ReceivingStation>sample string 4</ReceivingStation>
</Manifest>
<Shipments>
<ManifestShipment_API>
<CashAssigment>
<Amount>2</Amount>
<RNumber>sample string 1</RNumber>
</CashAssigment>
<Products>
<Product>
<Article>sample string 1</Article>
<Description>sample string 2</Description>
<Quantity>3</Quantity>
</Product>
<Product>
<Article>sample string 1</Article>
<Description>sample string 2</Description>
<Quantity>3</Quantity>
</Product>
</Products>
<WayBill>
<AdditInfo>sample string 12</AdditInfo>
<Barcode>sample string 2</Barcode>
<CodeOfPV>sample string 3</CodeOfPV>
<Content>sample string 10</Content>
<DeclareAmount>9</DeclareAmount>
<DeliveryDatePlan>2024-04-26T13:00:53.3565034+05:00</DeliveryDatePlan>
<Number>sample string 1</Number>
<Place>6</Place>
<Places>
<PlaceInfo_API>
<Barcode>sample string 1</Barcode>
<Content>sample string 7</Content>
<Height>3</Height>
<Length>5</Length>
<Volume>6</Volume>
<Weight>2</Weight>
<Width>4</Width>
</PlaceInfo_API>
<PlaceInfo_API>
<Barcode>sample string 1</Barcode>
<Content>sample string 7</Content>
<Height>3</Height>
<Length>5</Length>
<Volume>6</Volume>
<Weight>2</Weight>
<Width>4</Width>
</PlaceInfo_API>
</Places>
<Recipient>
<AddressDetail>sample string 9</AddressDetail>
<Company>sample string 1</Company>
<Contact>sample string 2</Contact>
<INN>sample string 3</INN>
<LocalityCode>sample string 6</LocalityCode>
<LocalityName>sample string 7</LocalityName>
<Tel>sample string 4</Tel>
<Zip>sample string 8</Zip>
<email>sample string 5</email>
</Recipient>
<Service>sample string 4</Service>
<Specification>sample string 5</Specification>
<Tnved>sample string 11</Tnved>
<VWeight>8</VWeight>
<Weight>7</Weight>
</WayBill>
</ManifestShipment_API>
<ManifestShipment_API>
<CashAssigment>
<Amount>2</Amount>
<RNumber>sample string 1</RNumber>
</CashAssigment>
<Products>
<Product>
<Article>sample string 1</Article>
<Description>sample string 2</Description>
<Quantity>3</Quantity>
</Product>
<Product>
<Article>sample string 1</Article>
<Description>sample string 2</Description>
<Quantity>3</Quantity>
</Product>
</Products>
<WayBill>
<AdditInfo>sample string 12</AdditInfo>
<Barcode>sample string 2</Barcode>
<CodeOfPV>sample string 3</CodeOfPV>
<Content>sample string 10</Content>
<DeclareAmount>9</DeclareAmount>
<DeliveryDatePlan>2024-04-26T13:00:53.3565034+05:00</DeliveryDatePlan>
<Number>sample string 1</Number>
<Place>6</Place>
<Places>
<PlaceInfo_API>
<Barcode>sample string 1</Barcode>
<Content>sample string 7</Content>
<Height>3</Height>
<Length>5</Length>
<Volume>6</Volume>
<Weight>2</Weight>
<Width>4</Width>
</PlaceInfo_API>
<PlaceInfo_API>
<Barcode>sample string 1</Barcode>
<Content>sample string 7</Content>
<Height>3</Height>
<Length>5</Length>
<Volume>6</Volume>
<Weight>2</Weight>
<Width>4</Width>
</PlaceInfo_API>
</Places>
<Recipient>
<AddressDetail>sample string 9</AddressDetail>
<Company>sample string 1</Company>
<Contact>sample string 2</Contact>
<INN>sample string 3</INN>
<LocalityCode>sample string 6</LocalityCode>
<LocalityName>sample string 7</LocalityName>
<Tel>sample string 4</Tel>
<Zip>sample string 8</Zip>
<email>sample string 5</email>
</Recipient>
<Service>sample string 4</Service>
<Specification>sample string 5</Specification>
<Tnved>sample string 11</Tnved>
<VWeight>8</VWeight>
<Weight>7</Weight>
</WayBill>
</ManifestShipment_API>
</Shipments>
</ParamRegWayBills>
Информация об ответе
Описание ответа
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| ManifestNumber |
Номер манифеста передачи отправлений |
string |
Нет описания |
| IsError |
Признак ошибки |
boolean |
Нет описания |
| ErrorCode |
Код ошибки |
integer |
Нет описания |
| Message |
Описание ошибки |
string |
Нет описания |
| ReulstRegShipments |
Результат обработки отправлений |
Коллекция из ResultRegManifestShipment |
Нет описания |
Форматы ответа
application/json, text/json
Пример:
{
"ManifestNumber": "sample string 1",
"IsError": true,
"ErrorCode": 3,
"Message": "sample string 4",
"ReulstRegShipments": [
{
"WayBillNumber": "sample string 1",
"Barcode": "sample string 2",
"IsError": true,
"ErrorCode": 4,
"Message": "sample string 5"
},
{
"WayBillNumber": "sample string 1",
"Barcode": "sample string 2",
"IsError": true,
"ErrorCode": 4,
"Message": "sample string 5"
}
]
}
application/xml, text/xml
Пример:
<ResultRegWayWills xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
<ErrorCode>3</ErrorCode>
<IsError>true</IsError>
<ManifestNumber>sample string 1</ManifestNumber>
<Message>sample string 4</Message>
<ReulstRegShipments>
<ResultRegManifestShipment>
<Barcode>sample string 2</Barcode>
<ErrorCode>4</ErrorCode>
<IsError>true</IsError>
<Message>sample string 5</Message>
<WayBillNumber>sample string 1</WayBillNumber>
</ResultRegManifestShipment>
<ResultRegManifestShipment>
<Barcode>sample string 2</Barcode>
<ErrorCode>4</ErrorCode>
<IsError>true</IsError>
<Message>sample string 5</Message>
<WayBillNumber>sample string 1</WayBillNumber>
</ResultRegManifestShipment>
</ReulstRegShipments>
</ResultRegWayWills>