Spark API

Appearance

Список компаний для создания FTL заказа ​

Метод запроса: GET

bash
https://gateway.spark-dev.team/cabinet/api/client/v2/ftl-order/companies

Описание параметров запроса:

Наименование параметраТипОбязательный параметр
pageNumberНет
limitNumberНет
isExtendedNumberНет
statusIdNumberНет

Пример запроса для получения первой страницы компаний и ограничением в 20 элементов:

bash
https://gateway.spark-dev.team/cabinet/api/client/v2/ftl-order/companies?page=1&limit=20
Пример ответа
json
{
    "data": {
        "id": 1,
        "name": "АҚ КітапАвто",
        "is_subdivision": 1,
        "bin": "210653561550",
        "bik": "CASPKZKA",
        "type": "Юридическое Лицо",
        "contact_phone": "+7 (707) 2081721",
        "contact_name": "Жігерқызы Іңкәр",
        "jur_address": "095514, Көкшетау облысы, Талдықорған қаласы, Абай көшесі, 456",
        "fact_address": "096990, Маңғыстау облысы, Ақтау қаласы, Достық даңғылы, 409",
        "isChl": true,
        "bank": "Қазкоммерцбанк",
        "bank_account": "KZ48263XRX7ZK03NVLI3",
        "kbe": 17,
        "country": "КАЗАХСТАН",
        "status": "Создан",
        "status_id": 1,
        "type_id": 1,
        "country_id": 1,
        "code_1c": "00000012345",
        "contract_signed": 1,
        "contract_id": 1,
        "contract_number": "SL-000001",
        "created_at": "2021-12-08 15:36:28",
        "updated_at": "2021-12-08 15:36:28",
        "short_name": "КітапАвто",
        "manager": {
            "id": 1,
            "name": "Анисимова Валерия Романовна",
            "email": "amisin@bk.ru",
            "phone": "+1582534766260"
        },
        "accountant": {
            "id": 1,
            "name": "Анисимова Валерия Романовна",
            "email": "amisin@bk.ru",
            "phone": "+1582534766260"
        },
        "billing_period": {
            "id": 1,
            "title": "Выставление счетов каждую неделю"
        },
        "billing_payment_stage": {
            "id": 1,
            "name": "Оплата после доставки"
        },
        "billing_weight_type": {
            "id": 1,
            "name": "Оплата после доставки"
        },
        "vehicleOwner": {
            "id": 1,
            "name": "Название Компании",
            "bin": "БИН123",
            "typeId": 1,
            "companyId": 1,
            "contactName": "Вася Васильев",
            "address": "Толе би 101",
            "phoneNumber": "77087778899",
            "contactEmail": "spark@spark.kz",
            "carModel": "BMW",
            "carNumber": "777SPK01",
            "description": "Шасси/кухов",
            "carColor": "зеленый",
            "techPassport": "ТехПасспорт123",
            "releaseDate": "2023-10-23"
        },
        "verify": 0,
        "billing_enabled": true,
        "mass_approve_enabled": true,
        "business_model_id": 0,
        "business_model_name": "string",
        "nds_number": "string",
        "nds_series": "string",
        "nds_register_date": "2021-12-08",
        "client_signer_email": "spark@spark.kz",
        "client_approving_email": "spark@spark.kz",
        "shipment_tariff_id": 1,
        "initiator_email": "spark@spark.kz",
        "company_source_id": 1,
        "company_source_name": "Spark.kz",
        "priority": 1,
        "latest_ltl_order_date": "21.06.24",
        "latest_ftl_order_date": "21.06.24",
        "contractServices": [
            "LTL"
        ]
    },
    "code": 0,
    "success": true,
    "message": "",
    "errors": []
}