Applications - Создание / Изменение нескольких заявок
POST запрос на создание нескольких заявок. Для этого вам нужны как минимум api ключ, клиент и сами заявки.
post/api/v2/applicationscurl -X POST \
/api/v2/applications \
-H 'content-type: application/json' \
-d '{
"api_key": "xxxxxxxxxxxxxx",
"options": {
"multi": true
},
"data": [{
"client": {
"phone": "7702xxxxxxx",
"allPhones": ["7702xxxxxx1","7702xxxxxx2"],
"name": "clientName",
"email": "email@example.com",
"description": "Some description"
},
"application": {
"externalId": 1234,
"additionalDetails": "some details",
"details": "other details",
"price": 0,
"planDeliveryPeriod": {
"startDate": 1492590418399,
"endDate": 1492590418399
},
"addressFrom":{
"address": "Алматы, улица Карасай батыра, 95А",
"coords": {
"lat": 43.25054092138005,
"long": 76.92709409497071
},
"details": "Some details"
},
"addressTo":{
"address": "Алматы, улица Курмангазы, 72",
"coords": {
"lat": 43.244015656536305,
"long": 76.94014035961915
},
"details": "Some details 2"
},
"appType": "default",
"volume": 14,
"weight": 20
},
"goods": [
{
"name": "smth",
"code": "some code",
"volume": 10,
"quantity": 10,
"price": 1000,
"weight": 1
},
{
"name": "smth2",
"code": "some code2",
"volume": 11,
"quantity": 11,
"price": 1001,
"weight": 1
}
]
}]
}'Header
| Название | Тип | Описание |
|---|---|---|
| x-response-type необязательный | String |
Формат вывода ответа (по умолчанию: application/json). Допустимые значения:
|
Тело запроса, основные данные
| Название | Тип | Описание |
|---|---|---|
| api_key | String |
Уникальный api ключ. |
| data | Object[] |
Список заявок к созданию |
| options | Object |
Дополнительные параметры, по значениям которых будет выполняться создание нескольких заявок |
Описание объекта в списке data
| Название | Тип | Описание |
|---|---|---|
| client | Object |
Информация о клиенте. Здесь содержится вся необходимая информация о клиете. |
| application | Object |
Информация о заявке. Здесь содержится вся необходимая информация о заявке. |
| goods необязательный | Object[] |
Информация о товарах. Здесь будут товары относящиеся к заявке. |
| options необязательный | Object |
Дополнительная информация о заявке. |
Параметры клиента (client)
| Название | Тип | Описание |
|---|---|---|
| name | String |
Имя клиента. |
| phone необязательный | String |
Телефон клиента ( В международном формате). |
| allPhones необязательный | Array |
Дополнительные телефоны клиента ( В международном формате). |
| email необязательный | String |
Email клиента. |
| description необязательный | String |
Описание клиента. |
Параметры заявки (application)
| Название | Тип | Описание |
|---|---|---|
| additionalDetails необязательный | String |
Детали заказа. |
| details необязательный | String |
Сведения заказа. |
| externalId необязательный | String |
Уникальный внешний id заявки (при указании externalId, попробует обновить существующую заявку, указанными полями). |
| price необязательный | Number |
Цена заказа (считается отдельно от цены за товары). |
| priceType необязательный | String |
Уникальный id типа оплаты (по дефолту берется основной тип). |
| planDeliveryPeriod | Object |
Период времени когда нужно доставить. |
| addressFrom | Object |
Адрес отправления, адрес откуда нужно взять заказ (При указании appType != default, можно указать null). |
| addressTo | Object |
Адрес доставки, адрес куда нужно доставить заказ. |
| appType | String |
Тип заказа, какой тип будет у заказа: "pickUp" - Забор, "delivery" - доставка, "default" - Забор и Доставка. Допустимые значения:
|
| volume необязательный | Number |
Объем заказа (кг). |
| weight необязательный | Number |
Вес заказа (м.куб). |
| requireTransportSkill необязательный | String |
Категория заказа. |
| waitTime необязательный | Number |
Время отгрузки (в минутах). |
| loadTime необязательный | Number |
Время загрузки (в минутах). |
| deliveryPrice необязательный | Number |
Цена за доставку (если вам нужно указать свою цену за доставку). |
| sender необязательный | Object |
Отправитель (если у вас включен "отправитель", то он обязателен). |
| _id необязательный | String |
Уникальный id заявки (при указании id, обновит существующую заявку, указанными полями). |
| customId необязательный | String |
Внешний номер заявки. |
| status необязательный | String |
Меняет статус заявки из активного в новый. Допустимые значения:
|
Параметры времени доставки (planDeliveryPeriod)
| Название | Тип | Описание |
|---|---|---|
| startDate | Number |
Начальное время доставки, в миллисекундах (POSIX time). |
| endDate | Number |
Конечное время доставки, в миллисекундах (POSIX time). |
Параметры адреса отправления (addressFrom)
| Название | Тип | Описание |
|---|---|---|
| address | String |
Адрес: (Город, улица, дом). |
| coords необязательный | Object |
Координаты адреса. |
| details необязательный | String |
Детали адреса. |
Параметры адреса доставки (addressTo)
| Название | Тип | Описание |
|---|---|---|
| address | String |
Адрес клиента: (Город, улица, дом). |
| coords необязательный | Object |
Координаты адреса. |
| details необязательный | String |
Детали адреса. |
Параметры координат (coords)
| Название | Тип | Описание |
|---|---|---|
| lat | Number |
Широта адреса. |
| long | Number |
Долгота адреса. |
Параметры Товара (goods)
| Название | Тип | Описание |
|---|---|---|
| name | String |
Название товара. |
| code | String |
Код товара. |
| weight | Number |
Вес за 1 товар (кг). |
| volume | Number |
Объем за 1 товар (м.куб). |
| quantity | Number |
Количество товара. |
| price | Number |
Цена за 1 товар. |
| caseCoefficient | Number |
Коэффициент кейса за 1 товар. |
Параметры Отправителя (sender)
| Название | Тип | Описание |
|---|---|---|
| fullName необязательный | String |
Имя отправителя. |
| phone необязательный | String |
Телефон отправителя. |
Параметры Настроек (options)
| Название | Тип | Описание |
|---|---|---|
| changeGoods | String |
При обновлении заявки, действие происходимое с товарами (replace - заменяет товары указанными в запросе, add - добавляет товары к существующим товарам, nothing - ничего не делает с существующими товарами заявки). Допустимые значения:
|
Success 200
| Название | Тип | Описание |
|---|---|---|
| status | String |
Статус ответа. |
| _id | String |
Уникальный id заявки. |
HTTP/1.1 200 Success
{
"status": "success",
"_id": "xxxxxxxxxxx"
}