Skip to content

Items API

Jump to bottom
atsanan edited this page Oct 18, 2018 · 37 revisions

7. Items

[x] 7.1 Get items in bag

GET /api/v1/itemPlayer/{playerId:string}?fields=itemCategoryId

Query parameters:

Field Description Optional Default
fields fields Yes itemCategoryId

Returns:

{
    "data": {
         "itemPlayer": [
            {
                "id": "5b486691aaea3c2c6c008587",
                "playerId": "5b2ca882bdfdd84f1fa5fe44",
                "itemId": "5b446d78aaea3c18e0354477",
                "count": 2,
                "isCoupon": false,
                "CouponGirfId": "",
                "couponHashKey": "test",
                "couponQRImage": "https://github.com/ahoo-studio/inmall-api/wiki/Items-API",
                "couponPassword": "1234",
                "createAt": "2018-07-13T08:45:05.468Z",
                "lastModified": "2018-07-13T08:45:05.468Z",
                "item": {
                    "id": "5b446d78aaea3c18e0354477",
                    "itemDetailChi1": "",
                    "itemDetailChi2": "itemDetailChi2",
                    "itemDetailEng": "itemDetailEng",
                    "itemDetailThai": "itemDetailThai",
                    "itemEffectChi1": "",
                    "itemEffectChi2": "itemEffectChi2",
                    "itemEffectEng": "itemEffectThai",
                    "itemEffectThai": "itemEffectThai",
                    "itemNameChi1": "",
                    "itemNameChi2": "itemNameChi2",
                    "itemNameEng": "itemNameEng",
                    "itemNameThai": "itemNameThai",
                    "coin": 1,
                    "diamond": 1,
                    "isActive": false,
                    "itemOrder": 5,
                    "itemAssetModel": "newItemAssetModel",
                    "itemAssetImageSlot": "newAssetImageSlot",
                    "itemAssetVersion": "1.0.1",
                    "itemCategoryId": "5b433c30aaea3c124c983cdb",
                    "itemCategory": {
                        "id": "5b433c30aaea3c124c983cdb",
                        "itemCategoryName": "new categoryItems",
                        "itemCategoryOrder": 10,
                        "createAt": "2018-07-09T10:42:56.579Z",
                        "lastModified": "2018-07-10T04:46:19.983Z"
                    },
                    "createAt": "2018-07-10T08:25:28.71Z",
                    "lastModified": "2018-07-10T08:25:28.71Z"
                }
            }
         ],
        "pageIndex": 0,
        "pageLimit": 10,
        "pages": 1,
        "paging": {
            "next": "",
            "previous": ""
        }
    },
    "isSuccess": true
}

[x] 7.2 Add item in bag

POST /api/v1/itemPlayer/add

Json Body parameters:

Field Description Optional
playerId PlayerId of a Playr No
itemId Id itemId of a item No
count count of itemPlayer No
couponGiftId couponGiftId yes
couponHasKey couponHasKey yes
couponQRImage couponQRImage yes
couponpassword couponQRImage yes

Returns:

