API_V1.md · OSCHINA-MIRROR/iim-JXCunOS

Документация API для управления складом, продажами и закупками OS V1

Заголовок

key	value
Content-Type	application/json

1. Получение подтипов товаров по ID родительского типа (свитеры, куртки)

1. method: `GET`

2. action: `goods/listTypeSonByFatherId`

3. параметры:

param	Обязательный	Описание
typeFatherId	Да	1 - верхняя одежда, 2 - брюки

4. Пример:

URL: http://localhost:8082/jxcos/goods/listTypeSonByFatherId?typeFatherId=2
Ответ:

{
    "status": 0,
    "msg": "Успешно",
    "data": {
        "list": [
            {
                "typeId": 4,
                "typeFatherId": 2,
                "typeName": "Брюки-бананы",
                "typeDescription": "",
                "typeRemark": null
            },
            {
                "typeId": 5,
                "typeFatherId": 2,
                "typeName": "Юбка-мини",
                "typeDescription": "",
                "typeRemark": null
            }
        ]
    }
}

2. Получение всех цветов товаров

1. method: `GET`

2. action: `goods/listAllColor`

3. параметры: отсутствуют

4. Пример:

URL: http://localhost:8082/jxcos/goods/listAllColor
Ответ:

{
    "status": 0,
    "msg": "Успешно",
    "data": {
        "list": [
            {
                "colorId": 1,
                "colorName": "Разноцветный",
                "colorDescription": null,
                "colorRemark": null
            },
            {
                "colorId": 2,
                "colorName": "Черный",
                "colorDescription": null,
                "colorRemark": null
            }
        ]
    }
}

3. Получение размеров товаров по ID родительского типа

1. method: `GET`

2. action: `goods/listSizeByTypeFatherId`

3. параметры:|param |Обязательный |Описание |

|------------- |----- |------- | |typeFatherId |Да |1 - верхняя одежда, 2 - брюки |

4. Пример:

URL: http://localhost:8082/jxcos/goods/listSizeByTypeFatherId?typeFatherId=1
Ответ:

{
    "status": 0,
    "msg": "Успешно",
    "data": {
        "list": [
            {
                "sizeId": 1,
                "typeFatherId": 1,
                "sizeName": "F",
                "sizeDescription": "Общая размерная сетка",
                "sizeRemark": null
            }
        ]
    }
}

4. Получение всех материалов для товаров

1. method: `GET`

2. action: `goods/listAllMaterial`

3. параметры: отсутствуют

4. пример:

URL: http://localhost:8082/jxcos/goods/listAllMaterial
Ответ:

{
    "status": 0,
    "msg": "Успешно",
    "data": {
        "list": [
            {
                "materialId": 1,
                "materialName": "хлопок",
                "materialDescription": null,
                "materialRemark": null
            },
            {
                "materialId": 2,
                "materialName": "шелк",
                "materialDescription": null,
                "materialRemark": null
            }
        ]
    }
}

5. Ввод на склад

1. method: `POST`

2. action: `goods/addGoods2Store`

3. параметры:|param |Обязательный |Описание |

|---------------|-----|----------| |name |Да |Название товара | |goodsNumber |Да |Артикул (формат: 181128001) | |typeFather |Да |ID большого типа (1 верхняя одежда, 2 брюки) | |type |Да |ID малого типа | |color |Да |ID цвета | |size |Да |ID размера | |material |Да |ID материала | |gender |Да |ID типа пола (1 универсальный, 2 мужской, 3 женский) | |priceBuying |Да |Цена закупки, в центах | |priceGuidance |Нет |Рекомендованная цена, в центах | |description |Нет |Описание | |fromBusiness |Нет |Источник закупки | |remark |Нет |Примечание | |inNumber |Да |Количество единиц на складе |#### 4. Пример:

URL: http://localhost:8082/jxcos/goods/addGoods2Store
параметры:

{
    "name": "Тестовые данные",
    "goodsNumber": "181128002",
    "typeFather": 1,
    "type": 2,
    "color": 2,
    "size": 1,
    "material": 2,
    "gender": 1,
    "priceBuying": 3000,
    "priceGuidance": 6000,
    "description": "",
    "fromBusiness": "Много и много",
    "remark": "XXX",
    "inNumber": 10
}

ответ:

{
    "status": 0,
    "msg": "Успешно",
    "data": {
        "inId": 1,
        "id": 5
    }
}

