Maxmollcrm

Microcrm для торговли

Оглавление

• Оглавление
• Установка и настройка
• REST API
  • Список складов
  • Список товаров с их остатками по складам
  • Список заказов (с фильтрами и настраиваемой пагинацией)
  • Создание заказа (в заказе может быть несколько позиций с разным количеством)
  • Обновление заказа (данные покупателя и список позиций, но не статус)
  • Завершение заказ
  • Отмена заказа
  • Возобновление заказа
  • История изменений остатков товаров

Установка и настройка

Клонируем образ:

git clone https://github.com/fe11fire/maxmollcrm.git .

Устанавливаем зависимости:

docker-compose run --rm composer install

Запускаем окружение:

docker-compose up nginx --build -d

Добавляем тестовые данные:

docker-compose run --rm artisan migrate:fresh --seed

REST API

Список складов

GET {{host}}/warehouses

Список товаров с их остатками по складам

GET {{host}}/stocks

Список заказов (с фильтрами и настраиваемой пагинацией)

GET {{host}}/orders

Создание заказа (в заказе может быть несколько позиций с разным количеством)

POST {{host}}/order

{
    "customer": string,
    "items" : array of objects {"id": int, "count": int},
    "warehouse_id": int | null
}

Обновление заказа (данные покупателя и список позиций, но не статус)

PUT {{host}}/order

{
    "id": int,
    "customer": string | null,
    "items" : array of objects {"id": int, "count": int} | null,
}

Завершение заказ

PUT {{host}}/order/complete

{
    "id": int
}

        OR

GET {{host}}/order/{{id}}/cancel

Отмена заказа

PUT {{host}}/order/cancel

{
    "id": int
}

        OR

GET {{host}}/order/{{id}}/cancel

Возобновление заказа

PUT {{host}}/order/resume

{
    "id": int
}

        OR

GET {{host}}/order/{{id}}/resume

История изменений остатков товаров

GET {{host}}/stocks/history

{
    "product_id": int | null,
    "warehouse_id": int | null,
    "period_start": string:format(Y-m-d,Y-m-d H:i:s,Y-m,Y) | null,
    "period_end": string:format(Y-m-d,Y-m-d H:i:s,Y-m,Y) | null
}

Примеры команд представлены в каталоге requests