{
    "data": {
        "id": "5b4ec0ac0837130998aced2c",
        "playerId": "5b2ca882bdfdd84f1fa5fe44",
        "itemId": "5b444820aaea3c175828cbac",
        "count": 5,
        "isCoupon": false,
        "CouponGirfId": "",
        "couponHashKey": "",
        "couponQRImage": "",
        "couponPassword": "",
        "createAt": "2018-07-18T04:23:08.761Z",
        "lastModified": "2018-07-18T04:23:08.761Z",
        "item": {
            "id": "5b444820aaea3c175828cbac",
            "itemDetailChi1": "",
            "itemDetailChi2": "itemDetailChi2",
            "itemDetailEng": "itemDetailEng",
            "itemDetailThai": "itemDetailThai",
            "itemEffectChi1": "",
            "itemEffectChi2": "itemEffectChi2",
            "itemEffectEng": "itemEffectThai",
            "itemEffectThai": "itemEffectThai",
            "itemNameChi1": "",
            "itemNameChi2": "itemNameChi2",
            "itemNameEng": "itemNameEng",
            "itemNameThai": "itemNameThai",
            "coin": 800,
            "diamond": 100,
            "isActive": false,
            "itemOrder": 5,
            "itemAssetModel": "test",
            "itemAssetImageSlot": "test",
            "itemAssetVersion": "01",
            "itemCategoryId": "5b433c30aaea3c124c983cdb",
            "itemCategory": {
                "id": "5b433c30aaea3c124c983cdb",
                "itemCategoryName": "new categoryItems",
                "itemCategoryOrder": 10,
                "createAt": "2018-07-09T10:42:56.579Z",
                "lastModified": "2018-07-10T04:46:19.983Z"
            },
            "createAt": "2018-07-10T05:46:08.17Z",
            "lastModified": "2018-07-10T08:06:59.097Z"
        }
    },
    "isSuccess": true
}

[X] 7.3 Get default item

GET /api/v1/itemDefault?fields=itemCategoryId&sort=itemOrder:1

Query parameters:

Field Description Optional Default
fields fields Yes itemCategoryId
sort fields for sort Yes itemOrder

Returns:

{
    "data": {
        "items": [
            {
                "_id": "5bb774c068efd87103266965",
                "coin": 10,
                "created_at": "2018-10-08T08:50:09Z",
                "diamond": 10,
                "isActive": true,
                "itemAssertImageSlot": "itemAssertImageSlot",
                "itemAssertModel": "itemAssertModel",
                "itemAssertVersion": 1,
                "itemCategoryId": "5bbd8f4d6a10e0dca422f0b4",
                "itemDetail": {
                    "chi1": "itemDetail",
                    "chi2": "itemDetail",
                    "eng": "itemDetail",
                    "thai": "itemDetail"
                },
                "itemName": {
                    "chi1": "itemName",
                    "chi2": "itemName",
                    "eng": "itemName",
                    "thai": "itemName"
                },
                "itemOrder": 1,
                "updated_at": "2018-10-10T09:00:01Z"
            },
            {
                "_id": "5bbb1a4152de4b1004000b74",
                "created_at": "2018-10-08T08:50:09Z",
                "itemName": {
                    "chi1": "ttt",
                    "chi2": "ttt",
                    "eng": "tttsss",
                    "thai": "ttt"
                },
                "updated_at": "2018-10-08T09:00:01Z"
            }
        ],
        "pageIndex": 0,
        "pageLimit": 10,
        "pages": 1,
        "paging": {
            "next": "",
            "previous": ""
        }
    },
    "isSuccess": true
}

[x] 7.5 Add default item (backend)

POST /api/v1/itemDefault/add

JSON body:

Field Description Optional
itemNameEng Name English of a item No
itemNameThai Name Thai of a item No
itemNameChi1 Name Chinese of a item No
itemNameChi2 Name Chinese 2 of a item No
itemDetailEng Detail English of a item Yes
itemDetailThai Detail Thai of a item Yes
itemDetailChi1 Detail Chinese of a item Yes
itemDetailChi2 Detail Chinese 2 of a item Yes
itemEffectEng Effect English of this item Yes
itemEffectThai Effect Thai of this item Yes
itemEffectChi1 Effect Chinese of this item Yes
itemEffectChi2 Effect Chinese 2 of this item Yes
coin Coins that player get No
diamond Diamonds that player get No
isActive Can interact or not Yes
itemOrder Orfer of this item Yes
itemAssetModel Path of this item's model asset No
itemAssetImageSlot Path of Image slot asset No
itemAssetVersion Version of this item asset No
itemCategoryId Id of this item category No

Returns:

