Шлюз API
Параметры
Имя - webshopSoapGate v2.1
WSDL - https://is-test.topdelivery.ru/api/soap/w/2.1/?WSDL
Максимальное количество запросов в секунду - 4
Описание
Методы API
addOrders( $parameters 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 = false 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 | Ссылка на страницу товара в ИМ |
| — 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 | адрес внутри города |
| — — 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 | Название пункта самовывоза |
| — 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 | Стоимости для клиента |
| — 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 | Тип упаковки (из справочника) |
| — 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 | Имя товара |
| — — 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 | Код товарной номенклатуры. Используется для передачи кода "Честный знак" |
| — — itemCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код товарной позиции в системе клиента |
| — — itemBarcode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | ШК товарной позиции |
| — supplierSummary | nillable = true minoccurs = 1 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 | Номер телефона |
| Свернуть таблицу | |||
Возвращаемое значение: 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 | Номер заказа в магазине |
| Свернуть таблицу | |||
addShipment( $parameters 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( $parameters 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( $parameters 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( $parameters 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( $parameters 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 | Название пункта самовывоза |
| — — 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 |
| — — 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( $parameters 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 | Список индексов, привязанных к городу |
| Свернуть таблицу | |||
getOrdersInfo( $parameters 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 | Имя товара |
| — — — 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 | Код товарной номенклатуры. Используется для передачи кода "Честный знак" |
| — — — itemCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код товарной позиции в системе клиента |
| — — — itemBarcode | 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 | Название пункта самовывоза |
| — — 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 | Тип упаковки (из справочника) |
| — — 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 | адрес внутри города |
| — — — 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 | Название пункта самовывоза |
| — — deliveryVat | nillable = true minoccurs = 1 maxoccurs = 1 |
int | НДС доставки |
| — — dateReceiveInTD | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата получения в ТопДеливери |
| — — supplierSummary | nillable = true minoccurs = 1 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 | Номер телефона |
| Свернуть таблицу | |||
calcOrderCosts( $parameters 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 | адрес внутри города |
| — — 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 | Название пункта самовывоза |
| — departCityId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | город отправки |
| Свернуть таблицу | |||
Возвращаемое значение: 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 | Стоимость страховки |
| — wayInfo | nillable = true minoccurs = 1 maxoccurs = 1 |
ctWayInfo | Информация о магистрали |
| — — departCityId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Id города отправки |
| — — departCityName | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Название города отправки |
| — — departRegionId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Id региона отправки |
| — — departRegionName | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Id региона оптправки |
| — — wayDays | nillable = false minoccurs = 1 maxoccurs = 1 |
int | дней магистрали |
| — — monday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в понедельник. 1 - да, 0 - нет |
| — — tuesday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка во вторник |
| — — wednesday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в среду |
| — — thursday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в четверг |
| — — friday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в пятницу |
| — — saturday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в субботу |
| — — sunday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в воскресенье |
| Свернуть таблицу | |||
getNearDeliveryDatesIntervals( $parameters 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 | адрес внутри города |
| — — 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 | Название пункта самовывоза |
| — departCityId | nillable = true minoccurs = 1 maxoccurs = 1 |
int | id города отгрузки - для получения информации о магистрали |
| Свернуть таблицу | |||
Возвращаемое значение: 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 | Время окончания интервала |
| wayInfo | nillable = true minoccurs = 1 maxoccurs = 1 |
ctWayInfo | Информация о магистрали |
| — departCityId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Id города отправки |
| — departCityName | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Название города отправки |
| — departRegionId | nillable = false minoccurs = 1 maxoccurs = 1 |
int | Id региона отправки |
| — departRegionName | nillable = false minoccurs = 1 maxoccurs = 1 |
string | Id региона оптправки |
| — wayDays | nillable = false minoccurs = 1 maxoccurs = 1 |
int | дней магистрали |
| — monday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в понедельник. 1 - да, 0 - нет |
| — tuesday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка во вторник |
| — wednesday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в среду |
| — thursday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в четверг |
| — friday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в пятницу |
| — saturday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в субботу |
| — sunday | nillable = false minoccurs = 1 maxoccurs = 1 |
int | доставка в воскресенье |
| Свернуть таблицу | |||
deleteOrder( $parameters 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( $parameters 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 | Название пункта самовывоза |
| 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 |
| 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 | Название пункта самовывоза |
| — 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 |
| — 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( $parameters 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 | Название пункта самовывоза |
| 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 | Имя товара |
| — — 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 | Код товарной номенклатуры. Используется для передачи кода "Честный знак" |
| — — itemCode | nillable = true minoccurs = 1 maxoccurs = 1 |
string | Код товарной позиции в системе клиента |
| — — itemBarcode | 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 | Название пункта самовывоза |
| — 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 | Тип упаковки (из справочника) |
| — 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 | адрес внутри города |
| — — 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 | Название пункта самовывоза |
| — deliveryVat | nillable = true minoccurs = 1 maxoccurs = 1 |
int | НДС доставки |
| — dateReceiveInTD | nillable = true minoccurs = 1 maxoccurs = 1 |
date | Дата получения в ТопДеливери |
| — supplierSummary | nillable = true minoccurs = 1 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 | Номер телефона |
| Свернуть таблицу | |||
getReports( $parameters 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( $parameters 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 | Параметры для поиска |
| — 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 | Название пункта самовывоза |
| Свернуть таблицу | |||
Возвращаемое значение: 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 | Название пункта самовывоза |
| — 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 | Наименование ПВЗ |
| — 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 | Контакты |
| Свернуть таблицу | |||