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

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


Регистрация отправления по Манифесту передачи.

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

URI параметры

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

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

string

Нет описания

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

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

Манифест передачи отправлений

ManifestUniversalInfo_API

Нет описания

WayBill

Накладная

WayBillInfo_API

Нет описания

CashAssigment

Поручение

CashAssigment_API

Нет описания

Products

Список товаров при оказании услуг фулфилмент

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

Нет описания

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
  },
  "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"
  },
  "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

Пример:
<ParamRegWayBill 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>
  <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>
  <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>
    <Barcode>sample string 2</Barcode>
    <CodeOfPV>sample string 3</CodeOfPV>
    <Content>sample string 10</Content>
    <DeclareAmount>9</DeclareAmount>
    <Number>sample string 1</Number>
    <Place>6</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>
    <Service>sample string 4</Service>
    <Specification>sample string 5</Specification>
    <VWeight>8</VWeight>
    <Weight>7</Weight>
  </WayBill>
</ParamRegWayBill>

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

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

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

Номер манифеста передачи отправлений

string

Нет описания

WayBillNumber

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

string

Нет описания

Barcode

Штрих код

string

Нет описания

IsError

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

boolean

Нет описания

ErrorCode

Код ошибки

integer

Нет описания

Message

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

string

Нет описания

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

application/json, text/json

Пример:
{
  "ManifestNumber": "sample string 1",
  "WayBillNumber": "sample string 2",
  "Barcode": "sample string 3",
  "IsError": true,
  "ErrorCode": 5,
  "Message": "sample string 6"
}

application/xml, text/xml

Пример:
<ResultRegWayBill xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
  <Barcode>sample string 3</Barcode>
  <ErrorCode>5</ErrorCode>
  <IsError>true</IsError>
  <ManifestNumber>sample string 1</ManifestNumber>
  <Message>sample string 6</Message>
  <WayBillNumber>sample string 2</WayBillNumber>
</ResultRegWayBill>

Таблица ошибок

Код ошибки Описание
1 Не указаны данные параметра Manifest (Манифест приема отправлений)
2 Не указаны данные параметра WayBill (Накладная)
3 Получатель по накладной не задан. (WayBill->Recipient)
4 Параметры поручения (CashAssigment->Amount) задаются при наличии Договора поручения.
5 Товары (Products[]) указываются в случае предоставлений компании услуг Фулфилмент.
6 По карте клиента "X" не зарегистрирована форма AWBN.
7 Регистрация отправлений запрещена. Предоставленый Вам Api ключ может использоваться только для чтения данных.
8 Не верно указанно значение параметра \"Условия передачи\" (Manifest->ConditionsType), допустимый диапазон значений: 0 - 3.
100 Принимающая станция не найдена или параметр Manifest->ReceivingStation указан неверно.
101 Не найден населённый пункт отправителя или параметр Manifest->FromLocality указан неверно.
102 Дата документа (Manifest->Date) указана неверно. Дату необходимо указывать в формате "yyyy-MM-dd".
103 Дата документа (Manifest->Date) не может быть меньше текущей даты.
104 Карта клиента не найдена или параметр Manifest->Card указан неверно.
105 Форма накладной по указанной карте не найдена (Manifest->Card).
106 Параметр Articul не может быть пустым.
107 Параметр Quantity не может быть меньше 1.
108 Накладная с номером "X" уже зарегистрирована.
109 Услуга не найдена или параметр WayBill->Service указан неверно.
110 Спецификация услуги не найдена или параметр WayBill->Specification указан неверно.
111 Населённый пункт получателя не найден или параметр WayBill->Recipient->LocalityCode указан неверно.
112 ПВЗ с указанным кодом не найден или параметр WayBill->CodeOfPV указан неверно.
113 Номер накладной не должен превышать 32 символов WayBill->Number.
114 Номер накладной не уникален WayBill->Number.
115 Наименование населённого пункта получателя не должно превышать 128 символов (WayBill->Recipient->LocalityName).
116 Номер поручения не должен превышать 16 символов (CashAssigment->RNumber).
117 Наименование компании получателя не должно превышать 128 символов (WayBill->Recipient->Company).
118 Значение поля "Контакт/Получатель" не должно превышать 64 символов (WayBill->Recipient->Contact).
119 Значение поля "Телефон адресанта" не должно превышать 64 символов (WayBill->Recipient->Tel).
120 Значение поля "Детальный адрес" не должно превышать 512 символов (WayBill->Recipient->AddressDetail).
121 Значение поля "Почтовый индекс адресанта" не должно превышать 16 символов (WayBill->Recipient->Zip).
122 Значение поля "Детальный адрес" не должно превышать 512 символов (Manifest->FromAddressDetail).
123 Значение поля "Название товара / Краткое описание товара" не должно превышать 512 символов (Products[]->Description).
124 Значение поля "Номер документа" не должно превышать 16 символов (Manifest->Number).
125 Значение поля "Назначение" не должно превышать 256 символов (Manifest->Appointment).
126 Поручение не может быть принято при не определенном населенном пункте (WayBill->Recipient->LocalityCode).
127 Указаный населеный пункт с кодом (WayBill->Recipient->LocalityCode), не входит в сиписок обслуживаемых населеных пунктов по поручениям.
128 Использование собственной номерации отправлени запрещенно. Поле "Номер накладной" (WayBill->Number) не заполняется.
129 Накладная со штрихкодом "X" уже зарегистрирована.
130 Использование собственных штрих кодов отправлени запрещенно. Поле "Штрих код" (WayBill->Barcode) не заполняется.
131 Штрих код не должен превышать 32 символов WayBill->Barcode.
132 Значение поля "email" не должно превышать 128 символов (WayBill->Recipient->email).
133 Значение поля "INN" не должно превышать 16 символов (WayBill->Recipient->INN).
134 Постаматы не обслуживают отправления с поручениями. Указан постамат :"X".
200 Присутствуют ошибки при обработке отправлений.
1000 Системная ошибка при операции записи