Шлюз API
Тестовый стенд webshopSoapGate v2.0 (4 запроса в секунду)
$soap = new SoapClient(
'https://is-test.topdelivery.ru/api/soap/w/2.0/?WSDL',
[
'login' => "tdsoap",
'password' => "5f3b5023270883afb9ead456c8985ba8",
]
);
Методы API
addOrders( ) @return addOrdersResponse
Добавление Заказов
Параметры функции: addOrders [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| addedOrders | nillable = false minoccurs = 1 maxoccurs = unbounded |
ctAddedOrder | Параметры добавляемых заказов |
| — serviceType | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип услуги по заказу (DELIVERY, INTAKE, CHANGE) |
| — deliveryType | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип доставки (COURIER, PICKUP) |
| — orderSubtype | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип заказа: обычный(SIMPLE) или корреспонденция(DOCUMENT) |
| — deliveryCostPayAnyway | nillable = true minoccurs = 1 maxoccurs = 1 |
int | 1 - в случае отказа с покупателя взымается полная стоимость доставки. 0 - в случае отказа с покупателя деньге не взымаются |
| — webshopNumber | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в ИМ |
| — webshopBarcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Штрихкод заказа в ИМ |
| — orderUrl | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Ссылка на страницу товара в ИМ |
| — execution | nillable = true minoccurs = 1 maxoccurs = 1 |
ctExecution | Исполнитель (указывать только при согласовании с ТД) |
| — — executorId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Идентификатор исполнителя из справочника ТД |
| — desiredDateDelivery | nillable = true minoccurs = 1 maxoccurs = 1 |
ctDateTimeInterval | желаемая дата доставки |
| — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — — timeInterval | nillable = false minoccurs = 1 maxoccurs = 1 |
ctTimeInterval | интервал доставки |
| — — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| — deliveryAddress | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAddress | Адрес доставки |
| — — type | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип передачи региона и города, допустимые значения: id (из справочника ТД), string (поиск в справочнике ТД по строке), zip (Поиск в справочнике по индексу), pickup (Поиск по идентификатору ПВЗ - указывается только в случае когда deliveryType = PICKUP) |
| — — region | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Регион, значение зависит от типа |
| — — city | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Город, значение зависит от типа |
| — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс, не обязателен, за исключением использования типа zip |
| — — inCityAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctInCityAddress | Адрес внутри населенного пункта (улица, дом, коркус, квартира) |
| — — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | адрес внутри города |
| — — — floor | nillable = true minoccurs = 0 maxoccurs = 1 |
string | этаж |
| — — — elevator | nillable = true minoccurs = 0 maxoccurs = 1 |
ctElevator | Наличие лифта |
| — — — — hasElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие лифта (1 - да, 0 - нет) |
| — — — — hasFreightElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие грузового лифта (1 - да, 0 - нет) |
| — — pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | Адрес самовывоза (указывать только в случае самовывоза) |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — — — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| — — geoPoint | nillable = true minoccurs = 1 maxoccurs = 1 |
ctGeoPoint | Точка геолокации: широта, долгота |
| — — — latitude | nillable = false minoccurs = 1 maxoccurs = 1 |
float | |
| — — — longitude | nillable = false minoccurs = 1 maxoccurs = 1 |
float | |
| — clientInfo | nillable = false minoccurs = 1 maxoccurs = 1 |
ctClientInfo | Информация о клиенте |
| — — fio | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Фамилия, имя, отчество. Одной строкой |
| — — phone | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Телефон. Формат номера 8xxxxxxxxxx (11 символов) |
| nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес электронной почты (максимальное кол-во символов - 63) | |
| — — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий клиента, указывается по необходимости (максимальное кол-во символов - 250) |
| — paymentByCard | nillable = false minoccurs = 1 maxoccurs = 1 |
int | (!Не использутеся, всегда = '0') |
| — clientCosts | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAddOrderCosts | Стоимости для клиента |
| — — clientDeliveryCost | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Стоимость доставки для клиента |
| — — recalcDelivery | nillable = false minoccurs = 1 maxoccurs = 1 |
int | (!Не используется, всегда 0) |
| — — discount | nillable = false minoccurs = 1 maxoccurs = 1 |
ctDiscount | (!Не используется) |
| — — — type | nillable = false minoccurs = 1 maxoccurs = 1 |
string | (!Не использутеся, всегда = 'SUM' ) |
| — — — value | nillable = false minoccurs = 1 maxoccurs = 1 |
double | (!Не использутеся, всегда = '0') |
| — services | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderServices | Необходимые сервисы для обслуживания заказа |
| — — notOpen | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Не вскрывать до получения оплаты с клиента (1/0) |
| — — marking | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Произвести маркировку (1/0) |
| — — smsNotify | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Оповещать клиента о смене статуса заказа посредством СМС (1/0) |
| — — forChoise | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Частичная реализация (1/0) |
| — — places | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество мест |
| — — pack | nillable = false minoccurs = 1 maxoccurs = 1 |
ctPack | Параметры упаковки |
| — — — need | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Требуется ли упаковка (1/0) |
| — — — type | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип упаковки (из справочника) |
| — — needPrr | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Требуются погрузочно-разгрузочные работы |
| — — needLiftingCargo | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Требуется ручное поднятие на этаж |
| — — needDocReturn | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Требуется возврат документов |
| — deliveryWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderWeightVolume | Вес доставки |
| — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Вес заказа (гр) |
| — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Объем заказа |
| — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — intakeWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderWeightVolume | Вес возврата |
| — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Вес заказа (гр) |
| — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Объем заказа |
| — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — items | nillable = false minoccurs = 1 maxoccurs = unbounded |
ctItem | Товары в заказе |
| — — itemId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | id товара (присваивается автоматически при создании заказа) |
| — — name | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя товара. Максимальная длина поля - 42 символа. Наименование товара, цвет, размер, дополнительные атрибуты(при наличии). Например, съемные аксессуары такие как: шарф, пояс и т.д. |
| — — article | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Артикул товара (может содержать символы -, _, цифры и буквы латинского алфавита ) |
| — — count | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество единиц товара |
| — — declaredPrice | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Объявленная стоимость единицы товара |
| — — clientPrice | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Стоимость единицы товара для клиента |
| — — weight | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Вес товара г. |
| — — push | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Тип товара (1 - доставка, 0 - возврат). Нужен только в случае serviceType = CHANGE |
| — — status | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус реализации |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — deliveryCount | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Количество реализованного товара |
| — — vat | nillable = true minoccurs = 1 maxoccurs = 1 |
int | НДС |
| — — trueMark | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код товарной номенклатуры. Используется для передачи кода "Честный знак" |
| — — trueMarkRequired | nillable = true minoccurs = 1 maxoccurs = 1 |
int | 1 - Сканировать Честный знак при реализации |
| — — itemCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код товарной позиции в системе клиента |
| — — itemBarcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | ШК товарной позиции |
| — — excisable | nillable = true minoccurs = 1 maxoccurs = 1 |
int | |
| — intakeWarehouse | nillable = true minoccurs = 1 maxoccurs = 1 |
ctWarehouseIdentity | Склад забора |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД склада в системе ТД |
| — — code | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код склада |
| — returnWarehouse | nillable = true minoccurs = 1 maxoccurs = 1 |
ctWarehouseIdentity | Склад возврата |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД склада в системе ТД |
| — — code | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код склада |
| Свернуть таблицу | |||
Возвращаемое значение: addOrdersResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| addOrdersResult | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctAddOrderResult | Результат добавления заказа |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус операции над заказом |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сопроводительное сообщение |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификаторы заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
Пример
PHP [+]
<?php
// КЛИЕНТ
$soap = new SoapClient(
'https://is-test.topdelivery.ru/api/soap/w/2.0/?wsdl',
[
'login' => 'tdsoap',
'password' => '5f3b5023270883afb9ead456c8985ba8',
]
);
// ПАРАМЕТРЫ
$params = [
'addOrders' => [
'auth' => [
'login' => 'webshop',
'password' => 'pass',
],
'addedOrders' => [
'serviceType' => 'DELIVERY',
'deliveryType' => 'COURIER',
'orderSubtype' => 'SIMPLE',
'deliveryCostPayAnyway' => 0,
'webshopNumber' => 'soaptest_25',
'webshopBarcode' => '',
'orderUrl' => '',
'desiredDateDelivery' => [
'date' => '',
'timeInterval' => [
'bTime' => '10:00',
'eTime' => '18:00',
],
],
'deliveryAddress' => [
'type' => 'zip',
'region' => 'Москва',
'city' => 'Москва',
'zipcode' => '127055',
'inCityAddress' => [
'zipcode' => '127055',
'address' => 'ул Новослободская, д 999',
],
],
'clientInfo' => [
'fio' => 'АйТи -',
'phone' => '89689860000',
'comment' => '',
],
'paymentByCard' => 0,
'clientCosts' => [
'clientDeliveryCost' => 0,
'recalcDelivery' => 0,
'discount' => [
'type' => 'SUM',
'value' => 0,
],
],
'services' => [
'notOpen' => 0,
'marking' => 0,
'smsNotify' => 0,
'forChoise' => 0,
'places' => 1,
'pack' => [
'need' => 0,
'type' => null,
],
],
'deliveryWeight' => [
'weight' => 26400,
'volume' => [
'length' => 16,
'width' => 137,
'height' => 137,
],
],
'items' => [
[
'itemId' => null,
'name' => 'Гарнитура A4TECH HU-8, для ко',
'article' => '1874958',
'count' => 120,
'declaredPrice' => 0,
'clientPrice' => 0,
'weight' => 220,
'push' => 1,
'vat' => 0,
'trueMarkRequired' => 0,
'itemCode' => '1874958',
],
],
],
],
];
// ВЫЗОВ МЕТОДА
$res = $soap->__call('addOrders', $params);
// отобразить ответ
echo '<pre>'; print_r($res); echo '</pre>';
/*
ПРИМЕР ОТВЕТА
-------------
stdClass Object
(
[requestResult] => stdClass Object
(
[status] => 0
[message] => Запрос выполнен успешно
)
[addOrdersResult] => stdClass Object
(
[status] => 0
[message] => Заказ успешно загружен
[orderIdentity] => stdClass Object
(
[orderId] => 8019742
[barcode] => 6*soaptest_25
[webshopNumber] => soaptest_25
)
)
)
*/
addPickupCargo( ) @return addPickupCargoResponse
Создать Заявку на забор груза
Параметры функции: addPickupCargo [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| addedPickupCargoInfo | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAddedPickupCargoInfo | Заявка на забор груза |
| — senderWarehouse | nillable = true minoccurs = 0 maxoccurs = 1 |
ctWarehouseIdentity | Склад отгрузки |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД склада в системе ТД |
| — — code | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код склада |
| — senderInfo | nillable = false minoccurs = 1 maxoccurs = 1 |
ctSender | Данные об отправителе груза |
| — — senderFio | nillable = false minoccurs = 1 maxoccurs = 1 |
string | ФИО отправителя |
| — — senderPhone | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Телефон отправителя |
| — pickupDate | nillable = false minoccurs = 1 maxoccurs = 1 |
ctDateTimeInterval | Дата и интервал забора |
| — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — — timeInterval | nillable = false minoccurs = 1 maxoccurs = 1 |
ctTimeInterval | интервал доставки |
| — — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| — quantityPlaces | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество грузомест |
| — cargoWeightInfo | nillable = false minoccurs = 1 maxoccurs = 1 |
ctCargoWeightInfo | Весогабариты Заявки на забор |
| — — physicalWeight | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Физический вес в кг |
| — — volumeWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Объемный вес в кг |
| — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Длина, ширина, высота в см |
| — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — returnPackInfo | nillable = true minoccurs = 0 maxoccurs = 1 |
ctReturnPack | Возвратная тара |
| — — returnPackType | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип возвратной тары (PALLET - Паллеты, BAG - Мешки, DUMP - Россыпь) |
| — — returnPackCount | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество возвратной тары |
| — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий к Заявке на забор |
| Свернуть таблицу | |||
Возвращаемое значение: addPickupCargoResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| addPickupCargoResult | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctAddPickupCargoResult | Результат создания Заявки на забор груза |
| — pickupCargoId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | ID Заявки |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус операции создания |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сопроводительно сообщение |
| Свернуть таблицу | |||
cancelPickupCargo( ) @return cancelPickupCargoResponse
Отменить Заявку на забор груза
Параметры функции: cancelPickupCargo [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| pickupCargoId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Заявка на забор груза |
| Свернуть таблицу | |||
Возвращаемое значение: cancelPickupCargoResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| cancelPickupCargoResult | nillable = true minoccurs = 1 maxoccurs = 1 |
ctAddPickupCargoResult | Результат отмены Заявки на забор груза |
| — pickupCargoId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | ID Заявки |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус операции создания |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сопроводительно сообщение |
| Свернуть таблицу | |||
addShipment( ) @return addShipmentResponse
Добавление реестра заказов(только для ИМ)
Параметры функции: addShipment [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| addedShipmentInfo | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAddedShipmentInfo | Параметры добавляемой заявки |
| — intake | nillable = false minoccurs = 1 maxoccurs = 1 |
ctShipmentIntakeParams | Параметры забора |
| — — need | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Требуется ли забор (1/0) |
| — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес забора одной строкой |
| — — contacts | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Контакты для связи с отправляющей стороной (Номер телефона) |
| — — intakeDate | nillable = true minoccurs = 1 maxoccurs = 1 |
ctDateTimeInterval | Дата и интервал забора |
| — — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — — — timeInterval | nillable = false minoccurs = 1 maxoccurs = 1 |
ctTimeInterval | интервал доставки |
| — — — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий к забору |
| — orders | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderIdentity | Заказы для прикрепления к заявке |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — places | nillable = false minoccurs = 1 maxoccurs = unbounded |
ctShipmentPlace | Параметры грузовых мест |
| — — number | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Номер грузового места |
| — — weight | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Вес грузовго места |
| — — pallets | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Количество паллет |
| Свернуть таблицу | |||
Возвращаемое значение: addShipmentResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| addShipmentResult | nillable = true minoccurs = 1 maxoccurs = 1 |
ctAddShipmentResult | Результат добавления заявки |
| — shipmentId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | ИД отправки |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус операции создания |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сопроводительно сообщение |
| — attachOrders | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctAddOrderResult | Результат прикрепления заказов |
| — — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус операции над заказом |
| — — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сопроводительное сообщение |
| — — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификаторы заказа |
| — — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
setShipmentOnTheWay( ) @return setShipmentOnTheWayResponse
Перевод заявки в статус в пути(только для ИМ)
Параметры функции: setShipmentOnTheWay [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| shipmentId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Номер отправки |
| Свернуть таблицу | |||
Возвращаемое значение: setShipmentOnTheWayResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| setShipmentOnTheWayResult | nillable = true minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат смены статуса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| Свернуть таблицу | |||
addShipmentOrders( ) @return addShipmentOrdersResponse
Прикрепление заказов к заявке(только для ИМ)
Параметры функции: addShipmentOrders [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| shipmentOrders | nillable = false minoccurs = 1 maxoccurs = 1 |
ctShipmentOrders | Отправка с набором заказов |
| — shipmentId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | ID отправки |
| — orders | nillable = false minoccurs = 1 maxoccurs = unbounded |
ctOrderIdentity | Параметры прикрепляемых заказов |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
Возвращаемое значение: addShipmentOrdersResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| addShipmentOrdersResult | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctAddOrderResult | Результат прикрепления заказов |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус операции над заказом |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сопроводительное сообщение |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификаторы заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
deleteOrdersFromShipment( ) @return deleteOrdersFromShipmentResponse
Открепление заказов от заявки (только для ИМ)
Параметры функции: deleteOrdersFromShipment [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| shipmentOrders | nillable = false minoccurs = 1 maxoccurs = 1 |
ctShipmentOrders | Отправка с набором заказов |
| — shipmentId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | ID отправки |
| — orders | nillable = false minoccurs = 1 maxoccurs = unbounded |
ctOrderIdentity | Параметры прикрепляемых заказов |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
Возвращаемое значение: deleteOrdersFromShipmentResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| addShipmentOrdersResult | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctAddOrderResult | Результат прикрепления заказов |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус операции над заказом |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сопроводительное сообщение |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификаторы заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
getShipmentsInfo( ) @return getShipmentsInfoResponse
Получить информацию об отправках
Параметры функции: getShipmentsInfo [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| shipmentId | nillable = true minoccurs = 0 maxoccurs = unbounded |
int | Идентификатор отправки(ок), по которым необходимо получить информацию |
| Свернуть таблицу | |||
Возвращаемое значение: getShipmentsInfoResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| shipmentsInfo | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctGetShipmentInfoResult | Информация об отправках |
| — getShipmentResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| — shipmentInfo | nillable = true minoccurs = 1 maxoccurs = 1 |
ctShipment | Информация о заказе(ах) |
| — — shipmentId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Идентификатор отправки |
| — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Вес отправки |
| — — placesCount | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Количество мест |
| — — ordersCount | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Количество заказов в отправке |
| — — dateCreate | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата создания отправки |
| — — sorted | nillable = true minoccurs = 1 maxoccurs = 1 |
int | (!) Флаг указывающий на что отправка принята позаказно на складе ТД |
| — — pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | (!) Адрес пункта самовывоза |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — — — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| — — status | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус отправки |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — shipmentPlace | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctShipmentPlace | Грузовые места в отправке |
| — — — number | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Номер грузового места |
| — — — weight | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Вес грузовго места |
| — — — pallets | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Количество паллет |
| — — intakeParams | nillable = true minoccurs = 1 maxoccurs = 1 |
ctShipmentIntakeParams | Параметры забора отправки |
| — — — need | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Требуется ли забор (1/0) |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес забора одной строкой |
| — — — contacts | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Контакты для связи с отправляющей стороной (Номер телефона) |
| — — — intakeDate | nillable = true minoccurs = 1 maxoccurs = 1 |
ctDateTimeInterval | Дата и интервал забора |
| — — — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — — — — timeInterval | nillable = false minoccurs = 1 maxoccurs = 1 |
ctTimeInterval | интервал доставки |
| — — — — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — — — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| — — shipmentDirection | nillable = true minoccurs = 1 maxoccurs = 1 |
ctShipmentDirection | Параметры направления движения отправки |
| — — — type | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип отправки, допустимые значения для партнеров: INTERCITY, TRANSFER, TO_WEBSHOP для ИМ: FROM_WEBSHOP |
| — — — receiverId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД получателя из справочника |
| — — — senderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД отправителя из справочника |
| — — — directionName | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комплексное название, записывается как type@receiverId |
| — — — senderWarehouse | nillable = true minoccurs = 0 maxoccurs = 1 |
ctWarehouseIdentity | Склад отправителя |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД склада в системе ТД |
| — — — — code | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код склада |
| — — — receiverWarehouse | nillable = true minoccurs = 0 maxoccurs = 1 |
ctWarehouseIdentity | Склад получателя |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД склада в системе ТД |
| — — — — code | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код склада |
| — — events | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctEvent | Список событий отправки |
| — — — eventId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Идентификатор события |
| — — — eventType | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Тип события |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — — user | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пользователь, инициировавший событие |
| — — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
dateTime | Дата события |
| — — — prevValue | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Предыдущее значение (при изменени каких-то показателей) |
| — — — newValue | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Установленное значение (при изменени каких-то показателей) |
| — — — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий пользователя |
| — — — region | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Регион, в котором находился заказ на момент редактирования |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — — city | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Город, в котором находился заказ на момент редактирования |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — orders | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderIdentity | Заказы для прикрепления к заявке |
| — — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
getCitiesRegions( ) @return getCitiesRegionsResponse
Получить географию работы ТД
Параметры функции: getCitiesRegions [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| regionId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор региона, по которому необходимо вернуть данные |
| Свернуть таблицу | |||
Возвращаемое значение: getCitiesRegionsResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| citiesRegions | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctRegionZipcodes | Информация о регионе(ах) |
| — regionId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | ИД региона |
| — regionName | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Название региона |
| — zipcodes | nillable = true minoccurs = 0 maxoccurs = unbounded |
string | Список индексов в регионе |
| — cities | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctCityZipcodes | Описание обслуживаемых городов региона |
| — — cityId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | ИД города |
| — — cityName | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Название города |
| — — zipcodes | nillable = true minoccurs = 0 maxoccurs = unbounded |
string | Список индексов, привязанных к городу |
| — — tariffZone | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тарифная зона доставки |
| — — hasAcquiring | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие эквайринга |
| — — daysDelivery | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Срок доставки от Москвы |
| — — listOfDays | nillable = true minoccurs = 1 maxoccurs = 1 |
ctListOfDays | Дни доставки |
| — — — dayOfWeek | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctDayOfWeek | День недели |
| — — — — day | nillable = false minoccurs = 1 maxoccurs = 1 |
string | День недели |
| — — — — enabled | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Признак включения/выключения дня (1/0) |
| Свернуть таблицу | |||
getOrdersInfo( ) @return getOrdersInfoResponse
Получить информацию о заказах
Параметры функции: getOrdersInfo [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| order | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderIdentity | Идентификатор заказа(ов), по которым необходимо получить информацию |
| — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
Возвращаемое значение: getOrdersInfoResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| ordersInfo | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctGetOrderInfoResult | Информация о заказах |
| — getOrderResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| — orderInfo | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderInfo | Информация о заказе(ах) |
| — — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — — status | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус движения заказа |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — denyReason | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Причина отказа |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — denyType | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип отказа |
| — — workStatus | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус выполнения заказа |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — deliveryType | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип доставки (курьер или самовывоз) |
| — — locationName | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Текущая локация |
| — — reportId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Номер отчета по которому переводились деньги за заказ |
| — — currentShipment | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Отправка, в которой находится заказ (0 - если заказ не в отправке) |
| — — deliveryCostPayAnyway | nillable = true minoccurs = 1 maxoccurs = 1 |
int | 1 - в случае отказа с покупателя взымается полная стоимость доставки. 0 - в случае отказа с покупателя деньге не взымаются |
| — — endOfStorageDate | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата окончания срока хранения заказа |
| — — dateFinalStatus | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата получения финального статуса |
| — — dateFactDelivery | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Фактическая дата доставки |
| — — clientDeliveryCost | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость доставки для покупатя |
| — — clientPaid | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Сумма полученая от покупателя , после доставки заказа |
| — — clientFullCost | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Полная стоимость заказа для покупателя |
| — — deliveryWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderWeightVolume | Вес доставки (объемный и физический) |
| — — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Вес заказа (гр) |
| — — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Объем заказа |
| — — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — — intakeWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderWeightVolume | Вес возврата (объемный и физический) |
| — — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Вес заказа (гр) |
| — — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Объем заказа |
| — — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — — directCost | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderDirectCosts | Стоимость услуг по прямому движению |
| — — — summ | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Суммарная стоимость услуг |
| — — — details | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderDirectCostsDetails | Детализации стоимости |
| — — — — delivery | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость доставки |
| — — — — rko | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость РКО |
| — — — — rko_card | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость РКО (безнал) |
| — — — — pack | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость упаковки |
| — — — — sms | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость СМС-оповещения |
| — — — — marking | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость маркировки |
| — — — — insurance | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость страховки |
| — — — — process_webshop_order | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость обработки заказа |
| — — — — additional_courier | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость дополнительного выезда курьера |
| — — returnCost | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderReturnCosts | Стоимость услуг по обратному движению |
| — — — summ | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Суммарная стоимость услуг по возврату |
| — — — details | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderReturnCostsDetails | Детализация стоимостей по возврату |
| — — — — return | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость возврата |
| — — — — insurance_return | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость страховки возврата |
| — — events | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctEvent | Список событий заказа |
| — — — eventId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Идентификатор события |
| — — — eventType | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Тип события |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — — user | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пользователь, инициировавший событие |
| — — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
dateTime | Дата события |
| — — — prevValue | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Предыдущее значение (при изменени каких-то показателей) |
| — — — newValue | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Установленное значение (при изменени каких-то показателей) |
| — — — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий пользователя |
| — — — region | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Регион, в котором находился заказ на момент редактирования |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — — city | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Город, в котором находился заказ на момент редактирования |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — items | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctItem | Список товаров заказа |
| — — — itemId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | id товара (присваивается автоматически при создании заказа) |
| — — — name | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя товара. Максимальная длина поля - 42 символа. Наименование товара, цвет, размер, дополнительные атрибуты(при наличии). Например, съемные аксессуары такие как: шарф, пояс и т.д. |
| — — — article | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Артикул товара (может содержать символы -, _, цифры и буквы латинского алфавита ) |
| — — — count | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество единиц товара |
| — — — declaredPrice | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Объявленная стоимость единицы товара |
| — — — clientPrice | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Стоимость единицы товара для клиента |
| — — — weight | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Вес товара г. |
| — — — push | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Тип товара (1 - доставка, 0 - возврат). Нужен только в случае serviceType = CHANGE |
| — — — status | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус реализации |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — — deliveryCount | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Количество реализованного товара |
| — — — vat | nillable = true minoccurs = 1 maxoccurs = 1 |
int | НДС |
| — — — trueMark | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код товарной номенклатуры. Используется для передачи кода "Честный знак" |
| — — — trueMarkRequired | nillable = true minoccurs = 1 maxoccurs = 1 |
int | 1 - Сканировать Честный знак при реализации |
| — — — itemCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код товарной позиции в системе клиента |
| — — — itemBarcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | ШК товарной позиции |
| — — — excisable | nillable = true minoccurs = 1 maxoccurs = 1 |
int | |
| — — pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | Идентификатор пункта выдачи (в случае самовывоза заказа) |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — — — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| — — clientInfo | nillable = true minoccurs = 1 maxoccurs = 1 |
ctClientInfo | Информация о клиенте |
| — — — fio | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Фамилия, имя, отчество. Одной строкой |
| — — — phone | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Телефон. Формат номера 8xxxxxxxxxx (11 символов) |
| nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес электронной почты (максимальное кол-во символов - 63) | |
| — — — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий клиента, указывается по необходимости (максимальное кол-во символов - 250) |
| — — services | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderServices | Необходимые сервисы для обслуживания заказа |
| — — — notOpen | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Не вскрывать до получения оплаты с клиента (1/0) |
| — — — marking | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Произвести маркировку (1/0) |
| — — — smsNotify | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Оповещать клиента о смене статуса заказа посредством СМС (1/0) |
| — — — forChoise | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Частичная реализация (1/0) |
| — — — places | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество мест |
| — — — pack | nillable = false minoccurs = 1 maxoccurs = 1 |
ctPack | Параметры упаковки |
| — — — — need | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Требуется ли упаковка (1/0) |
| — — — — type | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип упаковки (из справочника) |
| — — — needPrr | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Требуются погрузочно-разгрузочные работы |
| — — — needLiftingCargo | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Требуется ручное поднятие на этаж |
| — — — needDocReturn | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Требуется возврат документов |
| — — desiredDateDelivery | nillable = true minoccurs = 1 maxoccurs = 1 |
ctDateTimeInterval | Дата и интервал доставки |
| — — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — — — timeInterval | nillable = false minoccurs = 1 maxoccurs = 1 |
ctTimeInterval | интервал доставки |
| — — — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| — — regionAndCity | nillable = true minoccurs = 1 maxoccurs = 1 |
ctRegionAndCity | город и регион доставки |
| — — — cityId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор города |
| — — — regionId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор региона |
| — — partnerExecutor | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Партнер-исполнитель |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — partnerWebshop | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Партнер, работающий с ИМ |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — paymentType | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Способ оплаты |
| — — orderUrl | nillable = true minoccurs = 1 maxoccurs = 1 |
string | url магазина |
| — — deliveryAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctAddress | Адрес доставки |
| — — — type | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип передачи региона и города, допустимые значения: id (из справочника ТД), string (поиск в справочнике ТД по строке), zip (Поиск в справочнике по индексу), pickup (Поиск по идентификатору ПВЗ - указывается только в случае когда deliveryType = PICKUP) |
| — — — region | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Регион, значение зависит от типа |
| — — — city | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Город, значение зависит от типа |
| — — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс, не обязателен, за исключением использования типа zip |
| — — — inCityAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctInCityAddress | Адрес внутри населенного пункта (улица, дом, коркус, квартира) |
| — — — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс |
| — — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | адрес внутри города |
| — — — — floor | nillable = true minoccurs = 0 maxoccurs = 1 |
string | этаж |
| — — — — elevator | nillable = true minoccurs = 0 maxoccurs = 1 |
ctElevator | Наличие лифта |
| — — — — — hasElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие лифта (1 - да, 0 - нет) |
| — — — — — hasFreightElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие грузового лифта (1 - да, 0 - нет) |
| — — — pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | Адрес самовывоза (указывать только в случае самовывоза) |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — — — — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| — — — geoPoint | nillable = true minoccurs = 1 maxoccurs = 1 |
ctGeoPoint | Точка геолокации: широта, долгота |
| — — — — latitude | nillable = false minoccurs = 1 maxoccurs = 1 |
float | |
| — — — — longitude | nillable = false minoccurs = 1 maxoccurs = 1 |
float | |
| — — deliveryVat | nillable = true minoccurs = 1 maxoccurs = 1 |
int | НДС доставки |
| — — dateReceiveInTD | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата получения в ТопДеливери |
| — — shippingInfo | nillable = true minoccurs = 1 maxoccurs = 1 |
ctShippingInfo | Информация о междугородней перевозке |
| — — — estimatedDateReceivedToCity | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Ожидаемая дата поступления в Город назначения |
| — — — dateReceivedToCity | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Фактическая дата поступления в Город назначения |
| — — serviceType | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип заказа |
| — — partnerStatuses | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctPartnerStatuse | Статусы партнера |
| — — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
dateTime | Дата статуса |
| — — — status | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Статус |
| — — webshopBarcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Штрихкод заказа в ИМ |
| — — shifts | nillable = true minoccurs = 0 maxoccurs = 3 |
ctShift | Количество переносов |
| — — — shiftType | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип переноса |
| — — — shiftCount | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество переносов |
| Свернуть таблицу | |||
getPickupCargoesInfo( ) @return getPickupCargoesInfoResponse
Получить информацию о Заявках на забор груза
Параметры функции: getPickupCargoesInfo [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| pickupCargoId | nillable = false minoccurs = 1 maxoccurs = 99 |
int | Заявка на забор груза |
| Свернуть таблицу | |||
Возвращаемое значение: getPickupCargoesInfoResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| pickupCargoesInfo | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctGetPickupCargoesInfoResult | Информация о Заявке на забор груза |
| — getPickupCargoResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| — pickupCargoInfo | nillable = true minoccurs = 0 maxoccurs = 1 |
ctPickupCargo | Информация о Заявке на забор груза |
| — — senderWarehouseInfo | nillable = false minoccurs = 1 maxoccurs = 1 |
ctWarehouseInfo | Склад отгрузки |
| — — — warehouseIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctWarehouseIdentity | Идентификатор склада |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД склада в системе ТД |
| — — — — code | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код склада |
| — — — region | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Регион склада |
| — — — city | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Город склада |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес склада |
| — — receiverWarehouseInfo | nillable = false minoccurs = 1 maxoccurs = 1 |
ctWarehouseInfo | Склад получения |
| — — — warehouseIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctWarehouseIdentity | Идентификатор склада |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД склада в системе ТД |
| — — — — code | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код склада |
| — — — region | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Регион склада |
| — — — city | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Город склада |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес склада |
| — — senderInfo | nillable = false minoccurs = 1 maxoccurs = 1 |
ctSenderInfo | Данные об отправителе груза |
| — — — senderFio | nillable = false minoccurs = 1 maxoccurs = 1 |
string | ФИО отправителя |
| — — — senderPhone | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Телефон отправителя |
| — — — senderEmail | nillable = true minoccurs = 1 maxoccurs = 1 |
string | eMail адреса отправителя используются из настроек склада (разделитель ";") |
| — — pickupDate | nillable = false minoccurs = 1 maxoccurs = 1 |
ctDateTimeInterval | Дата и интервал забора |
| — — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — — — timeInterval | nillable = false minoccurs = 1 maxoccurs = 1 |
ctTimeInterval | интервал доставки |
| — — — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| — — quantityPlaces | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество грузомест |
| — — cargoWeightInfo | nillable = false minoccurs = 1 maxoccurs = 1 |
ctCargoWeightInfo | Весогабариты Заявки на забор |
| — — — physicalWeight | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Физический вес в кг |
| — — — volumeWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Объемный вес в кг |
| — — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Длина, ширина, высота в см |
| — — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — — returnPackInfo | nillable = false minoccurs = 1 maxoccurs = 1 |
ctReturnPack | Возвратная тара |
| — — — returnPackType | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип возвратной тары (PALLET - Паллеты, BAG - Мешки, DUMP - Россыпь) |
| — — — returnPackCount | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество возвратной тары |
| — — courierInfo | nillable = true minoccurs = 0 maxoccurs = 1 |
ctForwarderInfo | Курьер, осуществляющий забор |
| — — — fio | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Фамилия, имя, отчество. Одной строкой |
| — — — phone | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Телефон. Формат номера 8xxxxxxxxxx (11 символов) |
| — — moveStatus | nillable = false minoccurs = 1 maxoccurs = 1 |
ctPickupCargoStatus | Статус перемещения |
| — — workStatus | nillable = false minoccurs = 1 maxoccurs = 1 |
ctPickupCargoStatus | Статус выполнения |
| — — routeStatus | nillable = false minoccurs = 1 maxoccurs = 1 |
ctPickupCargoStatus | Статус маршрутизации |
| — — problemStatus | nillable = false minoccurs = 1 maxoccurs = 1 |
ctPickupCargoStatus | Статус проблемности |
| — — finStatus | nillable = false minoccurs = 1 maxoccurs = 1 |
ctPickupCargoStatus | Статус рассчетов |
| — — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий к Заявке на забор |
| Свернуть таблицу | |||
calcOrderCosts( ) @return calcOrderCostsResponse
Расчет предварительной стоимости доставки/обмена/возврата заказа
Параметры функции: calcOrderCosts [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| orderParams | nillable = false minoccurs = 1 maxoccurs = 1 |
ctCalcOrderParams | Параметры заказа, из которых делается расчет |
| — serviceType | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип заказа (DELIVERY, INTAKE, CHANGE) |
| — deliveryType | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип доставки (COURIER, PICKUP) |
| — deliveryWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderWeightVolume | Вес доставки |
| — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Вес заказа (гр) |
| — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Объем заказа |
| — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — intakeWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderWeightVolume | Вес возврата |
| — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Вес заказа (гр) |
| — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Объем заказа |
| — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — clientCost | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Сумма наложенного платежа |
| — declaredSum | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Объявленая стоимость доставки |
| — declaredReturnSum | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Объявленная стоимость возврата |
| — addDelivery | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Пересчитывать ли стоимость доставки (на данный момент не используется) |
| — deliveryAddress | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAddress | Адрес доставки |
| — — type | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип передачи региона и города, допустимые значения: id (из справочника ТД), string (поиск в справочнике ТД по строке), zip (Поиск в справочнике по индексу), pickup (Поиск по идентификатору ПВЗ - указывается только в случае когда deliveryType = PICKUP) |
| — — region | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Регион, значение зависит от типа |
| — — city | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Город, значение зависит от типа |
| — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс, не обязателен, за исключением использования типа zip |
| — — inCityAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctInCityAddress | Адрес внутри населенного пункта (улица, дом, коркус, квартира) |
| — — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | адрес внутри города |
| — — — floor | nillable = true minoccurs = 0 maxoccurs = 1 |
string | этаж |
| — — — elevator | nillable = true minoccurs = 0 maxoccurs = 1 |
ctElevator | Наличие лифта |
| — — — — hasElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие лифта (1 - да, 0 - нет) |
| — — — — hasFreightElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие грузового лифта (1 - да, 0 - нет) |
| — — pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | Адрес самовывоза (указывать только в случае самовывоза) |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — — — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| — — geoPoint | nillable = true minoccurs = 1 maxoccurs = 1 |
ctGeoPoint | Точка геолокации: широта, долгота |
| — — — latitude | nillable = false minoccurs = 1 maxoccurs = 1 |
float | |
| — — — longitude | nillable = false minoccurs = 1 maxoccurs = 1 |
float | |
| Свернуть таблицу | |||
Возвращаемое значение: calcOrderCostsResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| calcOrderCosts | nillable = true minoccurs = 0 maxoccurs = 1 |
ctCalcOrderResult | Рассчитанные стоимости заказа |
| — delivery | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость доставки |
| — rko | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость РКО |
| — insurance | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость страховки |
| — return | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость возврата |
| — insuranceReturn | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость страховки возврата |
| Свернуть таблицу | |||
Пример
PHP [+]
getNearDeliveryDatesIntervals( ) @return getNearDeliveryDatesIntervalsResponse
Получение ближайших возможных дат доставки с интервалами в заданном городе.
Параметры функции: getNearDeliveryDatesIntervals [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| addressDeliveryProperties | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAddressDeliveryProperties | Адрес доставки и ее свойства |
| — serviceType | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип услуги по заказу (DELIVERY, INTAKE, CHANGE) |
| — deliveryType | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип доставки (COURIER, PICKUP) |
| — orderSubtype | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип заказа: обычный(SIMPLE) или корреспонденция(DOCUMENT) |
| — deliveryAddress | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAddress | Адрес доставки |
| — — type | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип передачи региона и города, допустимые значения: id (из справочника ТД), string (поиск в справочнике ТД по строке), zip (Поиск в справочнике по индексу), pickup (Поиск по идентификатору ПВЗ - указывается только в случае когда deliveryType = PICKUP) |
| — — region | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Регион, значение зависит от типа |
| — — city | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Город, значение зависит от типа |
| — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс, не обязателен, за исключением использования типа zip |
| — — inCityAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctInCityAddress | Адрес внутри населенного пункта (улица, дом, коркус, квартира) |
| — — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | адрес внутри города |
| — — — floor | nillable = true minoccurs = 0 maxoccurs = 1 |
string | этаж |
| — — — elevator | nillable = true minoccurs = 0 maxoccurs = 1 |
ctElevator | Наличие лифта |
| — — — — hasElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие лифта (1 - да, 0 - нет) |
| — — — — hasFreightElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие грузового лифта (1 - да, 0 - нет) |
| — — pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | Адрес самовывоза (указывать только в случае самовывоза) |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — — — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| — — geoPoint | nillable = true minoccurs = 1 maxoccurs = 1 |
ctGeoPoint | Точка геолокации: широта, долгота |
| — — — latitude | nillable = false minoccurs = 1 maxoccurs = 1 |
float | |
| — — — longitude | nillable = false minoccurs = 1 maxoccurs = 1 |
float | |
| — dateSend | nillable = true minoccurs = 0 maxoccurs = 1 |
date | Дата отгрузки в ТД |
| Свернуть таблицу | |||
Возвращаемое значение: getNearDeliveryDatesIntervalsResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| dateTimeIntervals | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctDateTimeIntervals | Ближайшие возможные даты доставки с интервалами |
| — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — timeInterval | nillable = false minoccurs = 0 maxoccurs = unbounded |
ctTimeInterval | Интервалы доставки |
| — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| Свернуть таблицу | |||
getAvailableDeliveryDatesWithIntervals( ) @return getAvailableDeliveryDatesWithIntervalsResponse
Получить доступные для выбора даты доставки с интервалами для конкретного Заказа
Параметры функции: getAvailableDeliveryDatesWithIntervals [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| accessToken | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Токен доступа к операциям над заказом |
| orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
Возвращаемое значение: getAvailableDeliveryDatesWithIntervalsResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| dateTimeIntervals | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctDateTimeIntervals | Доступные даты доставки с интервалами |
| — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — timeInterval | nillable = false minoccurs = 0 maxoccurs = unbounded |
ctTimeInterval | Интервалы доставки |
| — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| Свернуть таблицу | |||
setAddressDelivery( ) @return setAddressDeliveryResponse
Изменить адрес доставки Заказа
Параметры функции: setAddressDelivery [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| accessToken | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Токен доступа к операциям над заказом |
| orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| city | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Название города |
| addressDelivery | nillable = false minoccurs = 1 maxoccurs = 1 |
ctInCityAddress | Адрес доставки |
| — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс |
| — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | адрес внутри города |
| — floor | nillable = true minoccurs = 0 maxoccurs = 1 |
string | этаж |
| — elevator | nillable = true minoccurs = 0 maxoccurs = 1 |
ctElevator | Наличие лифта |
| — — hasElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие лифта (1 - да, 0 - нет) |
| — — hasFreightElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие грузового лифта (1 - да, 0 - нет) |
| Свернуть таблицу | |||
Возвращаемое значение: setAddressDeliveryResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| Свернуть таблицу | |||
setDesiredDateDelivery( ) @return setDesiredDateDeliveryResponse
Изменить желаемую дату доставки Заказа
Параметры функции: setDesiredDateDelivery [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| accessToken | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Токен доступа к операциям над заказом |
| orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| desiredDateDelivery | nillable = false minoccurs = 1 maxoccurs = 1 |
ctDateTimeIntervals | Желаемая дата доставки с интервалом |
| — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — timeInterval | nillable = false minoccurs = 0 maxoccurs = unbounded |
ctTimeInterval | Интервалы доставки |
| — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| Свернуть таблицу | |||
Возвращаемое значение: setDesiredDateDeliveryResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| Свернуть таблицу | |||
cancelOrder( ) @return cancelOrderResponse
Отмена заказа для некоторых ИМ
Параметры функции: cancelOrder [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
Возвращаемое значение: cancelOrderResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| cancelOrderResult | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctAddOrderResult | Результат удаления |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус операции над заказом |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сопроводительное сообщение |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификаторы заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
deleteOrder( ) @return deleteOrderResponse
Удаление ранее добавленного заказа
Параметры функции: deleteOrder [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| orderIdentity | nillable = false minoccurs = 1 maxoccurs = unbounded |
ctOrderIdentity | Идентификатор заказа |
| — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
Возвращаемое значение: deleteOrderResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| deleteOrderResult | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctAddOrderResult | Результат удаления |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус операции над заказом |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сопроводительное сообщение |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификаторы заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
getShipmentsByParams( ) @return getShipmentsByParamsResponse
Получить список отправок по заданным параметрам
Параметры функции: getShipmentsByParams [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | Адрес самовывоза (не используется) |
| — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| shipmentStatus | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус отправки |
| — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| shipmentDirection | nillable = true minoccurs = 1 maxoccurs = 1 |
ctShipmentDirection | Направление движения отправки |
| — type | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип отправки, допустимые значения для партнеров: INTERCITY, TRANSFER, TO_WEBSHOP для ИМ: FROM_WEBSHOP |
| — receiverId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД получателя из справочника |
| — senderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД отправителя из справочника |
| — directionName | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комплексное название, записывается как type@receiverId |
| — senderWarehouse | nillable = true minoccurs = 0 maxoccurs = 1 |
ctWarehouseIdentity | Склад отправителя |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД склада в системе ТД |
| — — code | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код склада |
| — receiverWarehouse | nillable = true minoccurs = 0 maxoccurs = 1 |
ctWarehouseIdentity | Склад получателя |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД склада в системе ТД |
| — — code | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код склада |
| dateCreate | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата создания отправки |
| Свернуть таблицу | |||
Возвращаемое значение: getShipmentsByParamsResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| shipments | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctShipment | Идентификаторы найденных отправок |
| — shipmentId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Идентификатор отправки |
| — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Вес отправки |
| — placesCount | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Количество мест |
| — ordersCount | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Количество заказов в отправке |
| — dateCreate | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата создания отправки |
| — sorted | nillable = true minoccurs = 1 maxoccurs = 1 |
int | (!) Флаг указывающий на что отправка принята позаказно на складе ТД |
| — pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | (!) Адрес пункта самовывоза |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| — status | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус отправки |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — shipmentPlace | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctShipmentPlace | Грузовые места в отправке |
| — — number | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Номер грузового места |
| — — weight | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Вес грузовго места |
| — — pallets | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Количество паллет |
| — intakeParams | nillable = true minoccurs = 1 maxoccurs = 1 |
ctShipmentIntakeParams | Параметры забора отправки |
| — — need | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Требуется ли забор (1/0) |
| — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес забора одной строкой |
| — — contacts | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Контакты для связи с отправляющей стороной (Номер телефона) |
| — — intakeDate | nillable = true minoccurs = 1 maxoccurs = 1 |
ctDateTimeInterval | Дата и интервал забора |
| — — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — — — timeInterval | nillable = false minoccurs = 1 maxoccurs = 1 |
ctTimeInterval | интервал доставки |
| — — — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| — shipmentDirection | nillable = true minoccurs = 1 maxoccurs = 1 |
ctShipmentDirection | Параметры направления движения отправки |
| — — type | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип отправки, допустимые значения для партнеров: INTERCITY, TRANSFER, TO_WEBSHOP для ИМ: FROM_WEBSHOP |
| — — receiverId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД получателя из справочника |
| — — senderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД отправителя из справочника |
| — — directionName | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комплексное название, записывается как type@receiverId |
| — — senderWarehouse | nillable = true minoccurs = 0 maxoccurs = 1 |
ctWarehouseIdentity | Склад отправителя |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД склада в системе ТД |
| — — — code | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код склада |
| — — receiverWarehouse | nillable = true minoccurs = 0 maxoccurs = 1 |
ctWarehouseIdentity | Склад получателя |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД склада в системе ТД |
| — — — code | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код склада |
| — events | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctEvent | Список событий отправки |
| — — eventId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Идентификатор события |
| — — eventType | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Тип события |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — user | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пользователь, инициировавший событие |
| — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
dateTime | Дата события |
| — — prevValue | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Предыдущее значение (при изменени каких-то показателей) |
| — — newValue | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Установленное значение (при изменени каких-то показателей) |
| — — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий пользователя |
| — — region | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Регион, в котором находился заказ на момент редактирования |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — city | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Город, в котором находился заказ на момент редактирования |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — orders | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderIdentity | Заказы для прикрепления к заявке |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
getOrdersByParams( ) @return getOrdersByParamsResponse
Получить список заказов по заданным параметрам
Параметры функции: getOrdersByParams [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| orderIdentity | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Заказ |
| — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| orderStatus | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус движения заказа |
| — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| orderWorkStatus | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус выполнения заказа |
| — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | Адрес самовывоза |
| — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| clientInfo | nillable = true minoccurs = 1 maxoccurs = 1 |
ctClientInfo | Информация о клиенте |
| — fio | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Фамилия, имя, отчество. Одной строкой |
| — phone | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Телефон. Формат номера 8xxxxxxxxxx (11 символов) |
| nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес электронной почты (максимальное кол-во символов - 63) | |
| — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий клиента, указывается по необходимости (максимальное кол-во символов - 250) |
| reportId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Номер отчета, по которому переводились деньги за заказ |
| dateCreate | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата создания заказа |
| currentShipment | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Отправка, в которой находится заказ |
| clientPaid | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Сумма полученая от покупателя , после доставки заказа |
| dateFinalStatus | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата получения финального статуса |
| dateFactDelivery | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Фактическая дата доставки |
| withoutLocked | nillable = true minoccurs = 0 maxoccurs = 1 |
int | Получить без заблокированных заказов |
| Свернуть таблицу | |||
Возвращаемое значение: getOrdersByParamsResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| orderInfo | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderInfo | Идентификаторы найденных заказов |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — status | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус движения заказа |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — denyReason | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Причина отказа |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — denyType | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип отказа |
| — workStatus | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус выполнения заказа |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — deliveryType | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип доставки (курьер или самовывоз) |
| — locationName | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Текущая локация |
| — reportId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Номер отчета по которому переводились деньги за заказ |
| — currentShipment | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Отправка, в которой находится заказ (0 - если заказ не в отправке) |
| — deliveryCostPayAnyway | nillable = true minoccurs = 1 maxoccurs = 1 |
int | 1 - в случае отказа с покупателя взымается полная стоимость доставки. 0 - в случае отказа с покупателя деньге не взымаются |
| — endOfStorageDate | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата окончания срока хранения заказа |
| — dateFinalStatus | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата получения финального статуса |
| — dateFactDelivery | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Фактическая дата доставки |
| — clientDeliveryCost | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость доставки для покупатя |
| — clientPaid | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Сумма полученая от покупателя , после доставки заказа |
| — clientFullCost | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Полная стоимость заказа для покупателя |
| — deliveryWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderWeightVolume | Вес доставки (объемный и физический) |
| — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Вес заказа (гр) |
| — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Объем заказа |
| — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — intakeWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderWeightVolume | Вес возврата (объемный и физический) |
| — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Вес заказа (гр) |
| — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Объем заказа |
| — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — directCost | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderDirectCosts | Стоимость услуг по прямому движению |
| — — summ | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Суммарная стоимость услуг |
| — — details | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderDirectCostsDetails | Детализации стоимости |
| — — — delivery | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость доставки |
| — — — rko | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость РКО |
| — — — rko_card | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость РКО (безнал) |
| — — — pack | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость упаковки |
| — — — sms | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость СМС-оповещения |
| — — — marking | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость маркировки |
| — — — insurance | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость страховки |
| — — — process_webshop_order | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость обработки заказа |
| — — — additional_courier | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость дополнительного выезда курьера |
| — returnCost | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderReturnCosts | Стоимость услуг по обратному движению |
| — — summ | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Суммарная стоимость услуг по возврату |
| — — details | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderReturnCostsDetails | Детализация стоимостей по возврату |
| — — — return | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость возврата |
| — — — insurance_return | nillable = true minoccurs = 1 maxoccurs = 1 |
double | Стоимость страховки возврата |
| — events | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctEvent | Список событий заказа |
| — — eventId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Идентификатор события |
| — — eventType | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Тип события |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — user | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пользователь, инициировавший событие |
| — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
dateTime | Дата события |
| — — prevValue | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Предыдущее значение (при изменени каких-то показателей) |
| — — newValue | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Установленное значение (при изменени каких-то показателей) |
| — — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий пользователя |
| — — region | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Регион, в котором находился заказ на момент редактирования |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — city | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Город, в котором находился заказ на момент редактирования |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — items | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctItem | Список товаров заказа |
| — — itemId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | id товара (присваивается автоматически при создании заказа) |
| — — name | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя товара. Максимальная длина поля - 42 символа. Наименование товара, цвет, размер, дополнительные атрибуты(при наличии). Например, съемные аксессуары такие как: шарф, пояс и т.д. |
| — — article | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Артикул товара (может содержать символы -, _, цифры и буквы латинского алфавита ) |
| — — count | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество единиц товара |
| — — declaredPrice | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Объявленная стоимость единицы товара |
| — — clientPrice | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Стоимость единицы товара для клиента |
| — — weight | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Вес товара г. |
| — — push | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Тип товара (1 - доставка, 0 - возврат). Нужен только в случае serviceType = CHANGE |
| — — status | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус реализации |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — deliveryCount | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Количество реализованного товара |
| — — vat | nillable = true minoccurs = 1 maxoccurs = 1 |
int | НДС |
| — — trueMark | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код товарной номенклатуры. Используется для передачи кода "Честный знак" |
| — — trueMarkRequired | nillable = true minoccurs = 1 maxoccurs = 1 |
int | 1 - Сканировать Честный знак при реализации |
| — — itemCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код товарной позиции в системе клиента |
| — — itemBarcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | ШК товарной позиции |
| — — excisable | nillable = true minoccurs = 1 maxoccurs = 1 |
int | |
| — pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | Идентификатор пункта выдачи (в случае самовывоза заказа) |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| — clientInfo | nillable = true minoccurs = 1 maxoccurs = 1 |
ctClientInfo | Информация о клиенте |
| — — fio | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Фамилия, имя, отчество. Одной строкой |
| — — phone | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Телефон. Формат номера 8xxxxxxxxxx (11 символов) |
| nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес электронной почты (максимальное кол-во символов - 63) | |
| — — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий клиента, указывается по необходимости (максимальное кол-во символов - 250) |
| — services | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderServices | Необходимые сервисы для обслуживания заказа |
| — — notOpen | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Не вскрывать до получения оплаты с клиента (1/0) |
| — — marking | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Произвести маркировку (1/0) |
| — — smsNotify | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Оповещать клиента о смене статуса заказа посредством СМС (1/0) |
| — — forChoise | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Частичная реализация (1/0) |
| — — places | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество мест |
| — — pack | nillable = false minoccurs = 1 maxoccurs = 1 |
ctPack | Параметры упаковки |
| — — — need | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Требуется ли упаковка (1/0) |
| — — — type | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип упаковки (из справочника) |
| — — needPrr | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Требуются погрузочно-разгрузочные работы |
| — — needLiftingCargo | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Требуется ручное поднятие на этаж |
| — — needDocReturn | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Требуется возврат документов |
| — desiredDateDelivery | nillable = true minoccurs = 1 maxoccurs = 1 |
ctDateTimeInterval | Дата и интервал доставки |
| — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — — timeInterval | nillable = false minoccurs = 1 maxoccurs = 1 |
ctTimeInterval | интервал доставки |
| — — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| — regionAndCity | nillable = true minoccurs = 1 maxoccurs = 1 |
ctRegionAndCity | город и регион доставки |
| — — cityId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор города |
| — — regionId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор региона |
| — partnerExecutor | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Партнер-исполнитель |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — partnerWebshop | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Партнер, работающий с ИМ |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — paymentType | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Способ оплаты |
| — orderUrl | nillable = true minoccurs = 1 maxoccurs = 1 |
string | url магазина |
| — deliveryAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctAddress | Адрес доставки |
| — — type | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип передачи региона и города, допустимые значения: id (из справочника ТД), string (поиск в справочнике ТД по строке), zip (Поиск в справочнике по индексу), pickup (Поиск по идентификатору ПВЗ - указывается только в случае когда deliveryType = PICKUP) |
| — — region | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Регион, значение зависит от типа |
| — — city | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Город, значение зависит от типа |
| — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс, не обязателен, за исключением использования типа zip |
| — — inCityAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctInCityAddress | Адрес внутри населенного пункта (улица, дом, коркус, квартира) |
| — — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | адрес внутри города |
| — — — floor | nillable = true minoccurs = 0 maxoccurs = 1 |
string | этаж |
| — — — elevator | nillable = true minoccurs = 0 maxoccurs = 1 |
ctElevator | Наличие лифта |
| — — — — hasElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие лифта (1 - да, 0 - нет) |
| — — — — hasFreightElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие грузового лифта (1 - да, 0 - нет) |
| — — pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | Адрес самовывоза (указывать только в случае самовывоза) |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — — — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| — — geoPoint | nillable = true minoccurs = 1 maxoccurs = 1 |
ctGeoPoint | Точка геолокации: широта, долгота |
| — — — latitude | nillable = false minoccurs = 1 maxoccurs = 1 |
float | |
| — — — longitude | nillable = false minoccurs = 1 maxoccurs = 1 |
float | |
| — deliveryVat | nillable = true minoccurs = 1 maxoccurs = 1 |
int | НДС доставки |
| — dateReceiveInTD | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата получения в ТопДеливери |
| — shippingInfo | nillable = true minoccurs = 1 maxoccurs = 1 |
ctShippingInfo | Информация о междугородней перевозке |
| — — estimatedDateReceivedToCity | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Ожидаемая дата поступления в Город назначения |
| — — dateReceivedToCity | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Фактическая дата поступления в Город назначения |
| — serviceType | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип заказа |
| — partnerStatuses | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctPartnerStatuse | Статусы партнера |
| — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
dateTime | Дата статуса |
| — — status | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Статус |
| — webshopBarcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Штрихкод заказа в ИМ |
| — shifts | nillable = true minoccurs = 0 maxoccurs = 3 |
ctShift | Количество переносов |
| — — shiftType | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип переноса |
| — — shiftCount | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество переносов |
| Свернуть таблицу | |||
getReports( ) @return getReportsResponse
Получить отчеты за заданный период
Параметры функции: getReports [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| date_create | nillable = false minoccurs = 1 maxoccurs = 1 |
date | С какой даты вести поиск |
| Свернуть таблицу | |||
Возвращаемое значение: getReportsResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| report | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctReportInfo | Список полученных отчетов |
| — id | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Идентификатор отчета |
| — groupId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Идентификатор группы отчетов |
| — date_create | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата формирования группы |
| Свернуть таблицу | |||
getPickupAddressesByParams( ) @return getPickupAddressesByParamsResponse
Поиск ПВЗ по заданным параметрам
Параметры функции: getPickupAddressesByParams [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| params | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPikupParams | Параметры для поиска |
| — showOwnPickups | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Показывать только ПВЗ владельца |
| — dimension | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Длина, ширина, высота |
| — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — services | nillable = true minoccurs = 0 maxoccurs = unbounded |
int | Поддерживыемые сервисы |
| — city | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Город |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — region | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Регион |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — maxDeclaredPrice | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Максимальная цена |
| — maxClientPrice | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Максимальная цена для клиента |
| — maxWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Максимальный вес |
| — pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | Адрес/имя/ид ПВЗ |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| Свернуть таблицу | |||
Возвращаемое значение: getPickupAddressesByParamsResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| pickups | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctPikupInfo | найденные ПВЗ |
| — pickupAddress | nillable = true minoccurs = 1 maxoccurs = 1 |
ctPickupAddress | Адрес ПВЗ |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ID пункта самовывоза |
| — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес пункта самовывоза |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название пункта самовывоза |
| — — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| — direction | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Как добраться до ПВЗ |
| — region | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | ID региона |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — city | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | ID города |
| — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — metro | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Ближайшее метро |
| — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс |
| — title | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Наименование ПВЗ |
| — partnerPickupName | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Наименование ПВЗ в системе Партнера (если нет, то в нашей системе) |
| — dimension | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Длина, ширина, высота |
| — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — listOfServices | nillable = true minoccurs = 1 maxoccurs = 1 |
ctListOfServices | Поддерживыемые сервисы |
| — — service | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctIdNameCompare | Идентификатор и наименование сервиса |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — coords | nillable = true minoccurs = 1 maxoccurs = 1 |
ctCoords | Координаты |
| — — latitude | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Широта |
| — — longitude | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Долгота |
| — orderTerm | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Срок хранения заказа на ПВЗ |
| — listOfWorkShedule | nillable = true minoccurs = 1 maxoccurs = 1 |
ctListOfWorkShedule | Режимы работы по дням недели |
| — — workShedule | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctDaysWithIntervals | Режим работы |
| — — — day | nillable = false minoccurs = 1 maxoccurs = 1 |
string | День недели |
| — — — timeInterval | nillable = true minoccurs = 1 maxoccurs = 1 |
ctTimeInterval | Временной интервал |
| — — — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| — maxDeclaredPrice | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Максимальная объявленная цена |
| — maxClientPrice | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Максимальная цена для клиента |
| — maxWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Максимальный вес |
| — contacts | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Контакты |
| — pickupOwnerName | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Наименование постаматной сети |
| — tcName | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Наименование ТЦ |
| — pickupType | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип ПВЗ (INDIVIDUAL - ПВЗ, SHOP - касса магазина, POSTAMAT - постамат) |
| — minDaysDelivery | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Минимальный срок доставки заказа до ПВЗ в днях |
| — maxDaysDelivery | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Максимальный срок доставки заказа до ПВЗ в днях |
| Свернуть таблицу | |||
addOrderPlaces( ) @return addOrderPlacesResponse
Добавление грузомест
Параметры функции: addOrderPlaces [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| addedOrderPlaces | nillable = false minoccurs = 1 maxoccurs = unbounded |
ctAddedOrderPlaces | Список создаваемых грузомест |
| — order | nillable = false minoccurs = 0 maxoccurs = unbounded |
ctOrderIdentity | Идентификатор заказа, для которого создается грузоместо |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — indexNumber | nillable = false minoccurs = 1 maxoccurs = 99 |
int | Порядковый номер грузоместа |
| — webshopNumber | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Номер грузоместа в ИМ |
| — webshopBarcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Штрихкод грузоместа в ИМ |
| — placeWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderWeightVolume | Весогабариты грузоместа |
| — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Вес заказа (гр) |
| — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Объем заказа |
| — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — items | nillable = false minoccurs = 1 maxoccurs = unbounded |
ctOrderPlaceItem | Товары в грузоместе |
| — — itemCode | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Код товарной позиции в системе клиента |
| — — supplierSummary | nillable = true minoccurs = 0 maxoccurs = 1 |
ctSupplierSummary | Краткая информация о поставщике товара |
| — — — INN | nillable = false minoccurs = 1 maxoccurs = 1 |
string | ИНН поставщика |
| — — — jurName | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Юридическое лицо |
| — — — jurAddress | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Юридический адрес |
| — — — commercialName | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Коммерческое наименование |
| — — — phone | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Номер телефона |
| Свернуть таблицу | |||
Возвращаемое значение: addOrderPlacesResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| addOrderPlacesResult | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctAddOrderPlaceResult | Результат добавления грузоместа |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус операции над грузоместом |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сопроводительное сообщение |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — orderPlaceIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderPlaceIdentity | Идентификаторы грузоместа |
| — — orderPlaceId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода грузоместа заказа в системе ТД |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер грузоместа заказа в магазине |
| Свернуть таблицу | |||
getOrderPlacesInfo( ) @return getOrderPlacesInfoResponse
Получить информацию о грузоместах в заказах
Параметры функции: getOrderPlacesInfo [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| orderPlaces | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderPlaces | Список идентификаторов грузомест, по которым необходимо получить информацию |
| — order | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — orderPlace | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderPlaceIdentity | Идентификатор грузоместа |
| — — orderPlaceId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода грузоместа заказа в системе ТД |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер грузоместа заказа в магазине |
| Свернуть таблицу | |||
Возвращаемое значение: getOrderPlacesInfoResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| orderPlacesInfo | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderPlaceInfoResult | Информация о грузоместах |
| — getOrderPlaceResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — orderPlaceInfo | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderPlaceInfo | Информация о грузоместе(ах) |
| — — orderPlaceIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderPlaceIdentity | Идентификатор грузоместа |
| — — — orderPlaceId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода грузоместа заказа в системе ТД |
| — — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер грузоместа заказа в магазине |
| — — indexNumber | nillable = false minoccurs = 0 maxoccurs = 99 |
int | Порядковый номер грузоместа |
| — — workStatus | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус выполнения грузоместа |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — status | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус движения грузоместа |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — denyReasonId | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Причина отказа грузоместа |
| — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — denyType | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Тип отказа |
| — — dateReceiveInTD | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата получения грузоместа в ТопДеливери |
| — — dateFactDelivery | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Фактическая дата доставки грузоместа |
| — — currentShipment | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Отправка, в которой находится грузоместо (0 - если грузоместо не в отправке) |
| — — placeWeight | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderWeightVolume | Переданные весогабариты грузоместа |
| — — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Вес заказа (гр) |
| — — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Объем заказа |
| — — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — — placeWeightFact | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderWeightVolume | Фактические весогабариты грузоместа |
| — — — weight | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Вес заказа (гр) |
| — — — volume | nillable = true minoccurs = 1 maxoccurs = 1 |
ctVolume | Объем заказа |
| — — — — length | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Длина коробки с заказом (см) |
| — — — — width | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Ширина коробки с заказом (см) |
| — — — — height | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Высота коробки с заказом (см) |
| — — events | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctEvent | Список событий грузоместа |
| — — — eventId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Идентификатор события |
| — — — eventType | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Тип события |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — — user | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пользователь, инициировавший событие |
| — — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
dateTime | Дата события |
| — — — prevValue | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Предыдущее значение (при изменени каких-то показателей) |
| — — — newValue | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Установленное значение (при изменени каких-то показателей) |
| — — — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий пользователя |
| — — — region | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Регион, в котором находился заказ на момент редактирования |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — — city | nillable = false minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Город, в котором находился заказ на момент редактирования |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — items | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderPlaceItemsInfo | Список товаров грузоместа |
| — — — itemId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | id товара (присваивается автоматически при создании заказа) |
| — — — name | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя товара |
| — — — article | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Артикул товара (может содержать символы -, _, цифры и буквы латинского алфавита ) |
| — — — count | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Количество единиц товара |
| — — — declaredPrice | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Объявленная стоимость единицы товара |
| — — — clientPrice | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Стоимость единицы товара для клиента |
| — — — weight | nillable = false minoccurs = 1 maxoccurs = 1 |
double | Вес товара г. |
| — — — push | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Тип товара (1 - доставка, 0 - возврат) |
| — — — status | nillable = true minoccurs = 1 maxoccurs = 1 |
ctIdNameCompare | Статус реализации |
| — — — — id | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Идентификатор |
| — — — — name | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Имя |
| — — — deliveryCount | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Количество реализованного товара |
| — — — vat | nillable = true minoccurs = 1 maxoccurs = 1 |
int | НДС |
| — — — trueMark | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код товарной номенклатуры. Используется для передачи кода "Честный знак" |
| — — — trueMarkRequired | nillable = true minoccurs = 1 maxoccurs = 1 |
int | 1 - Сканировать Честный знак при реализации |
| — — — itemCode | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Код товарной позиции в системе клиента |
| — — — supplierSummary | nillable = true minoccurs = 0 maxoccurs = 1 |
ctSupplierSummary | Краткая информация о поставщике товара |
| — — — — INN | nillable = false minoccurs = 1 maxoccurs = 1 |
string | ИНН поставщика |
| — — — — jurName | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Юридическое лицо |
| — — — — jurAddress | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Юридический адрес |
| — — — — commercialName | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Коммерческое наименование |
| — — — — phone | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Номер телефона |
| — — webshopBarcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Штрихкод грузоместа в ИМ |
| Свернуть таблицу | |||
getOrderDeliveryList( ) @return getOrderDeliveryListResponse
Получить зону доставки по номеру заказа
Параметры функции: getOrderDeliveryList [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| order | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderIdentity | Идентификатор заказа(ов), по которым необходимо получить информацию |
| — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
Возвращаемое значение: getOrderDeliveryListResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| orderDeliveryListResult | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderDeliveryListResult | Информация о зоне доставки и заказе |
| — deliveryZone | nillable = false minoccurs = 1 maxoccurs = 1 |
ctDeliveryZone | Параметры зоны доставки |
| — — name | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Наименование зоны доставки |
| — — isRegion | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Признак, находится ли заказ в регионе (старый параметр) |
| — — regionType | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Признак, в каком регионе заказ |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Номера и коды заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
getReceiptsInfo( ) @return getReceiptsInfoResponse
Получить информацию о чеке
Параметры функции: getReceiptsInfo [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| order | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctOrderIdentity | Идентификатор заказа(ов), по которым необходимо получить информацию |
| — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
Возвращаемое значение: getReceiptsInfoResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| receiptInfo | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctGetReceiptInfoResult | Информация о чеке |
| — getReceiptResult | nillable = true minoccurs = 1 maxoccurs = 1 |
ctRequestResult | |
| — — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| — receiptInfo | nillable = true minoccurs = 1 maxoccurs = 1 |
ctReceiptInfo | |
| — — orderIdentity | nillable = true minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Номер заказа |
| — — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — — paymentValue | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сумма платежа с НДС |
| — — paymentDate | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Дата регистрации платежа |
| — — fiscalDocumentNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер фискального документа чека |
| — — chequeLink | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Ссылка на чек |
| — — paymentType | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Метод оплаты (CASH/CARD) |
| Свернуть таблицу | |||
getAccessTokensForEditOrderData( ) @return getAccessTokensForEditOrderDataResponse
Получить токен доступа для редактирования заказа
Параметры функции: getAccessTokensForEditOrderData [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| orders | nillable = false minoccurs = 1 maxoccurs = unbounded |
ctOrderIdentity | Редактируемый заказ |
| — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| Свернуть таблицу | |||
Возвращаемое значение: getAccessTokensForEditOrderDataResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| accessTokens | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctGetAccessTokenResult | Список токенов доступа |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — accessToken | nillable = true minoccurs = 0 maxoccurs = 1 |
ctAccessTokenInfo | Информация о токенах доступа |
| — — type | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Тип токена доступа |
| — — value | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Токен доступа |
| Свернуть таблицу | |||
changeOrdersToReturn( ) @return changeOrdersToReturnResponse
Создать заявку на возврат доставленных заказов
Параметры функции: changeOrdersToReturn [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| changeOrderToReturnParams | nillable = false minoccurs = 1 maxoccurs = unbounded |
ctChangeOrderToReturnParams | Параметры возвращаемых заказов |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — accessCode | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Код доступа для создания заявки |
| — desireDateIntake | nillable = true minoccurs = 0 maxoccurs = 1 |
ctDateTimeInterval | Желаемая дата забора от получателя |
| — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — — timeInterval | nillable = false minoccurs = 1 maxoccurs = 1 |
ctTimeInterval | интервал доставки |
| — — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| — clientInfo | nillable = true minoccurs = 0 maxoccurs = 1 |
ctClientInfo | Информация от кого забрать |
| — — fio | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Фамилия, имя, отчество. Одной строкой |
| — — phone | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Телефон. Формат номера 8xxxxxxxxxx (11 символов) |
| nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес электронной почты (максимальное кол-во символов - 63) | |
| — — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий клиента, указывается по необходимости (максимальное кол-во символов - 250) |
| — clientAddress | nillable = true minoccurs = 0 maxoccurs = 1 |
ctInCityAddress | Адрес откуда забрать |
| — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс |
| — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | адрес внутри города |
| — — floor | nillable = true minoccurs = 0 maxoccurs = 1 |
string | этаж |
| — — elevator | nillable = true minoccurs = 0 maxoccurs = 1 |
ctElevator | Наличие лифта |
| — — — hasElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие лифта (1 - да, 0 - нет) |
| — — — hasFreightElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие грузового лифта (1 - да, 0 - нет) |
| — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| Свернуть таблицу | |||
Возвращаемое значение: changeOrdersToReturnResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| changeOrderToReturnResult | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctChangeOrderToReturnResult | Результат создания заявки |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Общий статус запроса |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сообщение к статусу запроса |
| Свернуть таблицу | |||
changeOrdersToRedelivery( ) @return changeOrdersToRedeliveryResponse
Создать заявку на повторную доставку возвратных заказов
Параметры функции: changeOrdersToRedelivery [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| auth | nillable = false minoccurs = 1 maxoccurs = 1 |
ctAuth | Блок авторизации |
| — login | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Имя пользователя |
| — password | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Пароль |
| changeOrderToRedeliveryParams | nillable = false minoccurs = 1 maxoccurs = unbounded |
ctChangeOrderToRedeliveryParams | Параметры доставляемых заказов |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — accessCode | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Код доступа для создания заявки |
| — desireDateDelivery | nillable = true minoccurs = 0 maxoccurs = 1 |
ctDateTimeInterval | Желаемая дата доставки до получателя |
| — — date | nillable = false minoccurs = 1 maxoccurs = 1 |
date | Дата, содержащая число месяц год |
| — — timeInterval | nillable = false minoccurs = 1 maxoccurs = 1 |
ctTimeInterval | интервал доставки |
| — — — bTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время начала интервала |
| — — — eTime | nillable = false minoccurs = 1 maxoccurs = 1 |
time | Время окончания интервала |
| — clientInfo | nillable = true minoccurs = 0 maxoccurs = 1 |
ctClientInfo | Информация о получателе |
| — — fio | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Фамилия, имя, отчество. Одной строкой |
| — — phone | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Телефон. Формат номера 8xxxxxxxxxx (11 символов) |
| nillable = true minoccurs = 1 maxoccurs = 1 |
string | Адрес электронной почты (максимальное кол-во символов - 63) | |
| — — comment | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Комментарий клиента, указывается по необходимости (максимальное кол-во символов - 250) |
| — city | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Название города |
| — clientAddress | nillable = true minoccurs = 0 maxoccurs = 1 |
ctInCityAddress | Адрес получателя |
| — — zipcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Индекс |
| — — address | nillable = true minoccurs = 1 maxoccurs = 1 |
string | адрес внутри города |
| — — floor | nillable = true minoccurs = 0 maxoccurs = 1 |
string | этаж |
| — — elevator | nillable = true minoccurs = 0 maxoccurs = 1 |
ctElevator | Наличие лифта |
| — — — hasElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие лифта (1 - да, 0 - нет) |
| — — — hasFreightElevator | nillable = true minoccurs = 1 maxoccurs = 1 |
int | Наличие грузового лифта (1 - да, 0 - нет) |
| — partnerPickupCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код ПВЗ в системе Партнера |
| Свернуть таблицу | |||
Возвращаемое значение: changeOrdersToRedeliveryResponse [+]
| Имя | Свойства | Тип | Описание |
|---|---|---|---|
| requestResult | nillable = false minoccurs = 1 maxoccurs = 1 |
ctRequestResult | Результат запроса |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Статус запроса/операции |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Пояснительное сообщение к статусу |
| changeOrderToRedeliveryResult | nillable = true minoccurs = 0 maxoccurs = unbounded |
ctChangeOrderToRedeliveryResult | Результат создания заявки |
| — orderIdentity | nillable = false minoccurs = 1 maxoccurs = 1 |
ctOrderIdentity | Идентификатор заказа |
| — — orderId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | ИД в системе ТД |
| — — barcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Строковое представление штрихкода |
| — — webshopNumber | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Номер заказа в магазине |
| — status | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Общий статус запроса |
| — message | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Сообщение к статусу запроса |
| Свернуть таблицу | |||