6. Получение списка товаров на складе

1. method: `POST`

2. action: `goods/listStoreBySelect`

3. параметры|параметр |Обязательный |Описание |

|---------------|------------|---------------| |goodsNumber |N |Артикул товара (формат: 181128001), для фильтрации всего склада: не указывать (или указать null), не указывайте пустую строку, иначе ничего не будет найдено | |colorId |N |ID цвета, для фильтрации всего склада: не указывать (или указать 0) | |sizeId |N |ID размера, для фильтрации всего склада: не указывать (или указать 0) | |startIndex |N |Начальный индекс данных (для пагинации, по умолчанию 0 при отсутствии указания) | |pageSize |N |Количество элементов на странице (для пагинации, по умолчанию 20 при отсутствии указания) |

4. Пример:

URL: http://localhost:8082/jxcos/goods/listStoreBySelect
параметры

{
  "goodsNumber": "181130002",
  "colorId": 2,
  "sizeId": 1,
  "startIndex": 0,
  "pageSize": 4
}

ответ``` { "status": 0, "msg": "Успешно", "data": { "list": [ { "colorName": "Черный", "priceBuying": 3000, "color": 2, "goodsId": 6, "typeName": "Базовая рубашка", "priceGuidance": 6000, "type": 2, "size": 1, "sizeName": "F", "createTime": "2018/11/30 10:27:28", "goodsNumber": "181130002", "lastModifyTime": "2018/12/03 14:05:59", "countLeft": 9, "goodsName": "Тестовые данные 2" } ] } }


### 7. Выдача товара
#### 1. метод: `POST`
#### 2. действие: `goods/outGoodsFormStore`
#### 3. параметры:

|параметр    |Обязательный|Описание|
|------------|-----|----------|
|goodsId     |Да   |ID товара|
|outNumber   |Да   |Количество выдачи|
|priceOut    |Да   |Фактическая цена|
|payStatus   |Да   |Статус оплаты (1 - ожидание оплаты, 2 - оплачено)|
|outRemark   |Нет  |Примечание|

#### 4. Пример:
+ URL: `http://localhost:8082/jxcos/goods/outGoodsFormStore`
+ параметры

{ "goodsId": 5, "outNumber": 2, "priceOut": 7000, "payStatus": 1, "outRemark": "" }


+ ответ

{ "status": 0, "msg": "Успешно", "data": { "goodsId": 5, "outId": 5 } }


---

### 8. Поиск товара по goodsId
#### 1. метод: `GET`
#### 2. действие: `goods/findGoodsById`
#### 3. параметры:

|параметр    |Обязательный|Описание|
|------------|-----|----------|
|goodsId     |Да   |ID товара|

#### 4. Пример:
+ URL: `http://localhost:8082/jxcos/goods/findGoodsById?goodsId=6`
+ ответ

{ "status": 0, "msg": "Успех", "data": { "colorName": "Черный", "priceBuying": 3000, "color": 2, "gender": 1, "goodsId": 6, "typeName": "Базовая рубашка", "description": "", "remark": "XXX", "priceGuidance": 6000, "type": 2, "genderName": "Нейтральный", "typeFather": 1, "materialName": "Шелк", "fromBusiness": "Много и много", "size": 1, "material": 2, "sizeName": "F", "createTime": "2018/11/30 10:27:28", "goodsNumber": "181130002", "lastModifyTime": "2018/11/30 10:27:28", "countLeft": 10, "typeFatherName": "Верхняя одежда", "goodsName": "Тестовые данные 2" } }


---

### 9. Получение выданных записей с помощью фильтрации
#### 1. метод: `POST`
#### 2. действие: `goods/listAllOutRecordBySelect`
#### 3. параметры:|параметр       |Обязательный   |Описание        |
|---------------|--------------|---------------|
|payStatus      |Y             |Статус оплаты (0 — все, 1 — ожидание оплаты, 2 — оплачено)  |

#### 4. пример:
+ URL: `http://localhost:8082/jxcos/goods/listAllOutRecordBySelect`
+ параметры:

{ "payStatus": 1 }


+ ответ:

