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

http://api.alemtat.kz/web/{ext}/WayBill/regEWayBill


Регистрация отправления по Электронной накладной.

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

URI параметры

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

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

 string

Нет описания

Параметры запроса

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

Идентификатор заявки на вызов курьера. Обязателен для заполнения. Заявка должна иметь статус "0 - В РАБОТЕ". В заявке уазывается отправитель и адрес забора регистрируемого отправления.

 globally unique identifier

Нет описания
Recipient

Получатель.

 AddressesAPI

Нет описания
CodeOfPV

Код ПВЗ согласно заключенного договора. Заполняется в случае если выдача отправления получателю производится в пункте выдачи заказа.

 string

Нет описания
Service

Код услуги используемой при доставки отправления. Согласно справочника услуг.

 string

Нет описания
Place

Кол-во мест по накладной. Местом считается отдельно упакованное отправление принимаемое для доставки.

 integer

Нет описания
Weight

Общий заявленый вес по накладной.

 decimal number

Нет описания
DeclareAmount

Общая объявленая стоимость отправлений по накладной.

 decimal number

Нет описания
CashAssigment

Поручение (Наложеный платеж). Для использования нобходимо наличие договора поручения.

 CashAssigment_API

Нет описания
Content

Описание содержания отправления. Имеет ограничение на 128 символов.

 string

Нет описания
ApiKey

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

 string

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

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

Форматы запроса

application/json, text/json

Пример: 
{
  "RequestId": "0f3ac8a1-b8bc-4dfa-8500-0fd153c5ae32",
  "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 2",
  "Service": "sample string 3",
  "Place": 4,
  "Weight": 5.0,
  "DeclareAmount": 6.0,
  "CashAssigment": {
    "RNumber": "sample string 1",
    "Amount": 2.0
  },
  "Content": "sample string 7"
}

application/xml, text/xml

Пример: 
<EWayBillInfo_API xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
  <CashAssigment>
    <Amount>2</Amount>
    <RNumber>sample string 1</RNumber>
  </CashAssigment>
  <CodeOfPV>sample string 2</CodeOfPV>
  <Content>sample string 7</Content>
  <DeclareAmount>6</DeclareAmount>
  <Place>4</Place>
  <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>
  <RequestId>0f3ac8a1-b8bc-4dfa-8500-0fd153c5ae32</RequestId>
  <Service>sample string 3</Service>
  <Weight>5</Weight>
</EWayBillInfo_API>

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

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

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

Идентификатор документа для получения печатной формы: Электроной накладной.

 globally unique identifier

Нет описания
WayBillNumber

Номер накладной

 string

Нет описания
EWaybillInfo

Детальная информация по доументу "Электроная накладная"

 EWayBillInfo_API

Нет описания
IsError

Признак ошибки

 boolean

Нет описания
ErrorCode

Код ошибки

 integer

Нет описания
Message

Описание ошибки

 string

Нет описания

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

application/json, text/json

Пример: 
{
  "WayBillDocumentId": "c3239b33-e465-4ee1-9c2a-b02f46a07bca",
  "WayBillNumber": "sample string 2",
  "EWaybillInfo": {
    "RequestId": "99433a44-2c2b-4edf-91fa-4b0fe80127bb",
    "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 2",
    "Service": "sample string 3",
    "Place": 4,
    "Weight": 5.0,
    "DeclareAmount": 6.0,
    "CashAssigment": {
      "RNumber": "sample string 1",
      "Amount": 2.0
    },
    "Content": "sample string 7"
  },
  "IsError": true,
  "ErrorCode": 4,
  "Message": "sample string 5"
}

application/xml, text/xml

Пример: 
<ResultEWayBillInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
  <EWaybillInfo>
    <CashAssigment>
      <Amount>2</Amount>
      <RNumber>sample string 1</RNumber>
    </CashAssigment>
    <CodeOfPV>sample string 2</CodeOfPV>
    <Content>sample string 7</Content>
    <DeclareAmount>6</DeclareAmount>
    <Place>4</Place>
    <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>
    <RequestId>99433a44-2c2b-4edf-91fa-4b0fe80127bb</RequestId>
    <Service>sample string 3</Service>
    <Weight>5</Weight>
  </EWaybillInfo>
  <ErrorCode>4</ErrorCode>
  <IsError>true</IsError>
  <Message>sample string 5</Message>
  <WayBillDocumentId>c3239b33-e465-4ee1-9c2a-b02f46a07bca</WayBillDocumentId>
  <WayBillNumber>sample string 2</WayBillNumber>
</ResultEWayBillInfo>