Адрес службы: POST
http://api.alemtat.kz/web/{ext}/WayBill/regWayBills-bxr
Регистрация отправлений по манифесту передачи с таможенным оформлением.
Информация о запросе
URI параметры
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| ext |
Формат данных. JSON или XML. |
string |
Нет описания |
Параметры запроса
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| Number |
Номер манифеста передачи отправлений. В случае если номер не указан он присваевается автоматически. |
string |
Максимальная длина: 32 |
| Date |
Дата документа. Формат: "yyyy-MM-dd", обязателен к заполнению. |
string |
Обязательный Максимальная длина: 10 Минимальная длина: 10 |
| Card |
Номер карты клиента согласно договора |
string |
Обязательный Максимальная длина: 8 |
| ReceivingStation |
Код принимающей станции. |
string |
Обязательный Максимальная длина: 8 |
| FromLocality |
Локальный код населеного пункта адреса отправителя. |
string |
Обязательный Максимальная длина: 6 |
| HAWB |
Номер авиа накладной |
string |
Максимальная длина: 16 |
| DateArrive |
Дата прибытия. Формат: "yyyy-MM-dd". |
string |
Максимальная длина: 10 |
| Shipments |
Список отправлений по манифесту |
Коллекция из WayBillInfo_BXR |
Обязательный |
| ApiKey |
Выданный API-ключ |
string |
Обязательный Используется для получения доступа к данным |
Форматы запроса
application/json, text/json
Пример:
{
"Number": "sample string 1",
"Date": "sample string 2",
"Card": "sample string 3",
"ReceivingStation": "sample string 4",
"FromLocality": "sample string 5",
"HAWB": "sample string 6",
"DateArrive": "sample string 7",
"Shipments": [
{
"Number": "sample string 1",
"Barcode": "sample string 2",
"ShipmentDate": "sample string 3",
"ShopWebsiteURL": "sample string 4",
"Recipient": {
"IIN": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"MiddleName": "sample string 4",
"Tel": "sample string 5",
"email": "sample string 6",
"LocalityCode": "sample string 7",
"LocalityName": "sample string 8",
"Zip": "sample string 9",
"AddressDetail": "sample string 10",
"CitizenshipCode": "sample string 11",
"PassportKind": 1,
"ICN": "sample string 12",
"IssuedDate": "sample string 13",
"IssuedBy": "sample string 14"
},
"CodeOfPV": "sample string 5",
"Service": "sample string 6",
"Weight": 7.0,
"DeclareAmount": 8.0,
"Content": "sample string 9",
"Tnved": "sample string 10",
"DeliveryDatePlan": "2024-12-21T22:02:38.71839+05:00",
"CustomsAmount": 11.0,
"Products": [
{
"Article": "sample string 1",
"Description": "sample string 2",
"GrossWeight": 3.0,
"Quantity": 4,
"Price": 5.0,
"Tnved": "sample string 6"
},
{
"Article": "sample string 1",
"Description": "sample string 2",
"GrossWeight": 3.0,
"Quantity": 4,
"Price": 5.0,
"Tnved": "sample string 6"
}
]
},
{
"Number": "sample string 1",
"Barcode": "sample string 2",
"ShipmentDate": "sample string 3",
"ShopWebsiteURL": "sample string 4",
"Recipient": {
"IIN": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"MiddleName": "sample string 4",
"Tel": "sample string 5",
"email": "sample string 6",
"LocalityCode": "sample string 7",
"LocalityName": "sample string 8",
"Zip": "sample string 9",
"AddressDetail": "sample string 10",
"CitizenshipCode": "sample string 11",
"PassportKind": 1,
"ICN": "sample string 12",
"IssuedDate": "sample string 13",
"IssuedBy": "sample string 14"
},
"CodeOfPV": "sample string 5",
"Service": "sample string 6",
"Weight": 7.0,
"DeclareAmount": 8.0,
"Content": "sample string 9",
"Tnved": "sample string 10",
"DeliveryDatePlan": "2024-12-21T22:02:38.71839+05:00",
"CustomsAmount": 11.0,
"Products": [
{
"Article": "sample string 1",
"Description": "sample string 2",
"GrossWeight": 3.0,
"Quantity": 4,
"Price": 5.0,
"Tnved": "sample string 6"
},
{
"Article": "sample string 1",
"Description": "sample string 2",
"GrossWeight": 3.0,
"Quantity": 4,
"Price": 5.0,
"Tnved": "sample string 6"
}
]
}
]
}
application/xml, text/xml
Пример:
<ParamRegWayBillsBXR xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
<Card>sample string 3</Card>
<Date>sample string 2</Date>
<DateArrive>sample string 7</DateArrive>
<FromLocality>sample string 5</FromLocality>
<HAWB>sample string 6</HAWB>
<Number>sample string 1</Number>
<ReceivingStation>sample string 4</ReceivingStation>
<Shipments>
<WayBillInfo_BXR>
<Barcode>sample string 2</Barcode>
<CodeOfPV>sample string 5</CodeOfPV>
<Content>sample string 9</Content>
<CustomsAmount>11</CustomsAmount>
<DeclareAmount>8</DeclareAmount>
<DeliveryDatePlan>2024-12-21T22:02:38.71839+05:00</DeliveryDatePlan>
<Number>sample string 1</Number>
<Products>
<ProductInfo_BXR>
<Article>sample string 1</Article>
<Description>sample string 2</Description>
<GrossWeight>3</GrossWeight>
<Price>5</Price>
<Quantity>4</Quantity>
<Tnved>sample string 6</Tnved>
</ProductInfo_BXR>
<ProductInfo_BXR>
<Article>sample string 1</Article>
<Description>sample string 2</Description>
<GrossWeight>3</GrossWeight>
<Price>5</Price>
<Quantity>4</Quantity>
<Tnved>sample string 6</Tnved>
</ProductInfo_BXR>
</Products>
<Recipient>
<AddressDetail>sample string 10</AddressDetail>
<CitizenshipCode>sample string 11</CitizenshipCode>
<FirstName>sample string 2</FirstName>
<ICN>sample string 12</ICN>
<IIN>sample string 1</IIN>
<IssuedBy>sample string 14</IssuedBy>
<IssuedDate>sample string 13</IssuedDate>
<LastName>sample string 3</LastName>
<LocalityCode>sample string 7</LocalityCode>
<LocalityName>sample string 8</LocalityName>
<MiddleName>sample string 4</MiddleName>
<PassportKind>IDCard</PassportKind>
<Tel>sample string 5</Tel>
<Zip>sample string 9</Zip>
<email>sample string 6</email>
</Recipient>
<Service>sample string 6</Service>
<ShipmentDate>sample string 3</ShipmentDate>
<ShopWebsiteURL>sample string 4</ShopWebsiteURL>
<Tnved>sample string 10</Tnved>
<Weight>7</Weight>
</WayBillInfo_BXR>
<WayBillInfo_BXR>
<Barcode>sample string 2</Barcode>
<CodeOfPV>sample string 5</CodeOfPV>
<Content>sample string 9</Content>
<CustomsAmount>11</CustomsAmount>
<DeclareAmount>8</DeclareAmount>
<DeliveryDatePlan>2024-12-21T22:02:38.71839+05:00</DeliveryDatePlan>
<Number>sample string 1</Number>
<Products>
<ProductInfo_BXR>
<Article>sample string 1</Article>
<Description>sample string 2</Description>
<GrossWeight>3</GrossWeight>
<Price>5</Price>
<Quantity>4</Quantity>
<Tnved>sample string 6</Tnved>
</ProductInfo_BXR>
<ProductInfo_BXR>
<Article>sample string 1</Article>
<Description>sample string 2</Description>
<GrossWeight>3</GrossWeight>
<Price>5</Price>
<Quantity>4</Quantity>
<Tnved>sample string 6</Tnved>
</ProductInfo_BXR>
</Products>
<Recipient>
<AddressDetail>sample string 10</AddressDetail>
<CitizenshipCode>sample string 11</CitizenshipCode>
<FirstName>sample string 2</FirstName>
<ICN>sample string 12</ICN>
<IIN>sample string 1</IIN>
<IssuedBy>sample string 14</IssuedBy>
<IssuedDate>sample string 13</IssuedDate>
<LastName>sample string 3</LastName>
<LocalityCode>sample string 7</LocalityCode>
<LocalityName>sample string 8</LocalityName>
<MiddleName>sample string 4</MiddleName>
<PassportKind>IDCard</PassportKind>
<Tel>sample string 5</Tel>
<Zip>sample string 9</Zip>
<email>sample string 6</email>
</Recipient>
<Service>sample string 6</Service>
<ShipmentDate>sample string 3</ShipmentDate>
<ShopWebsiteURL>sample string 4</ShopWebsiteURL>
<Tnved>sample string 10</Tnved>
<Weight>7</Weight>
</WayBillInfo_BXR>
</Shipments>
</ParamRegWayBillsBXR>
Информация об ответе
Описание ответа
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| 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>