Документація по API з описом доступна у вашому кабінеті SalesDrive:
Приклад на PHP:
Усі поля, окрім "form", - НЕ обов'язкові.
POST https://yourdomain.salesdrive.me/handler/ Content-Type: application/json { "form": "", "getResultData": "", "fName": "", "lName": "", "mName": "", "phone": "", "email": "", "company": "", "products": [ { "id": "", "name": "", "costPerItem": "", "amount": "", "description": "", "discount": "", "sku": "" } ], "payment_method": "", "shipping_method": "", "shipping_address": "", "comment": "", "sajt": "", "externalId": "", "organizationId": "", "stockId": "", "novaposhta": { "ServiceType": "", "payer": "", "area": "", "region": "", "city": "", "cityNameFormat": "", "WarehouseNumber": "", "Street": "", "BuildingNumber": "", "Flat": "" }, "ukrposhta": { "ServiceType": "", "payer": "", "type": "", "city": "", "WarehouseNumber": "", "Street": "", "BuildingNumber": "", "Flat": "" }, "prodex24source_full": "", "prodex24source": "", "prodex24medium": "", "prodex24campaign": "", "prodex24content": "", "prodex24term": "", "prodex24page": "" }
Повний список усіх параметрів і можливих значень - у вашому кабінеті SalesDrive.
Загальні дані | |
---|---|
form | API-ключ |
getResultData | Отримувати дані створеної заявки (0 - не отримувати, 1 - отримувати) |
Дані контакту | |
fName | Ім'я |
lName | Прізвище |
mName | По батькові |
phone | Телефон |
company | Компанія |
Масив товарів | |
products[i][id] | id товару |
products[i][name] | назва товару |
products[i][costPerItem] | ціна |
products[i][amount] | кількість |
products[i][description] | опис товарної позиції в заявці |
products[i][discount] | знижка, задається в % або в абсолютній величині |
products[i][sku] | артикул (SKU) товару |
Дані заявки | |
payment_method | Спосіб оплати |
shipping_method | Спосіб доставки |
shipping_address | Адреса доставки |
comment | Коментар |
sajt | Сайт |
externalId | Зовнішній номер заявки |
organizationId | id організації |
shipping_costs | Витрати на доставку |
stockId | id складу |
Дані Нової Пошти | |
novaposhta[ServiceType] | можливі значення: Warehouse, Doors |
novaposhta[payer] | можливі значення: "sender", "recipient" |
novaposhta[area] | область російською або українською мовою, або Ref області в системі Нової пошти |
novaposhta[region] | район російською або українською мовою (використовується тільки якщо cityNameFormat=settlement) |
novaposhta[city] | назва міста російською або українською мовою, або Ref міста в системі Нової пошти |
novaposhta[cityNameFormat] |
можливі значення: full (за замовчуванням), short, settlement (населений пункт із нової адресної системи: ref або назва) |
novaposhta[WarehouseNumber] | відділення Нової Пошти в одному з форматів: номер, опис, Ref |
novaposhta[Street] | назва і тип вулиці, або Ref вулиці в системі Нової пошти |
novaposhta[BuildingNumber] | номер будинку |
novaposhta[Flat] | номер квартири |
Дані Укрпошти | |
ukrposhta[ServiceType] | можливі значення: DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors |
ukrposhta[payer] | можливі значення: "sender", "recipient" |
ukrposhta[type] | можливі значення: express, standard |
ukrposhta[city] | місто російською або українською мовою, або CITY_ID Укрпошти |
ukrposhta[WarehouseNumber] | номер відділення Укрпошти |
ukrposhta[Street] | STREET_ID Укрпошти |
ukrposhta[BuildingNumber] | номер будинку |
ukrposhta[Flat] | номер квартири |
Дані про рекламне джерело | |
prodex24source_full | повний урл джерела переходу |
prodex24source | utm_source |
prodex24medium | utm_medium |
prodex24campaign | utm_campaign |
prodex24content | utm_content |
prodex24term | utm_term |
prodex24page | сторінка сайту, з якої прийшла заявка онлайн |