-
Notifications
You must be signed in to change notification settings - Fork 0
Integration API
rnikitin edited this page Dec 25, 2014
·
14 revisions
API находится в разработке, скорее всего это будет POST запрос на определенную точку входа. Данные должны отправляться в JSON формате в BODY запроса. Отсутствующие поля можно не отправлять или присылать null.
Автоматическую документацию по методам можно посмотреть тут: http://integration.api.beta.deliverator.ru/swagger
POST http://integration.api.beta.deliverator.ru/v1/tasks
x-token: eyJUb2tlbkd1aWQiOiJjODZhZjE4MC1hYmZjLTRjYjQtYThmMS1jZjM3NWIxNTE5NGQiLCJFeHBpcmF0aW9uIjoiMjAxNC0xMS0yNVQxNzo1OTozMy4yNjEyOTA3WiJ9
// API получает массив обьектов task
[{
// ID номер во внешней системе: например в 1C-Битрикс
inner_id: "string",
// вложенные заказы
child_tasks: [{/*subtask 1*/}, {/*subtask 2*/}],
// дополнительные параметры заказа
additional: [{ key1: 'value1'}, {key2: 'value2'}],
// массив продуктов в текущем заказе
products: [
{
/// внутренний product_id в системе-источнике импорта
inner_id : "string",
/// название
name: "string";
/// артикул товара
article: "string",
/// дополнительные заметки
note: "string",
/// единицы измерения
unit: "string",
/// количество
quantity: double,
/// цена
price: double,
/// обьем
volume: double,
/// вес
weight: double,
/// дополнительные параметры
additional: [{ key1: 'value1'}, {key2: 'value2'}]
}
],
/// тип операции - доставка или забор
/// Delivery = 0
/// Pickup = 1
operation : number,
/// номер заказа
number: "string",
/// дата и время нижней границы доставки
from: "2013-03-10T02:00:00Z",
/// дата и время верхней границы доставки
to: "2013-03-10T02:00:00Z",
/// предполагаемое время доставки
execution_date: "2013-03-10T02:00:00Z",
/// страна
country: "string",
/// область
region : "string",
/// район
district: "string",
/// город
town: "string",
/// район города
town_region: "string",
/// улица
street : "string",
/// станция метро
station : "string",
/// здание
building: "string",
/// строение
housing: "string",
/// подьезд
porch: "string",
/// этаж
floor: "string",
/// квартира
room: "string",
/// latitude
gps_lat: double,
/// longitude
gps_lng: double,
/// контрагент
contractor: {
// внутренний ID в экспортирующей системе
inner_id: "string",
// имя
name: "string",
/// тип контрагента - продавец или покупатель
/// Seller = 0
/// Buyer = 1
role: number,
// список контактов контрагента
contacts: [
// распознаваемые типы контактов:
// phone, email, website, zipcode, agent, fax, pager, icq, skype
{ phone: "+7499322223" },
{ email: "[email protected]" }
]
},
/// информация об оплате
pay_state: {
// дата оплаты
pay_date: "2013-03-10T02:00:00Z",
// тип оплаты. Типы бывают:
// Cash = 0
// CreditCard = 1
// WebMoney = 2
// YandexMoney = 3
// SavingsBank = 4
// BankTransfer = 5,
// CreditCardOnDelivery = 6,
// CreditContract = 7
pay_type: number,
}
/// тип доставки
delivery_reason: "string",
/// стоимость доставки
delivery_price: double,
/// расстояние доставки
delivery_distance: double,
/// дополнительные заметки
note: "string"
/// nickname курьера для автоматического назначения заказа
expected_courier: "string"
}]