{
    "data": {
        "_id": "5b4ec94a0837131e576af931",
        "coin": 500,
        "createAt": "2018-07-18T04:59:54.324Z",
        "diamond": 1,
        "isActive": false,
        "itemAssetImageSlot": "1",
        "itemAssetModel": "1",
        "itemAssetVersion": "as",
        "itemCategory": {
            "_id": "5b433691aaea3c2550326abb",
            "createAt": "2018-07-09T10:18:57.043Z",
            "itemCategoryName": "kaewTest",
            "itemCategoryOrder": 1,
            "lastModified": "2018-07-09T10:18:57.043Z"
        },
        "itemCategoryId": "5b433691aaea3c2550326abb",
        "itemDetail": "",
        "itemEffect": "",
        "itemName": "atest",
        "itemOrder": 0
    },
    "isSuccess": true
}

7.6 Update default item (backend)

POST /api/v1/itemDefault/{id: string}

JSON Body:

Field Description Optional
itemId ID of this item No
itemNameEng Name English of a item No
itemNameThai Name Thai of a item No
itemNameChi1 Name Chinese of a item No
itemNameChi2 Name Chinese 2 of a item No
itemDetailEng Detail English of a item Yes
itemDetailThai Detail Thai of a item Yes
itemDetailChi1 Detail Chinese of a item Yes
itemDetailChi2 Detail Chinese 2 of a item Yes
itemEffectEng Effect English of this item Yes
itemEffectThai Effect Thai of this item Yes
itemEffectChi1 Effect Chinese of this item Yes
itemEffectChi2 Effect Chinese 2 of this item Yes
coin Price of this item in coins No
diamond Price of this item in diamonds No
isActive Can interact or not Yes
itemOrder Order of this item Yes
itemAssetModel Path of this item model asset No
itemAssetImageSlot Path of Image slot asset No
itemAssetVersion Version of this item asset No
itemCategoryId Id of this item category No

Returns:

{
    "data": {
        "id": "5b446e87aaea3c36240d2ab1",
        "itemDetailChi1": "",
        "itemDetailChi2": "itemDetailChi2",
        "itemDetailEng": "itemDetailEng",
        "itemDetailThai": "itemDetailThai",
        "itemEffectChi1": "",
        "itemEffectChi2": "itemEffectChi2",
        "itemEffectEng": "itemEffectThai",
        "itemEffectThai": "itemEffectThai",
        "itemNameChi1": "",
        "itemNameChi2": "itemNameChi2",
        "itemNameEng": "itemNameEng",
        "itemNameThai": "itemNameThai",
        "coin": 2,
        "diamond": 2,
        "isActive": true,
        "itemOrder": 2,
        "itemAssetModel": "ItemAssetModel",
        "itemAssetImageSlot": "AssetImageSlot",
        "itemAssetVersion": "1.0.1",
        "itemCategoryId": "5b443ce1aaea3c3bd0bb710a",
        "createAt": "2018-07-10T08:29:59.319Z",
        "lastModified": "2018-07-10T08:27:18.305Z"
    },
    "isSuccess": true
}

[x] 7.7 Add category item (backend)

POST /api/v1/categoryItem/add

JSON Body:

Field Description Optional Auth
itemCategoryName Name of this item category No admin
itemCategoryOrder Order of this item category Yes admin

Returns:

{
    "data": {
        "id": "5b433c30aaea3c124c983cdb",
        "itemCategoryName": "new categoryItems",
        "itemCategoryOrder": 1,
        "createAt": "2018-07-09T10:42:56.579Z",
        "lastModified": "2018-07-09T10:39:21.686Z"
    },
    "isSuccess": true
}

[x] 7.8 Update category item (backend)

POST /api/v1/categoryItem/update/{id: string}

JSON Body:

Field Description Optional Auth
itemCategoryName Name of this item category No admin
itemCategoryOrder Order of this item category Yes admin

Returns:

{
    "data": {
        "id": "5b433c30aaea3c124c983cdb",
        "itemCategoryName": "new categoryItems",
        "itemCategoryOrder": 10,
        "createAt": "2018-07-09T10:42:56.579Z",
        "lastModified": "2018-07-09T10:48:13.326Z"
    },
    "isSuccess": true
}

Clone this wiki locally