August 29, 2019

Документация API FYG

В каждом запросе должен быть установлен заголовок 'token', имеющийся у каждого филиала. Получить его можно у администратора системы FYG.

Получить все марки автомобилей

GET

/api/v1/marks

Параметры запроса отсутствуют.

Ответ:

result: 'success',
values: [
    {
        id: 1,
        name: 'Audi'
    },
    ...
]

Получить все модели автомобилей

GET

/api/v1/models

Параметры запроса отсутствуют.

Ответ:

result: 'success',
values: [
    {
        id: 1,
        name: 'Q7',
        mark: {
            id: 1,
            name: 'Audi'
        }
    },
    ...
]

Получить все автомобили

GET

/api/v1/cars

Параметры запроса отсутствуют.

Ответ:

result: 'success',
values: [
    {
        id: 1,
        name: '2016 3.0 5D',
        car_model: {
            id: 1,
            name: 'Q7',
            mark: {
                id: 1,
                name: 'Audi'
            }
        }
    },
    ...
]

Получить все стекла

GET

/api/v1/glasses

Параметры запроса отсутствуют.

Ответ:

result: 'success',
values: [
    {
        id: 1,
        name: 'Лобовое стекло с датчиком дождя для Audi Q7',
        eurocode: '8634AGAMVZ',
        years_of_issue: '2017 - 2019',
        comment: 'Дополнительный комментарий',
        note: 'Примечание',
        size: '176x82',
        weight: 3.2,
        thickness: 8,
        manufacturer_code: 'Y74KFU77',
        manufacturer: {
            id: 1,
            name: 'Fuyao Group'
        },
        vendor_code: '144829',
        position_id: 0,
        cars: [
            {
                car_id: 1,
                name: '2016 3.0 5D'
            },
            ...
        ]
    },
    ...
]

Получить заказы за период

GET

/api/v1/orders

Параметры запроса:

start_date: yyyy-mm-dd hh:mm,
end_date: yyyy-mm-dd hh:mm

Ответ:

result: 'success',
values: [
    {
        id: 1,
        number: 'КГД-1',
        sum: 3600,
        type: 0,  // 0 - user -> branch, 1 - branch -> branch
        status: 0,
        created_at: '2019-08-29 09:49:56',  // Дата создания
        paid_at: null,  // Дата оплаты
        released_at: null,  // Дата отгрузки
        closed_at: null,  // Дата закрытия
        declined_at: null,  // Дата отмены
        customer: {  // Если покупатель - пользователь, иначе null
            id: 1,
            name: 'username',
            phone: '+79001234567',
            email: '[email protected]',
            first_name: 'Иван',
            last_name: 'Иванов'
        },
        customer_branch: {  // Если покупатель - филиал, иначе null
            id: 1,
            name: 'ООО Организация',
            inn: '391234567'
        },
        items: [
            {
                order_id: 1,
                glass_id: 1,
                count: 1,
                price: 3600
            },
            ...
        ]
    },
    ...
]

Обновить статус заказа

POST

/api/v1/orders/updateOrderStatus

Параметры запроса:

order_id: 1,  // ID заказа
paid_at: yyyy-mm-dd hh:mm
// либо
released_at: yyyy-mm-dd hh:mm
// либо
closed_at: yyyy-mm-dd hh:mm
// либо
declined_at: yyyy-mm-dd hh:mm

Ответ:

result: 'success'

Обновление количества/цен номенклатуры

POST

/api/v1/glasses/updatePrices

Параметры запроса:

items: [
    {
        vendor_code: '123850',  // Артикул
        retail_price: 3100,
        wholesale_price: 2800,
        count: 3
    },
    ...
]

Ответ:

result: 'success',
errors: [
    'Отсутствует стекло с артикулом 65464',
    ...
]