Mirror's Photo API

# Товары

# Создание

Создание нового товара

  • URL

    POST /good/add

  • Параметры

    Название Описание Обязательный
    name Название +
    description Описание
    bar_code Штриф-код

  • Ответ

    {
  "status": "OK",
  "response": {
    "id": "5",
    "name": "Тестовый товар",
    "description": "Тестовое описание",
    "bar_code": "1234567890123",
    "datetime_сreate": "2018-05-04 14:21:56.562805"
  }
}

# Добавление в наличие

При получении товара - нужно добавить его в наличие

  • URL

    POST /good/receipt

  • Параметры

    Название Описание Обязательный
    bar_code Штриф-код +
    price Цена по которой получили +

  • Ответ

    {
  "status": "OK",
  "response": "good.receipt.success"
}

# Поиск

Поиск товаров по названию

  • URL

    GET /good/search

  • Параметры

    Название Описание Обязательный
    query Поисковый запрос +

  • Ответ

    {
  "status": "OK",
  "response": [
     {
       "id": 5,
       "name": "Тестовый товар",
       "description": "Тестовое описание",
       "bar_code": "1234567890123",
       "datetime_сreate": "2018-05-04 14:20:22.540514"
     },
     {
       "id": 8,
       "name": "Тестовый товар 2",
       "description": "Тестовое описание",
       "bar_code": "1234567890123",
       "datetime_сreate": "2018-05-04 14:20:22.540514"
    }
  ]
}

# Информация

Получение модели товара с ценой и количеством в наличии

# По id

  • URL

    GET /good/{id}

  • Параметры

    Название Описание Обязательный
    id Идентификатор товара +

  • Ответ

    {
  "status": "OK",
  "response": {
    "id": 8,
    "name": "Тестовый товар 2",
    "description": "Тестовое описание",
    "bar_code": "1234567890123",
    "datetime_сreate": "2018-05-04 14:20:22.540514",
    "price": 100,
    "available": 2
  }
}

# По штриф-коду

  • URL

    GET /good/bar-code/{bar_code}

  • Параметры

    Название Описание Обязательный
    bar_code Штриф-код +

  • Ответ

    {
  "status": "OK",
  "response": {
    "id": 8,
    "name": "Тестовый товар 2",
    "description": "Тестовое описание",
    "bar_code": "1234567890123",
    "datetime_сreate": "2018-05-04 14:20:22.540514",
    "price": 100,
    "available": 2
  }
}

← Ксерокопия →