{ "status": 0, "msg": "Успешно", "data": { "list": [ { "colorName": "Черный", "goodsId": 5, "typeName": "Базовая рубашка", "outNumber": 1, "sizeName": "F", "outRemark": "", "lastModifyTime": "2018/12/03 11:00:22", "goodsNumber": "181128002", "name": "Тестовые данные", "outId": 15, "priceOut": 7000, "payStatus": 1, "payName": "Ожидание оплаты", "outTime": "2018/12/03 11:00:22" }, { "colorName": "Черный", "goodsId": 5, "typeName": "Базовая рубашка", "outNumber": 1, "sizeName": "F", "outRemark": "", "lastModifyTime": "2018/12/03 10:48:39", "goodsNumber": "181128002", "name": "Тестовые данные", "outId": 14, "priceOut": 7000, "payStatus": 1, "payName": "Ожидание оплаты", "outTime": "2018/12/03 10:48:39" } ] } }


---

### 10. Обновление статуса оплаты
#### 1. method: `POST`
#### 2. action: `goods/updatePayStatusByOutId`
#### 3. параметры:|параметр       |Обязательный   |Описание        |
|---------------|--------------|---------------|
|outId          |Y             |ID выданной записи  |
|payStatus      |Y             |Статус оплаты (1 — ожидание оплаты, 2 — оплачено)  |
|outRemark      |N             |Заметка к выдаче (в базе данных используется перезапись, если ранее были заметки, то фронтенд должен передать их вместе с новыми заметками склеенными)  |#### 4. пример:
+ URL: `http://localhost:8082/jxcos/goods/updatePayStatusByOutId`
+ параметры:```
{
    "outId": 15,
    "payStatus": 2,
    "outRemark": "Ван Дацзянь 14 августа только вернул деньги!!"
}

resp：

{
    "status": 0,
    "msg": "Успешно",
    "data": null
}

0. Добавление общей категории

1. method: `POST`

2. action: `type/addTypeFather`

3. параметры:

param	Обязательный	Описание
typeFatherName	Да	Название общей категории
typeFatherDescription	Нет	Описание категории
typeFatherRemark	Нет	Примечание

4. пример:

URL: http://localhost:8082/jxcos/type/addTypeFather
параметры:

{
    "typeFatherName": "телевизор",
    "typeFatherDescription": "общая категория для телевизоров, подкатегории могут включать: телевизоры Xiaomi, Philips, Hisense и т.д.",
    "typeFatherRemark": ""
}

resp:

{
    "status": 0,
    "msg": "Успешно",
    "data": {
        "typeFatherId": 10,
        "typeFatherName": "телевизор",
        "typeFatherDescription": "общая категория для телевизоров, подкатегории могут включать: телевизоры Xiaomi, Philips, Hisense и т.д.",
        "typeFatherRemark": ""
    }
}

OSCHINA-MIRROR/iim-JXCunOS .gitee-modal { min-width: 500px !important; } .gitee-modal .close { right: 0.6rem !important; }

Документация API для управления складом, продажами и закупками OS V1

Заголовок

1. Получение подтипов товаров по ID родительского типа (свитеры, куртки)

1. method: GET

2. action: goods/listTypeSonByFatherId

3. параметры:

4. Пример:

2. Получение всех цветов товаров

1. method: GET

2. action: goods/listAllColor

3. параметры: отсутствуют

4. Пример:

3. Получение размеров товаров по ID родительского типа

1. method: GET

2. action: goods/listSizeByTypeFatherId

3. параметры:|param |Обязательный |Описание |

4. Пример:

4. Получение всех материалов для товаров

1. method: GET

2. action: goods/listAllMaterial

3. параметры: отсутствуют

4. пример:

5. Ввод на склад

1. method: POST

2. action: goods/addGoods2Store

3. параметры:|param |Обязательный |Описание |

6. Получение списка товаров на складе

1. method: POST

2. action: goods/listStoreBySelect

3. параметры|параметр |Обязательный |Описание |

4. Пример:

0. Добавление общей категории

1. method: POST

2. action: type/addTypeFather

3. параметры:

4. пример:

Опубликовать ( 0 )

Введение

Обновления

Участники

Язык

Недавние действия

OSCHINA-MIRROR/iim-JXCunOS

1. method: `GET`

2. action: `goods/listTypeSonByFatherId`

1. method: `GET`

2. action: `goods/listAllColor`

1. method: `GET`

2. action: `goods/listSizeByTypeFatherId`

1. method: `GET`

2. action: `goods/listAllMaterial`

1. method: `POST`

2. action: `goods/addGoods2Store`

1. method: `POST`

2. action: `goods/listStoreBySelect`

1. method: `POST`

2. action: `type/addTypeFather`