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

http://api.alemtat.kz/web/{ext}/CourierRequest/CourierRequestInfo?RequestId={RequestId}&ApiKey={ApiKey}


Получить полную информацию по заявке на вызов курьера.

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

URI параметры

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

Идентификатор заявки.

globally unique identifier

Required

ext

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

string

Нет описания

ApiKey

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

string

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

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

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

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

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

Идентификатор заявки.

globally unique identifier

Нет описания

Number

Номер заявки.

string

Нет описания

Date

Дата заявки. Формат: "yyyy-MM-dd".

string

Нет описания

Card

Номер карты клиента.

string

Нет описания

SenderName

Название компании отправителя.

string

Нет описания

LocalityCode

Локальный код населеного пунка при заборе отправлений.

string

Нет описания

AddressDetail

Детальный адрес внутри населеного пункта при забое отправлений.

string

Нет описания

ContactName

Контактное лицо. Обязательный для заполнения. Имеет ограничение в 128 символов.

string

Нет описания

Phone

Телефон контактного лица. Обязательный для заполнения. Имеет ограничение в 32 символа.

string

Нет описания

ReadyFor

Информация о времени готовности отправлений к передаче их курьеру. Варианты заполнения (готово||12:00||13:00||14:00||15:00||16:00||17:00||18:00). По умолчанию "готово". Имеет ограничение в 6 символов.

string

Нет описания

PickUp

Время до которого необходимо забрать отправления. Варианты заполнения (12:00||13:00||14:00||15:00||16:00||17:00||18:00). По умолчанию "18:00". Имеет ограничение в 6 символов.

string

Нет описания

Service

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

string

Нет описания

IsLargeVolume

Признак наличия объемных отправлений. Объемным отправлением считается отправление у которого одна из сторон более 50 см.

boolean

Нет описания

IsLargeWeight

Признак наличия тяжолых отправлений. Тяжелым отправлением считается отправление имеющее вес более 25 кг.

boolean

Нет описания

Note

Особые заметки или условия по передаваемым отправлениям.

string

Нет описания

Status

Статус заявки. (0 - В РАБОТЕ; 1 - ПРИОСТАНОВЛЕНА; 2 - ОТМЕНЕНА; 3 - ВЫПОЛНЕНА)

RequestStatus

Нет описания

Events

События по заявке.

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

Нет описания

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

application/json, text/json

Пример:
{
  "RequestId": "a27b3cb5-a0da-4997-b5f6-08421e5e9349",
  "Number": "sample string 2",
  "Date": "sample string 3",
  "Card": "sample string 4",
  "SenderName": "sample string 5",
  "LocalityCode": "sample string 6",
  "AddressDetail": "sample string 7",
  "ContactName": "sample string 8",
  "Phone": "sample string 9",
  "ReadyFor": "sample string 10",
  "PickUp": "sample string 11",
  "Service": "sample string 12",
  "IsLargeVolume": true,
  "IsLargeWeight": true,
  "Note": "sample string 15",
  "Status": 0,
  "Events": [
    {
      "EventTime": "sample string 1",
      "EventName": "sample string 2",
      "ToStatus": 0
    },
    {
      "EventTime": "sample string 1",
      "EventName": "sample string 2",
      "ToStatus": 0
    }
  ]
}

application/xml, text/xml

Пример:
<CourierRequestInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
  <AddressDetail>sample string 7</AddressDetail>
  <Card>sample string 4</Card>
  <ContactName>sample string 8</ContactName>
  <Date>sample string 3</Date>
  <Events>
    <CourierRequestEvent>
      <EventName>sample string 2</EventName>
      <EventTime>sample string 1</EventTime>
      <ToStatus>InWork</ToStatus>
    </CourierRequestEvent>
    <CourierRequestEvent>
      <EventName>sample string 2</EventName>
      <EventTime>sample string 1</EventTime>
      <ToStatus>InWork</ToStatus>
    </CourierRequestEvent>
  </Events>
  <IsLargeVolume>true</IsLargeVolume>
  <IsLargeWeight>true</IsLargeWeight>
  <LocalityCode>sample string 6</LocalityCode>
  <Note>sample string 15</Note>
  <Number>sample string 2</Number>
  <Phone>sample string 9</Phone>
  <PickUp>sample string 11</PickUp>
  <ReadyFor>sample string 10</ReadyFor>
  <RequestId>a27b3cb5-a0da-4997-b5f6-08421e5e9349</RequestId>
  <SenderName>sample string 5</SenderName>
  <Service>sample string 12</Service>
  <Status>InWork</Status>
</CourierRequestInfo>