Transaction Action of GS2-Inventory

ConsumeAction

Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId

Verify current max inventory capacity by user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
inventoryName	string	Inventory Model Name
verifyType	enum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’]	Type of verification
currentInventoryMaxCapacity	int	Maximum capacity

{
    "action": "Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "inventoryName": "[string]Inventory Model Name",
        "verifyType": "[string]Type of verification",
        "currentInventoryMaxCapacity": "[int]Maximum capacity"
    }
}

action: Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  inventoryName: "[string]Inventory Model Name"
  verifyType: "[string]Type of verification"
  currentInventoryMaxCapacity: "[int]Maximum capacity"

Gs2Inventory:ConsumeItemSetByUserId

Consume inventory items by user ID

Actions for which quantity can be specified: YES

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Inventory Model Name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
itemName	string	Item Model Name
consumeCount	long	Amount to consume
itemSetName	string	Name identifying the item set

{
    "action": "Gs2Inventory:ConsumeItemSetByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Inventory Model Name",
        "userId": "[string]User Id",
        "itemName": "[string]Item Model Name",
        "consumeCount": "[long]Amount to consume",
        "itemSetName": "[string]Name identifying the item set"
    }
}

action: Gs2Inventory:ConsumeItemSetByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Inventory Model Name"
  userId: "[string]User Id"
  itemName: "[string]Item Model Name"
  consumeCount: "[long]Amount to consume"
  itemSetName: "[string]Name identifying the item set"

Gs2Inventory:VerifyItemSetByUserId

Verify possession quantity by user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
inventoryName	string	Inventory Model Name
itemName	string	Item Model Name
verifyType	enum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’]	Type of verification
itemSetName	string	Name identifying the item set
count	long	Quantity in possession

{
    "action": "Gs2Inventory:VerifyItemSetByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "inventoryName": "[string]Inventory Model Name",
        "itemName": "[string]Item Model Name",
        "verifyType": "[string]Type of verification",
        "itemSetName": "[string]Name identifying the item set",
        "count": "[long]Quantity in possession"
    }
}

action: Gs2Inventory:VerifyItemSetByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  inventoryName: "[string]Inventory Model Name"
  itemName: "[string]Item Model Name"
  verifyType: "[string]Type of verification"
  itemSetName: "[string]Name identifying the item set"
  count: "[long]Quantity in possession"

Gs2Inventory:VerifyReferenceOfByUserId

Verification regarding the reference source by specifying the user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Inventory Model Name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
itemName	string	Item Model Name
itemSetName	string	Name identifying the item set
referenceOf	string	References for this possession
verifyType	enum [’not_entry’, ‘already_entry’, ’empty’, ’not_empty’]	Type of verification

{
    "action": "Gs2Inventory:VerifyReferenceOfByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Inventory Model Name",
        "userId": "[string]User Id",
        "itemName": "[string]Item Model Name",
        "itemSetName": "[string]Name identifying the item set",
        "referenceOf": "[string]References for this possession",
        "verifyType": "[string]Type of verification"
    }
}

action: Gs2Inventory:VerifyReferenceOfByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Inventory Model Name"
  userId: "[string]User Id"
  itemName: "[string]Item Model Name"
  itemSetName: "[string]Name identifying the item set"
  referenceOf: "[string]References for this possession"
  verifyType: "[string]Type of verification"

Gs2Inventory:ConsumeSimpleItemsByUserId

Consume inventory items by user ID

Actions for which quantity can be specified: NO

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Simple Inventory Model Name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
consumeCounts	ConsumeCount[]	List of quantity of items to be consumed

{
    "action": "Gs2Inventory:ConsumeSimpleItemsByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Simple Inventory Model Name",
        "userId": "[string]User Id",
        "consumeCounts": [
            {
                "itemName": "[string]Simple Item Model Name",
                "count": "[long]Quantity to be consumed"
            }
        ]
    }
}

action: Gs2Inventory:ConsumeSimpleItemsByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Simple Inventory Model Name"
  userId: "[string]User Id"
  consumeCounts: 
  - itemName: "[string]Simple Item Model Name"
    count: "[long]Quantity to be consumed"

Gs2Inventory:VerifySimpleItemByUserId

Verify possession quantity by user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
inventoryName	string	Simple Inventory Model Name
itemName	string	Simple Item Model Name
verifyType	enum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’]	Type of verification
count	long	Quantity in possession

{
    "action": "Gs2Inventory:VerifySimpleItemByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "inventoryName": "[string]Simple Inventory Model Name",
        "itemName": "[string]Simple Item Model Name",
        "verifyType": "[string]Type of verification",
        "count": "[long]Quantity in possession"
    }
}

action: Gs2Inventory:VerifySimpleItemByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  inventoryName: "[string]Simple Inventory Model Name"
  itemName: "[string]Simple Item Model Name"
  verifyType: "[string]Type of verification"
  count: "[long]Quantity in possession"

Gs2Inventory:ConsumeBigItemByUserId

Consume inventory items by user ID

Actions for which quantity can be specified: YES

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Big Inventory Model Name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
itemName	string	Big Item Model Name
consumeCount	string	Quantity of items to be consumed

{
    "action": "Gs2Inventory:ConsumeBigItemByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Big Inventory Model Name",
        "userId": "[string]User Id",
        "itemName": "[string]Big Item Model Name",
        "consumeCount": "[string]Quantity of items to be consumed"
    }
}

action: Gs2Inventory:ConsumeBigItemByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Big Inventory Model Name"
  userId: "[string]User Id"
  itemName: "[string]Big Item Model Name"
  consumeCount: "[string]Quantity of items to be consumed"

Gs2Inventory:VerifyBigItemByUserId

Verify possession quantity by user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
inventoryName	string	Big Inventory Model Name
itemName	string	Big Item Model Name
verifyType	enum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’]	Type of verification
count	string	Quantity in possession

{
    "action": "Gs2Inventory:VerifyBigItemByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "inventoryName": "[string]Big Inventory Model Name",
        "itemName": "[string]Big Item Model Name",
        "verifyType": "[string]Type of verification",
        "count": "[string]Quantity in possession"
    }
}

action: Gs2Inventory:VerifyBigItemByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  inventoryName: "[string]Big Inventory Model Name"
  itemName: "[string]Big Item Model Name"
  verifyType: "[string]Type of verification"
  count: "[string]Quantity in possession"

AcquireAction

Gs2Inventory:AddCapacityByUserId

Add capacity size

Actions for which quantity can be specified: YES

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Inventory Model Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
addCapacityValue	int	Capacity size to be added

{
    "action": "Gs2Inventory:AddCapacityByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Inventory Model Name",
        "userId": "[string]User Id",
        "addCapacityValue": "[int]Capacity size to be added"
    }
}

action: Gs2Inventory:AddCapacityByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Inventory Model Name"
  userId: "[string]User Id"
  addCapacityValue: "[int]Capacity size to be added"

Gs2Inventory:SetCapacityByUserId

Set capacity size

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Inventory Model Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
newCapacityValue	int	New maximum capacity for inventory

{
    "action": "Gs2Inventory:SetCapacityByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Inventory Model Name",
        "userId": "[string]User Id",
        "newCapacityValue": "[int]New maximum capacity for inventory"
    }
}

action: Gs2Inventory:SetCapacityByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Inventory Model Name"
  userId: "[string]User Id"
  newCapacityValue: "[int]New maximum capacity for inventory"

Gs2Inventory:AcquireItemSetByUserId

Add items to inventory

Actions for which quantity can be specified: YES

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Inventory Model Name
itemName	string	Item Model Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
acquireCount	long	Quantity to be obtained
expiresAt	long	Effective date
createNewItemSet	bool	Even if there is room in an existing ItemSet, you can create a new ItemSet
itemSetName	string	Name identifying the item set

{
    "action": "Gs2Inventory:AcquireItemSetByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Inventory Model Name",
        "itemName": "[string]Item Model Name",
        "userId": "[string]User Id",
        "acquireCount": "[long]Quantity to be obtained",
        "expiresAt": "[long]Effective date",
        "createNewItemSet": "[bool]Even if there is room in an existing ItemSet, you can create a new ItemSet",
        "itemSetName": "[string]Name identifying the item set"
    }
}

action: Gs2Inventory:AcquireItemSetByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Inventory Model Name"
  itemName: "[string]Item Model Name"
  userId: "[string]User Id"
  acquireCount: "[long]Quantity to be obtained"
  expiresAt: "[long]Effective date"
  createNewItemSet: "[bool]Even if there is room in an existing ItemSet, you can create a new ItemSet"
  itemSetName: "[string]Name identifying the item set"

Gs2Inventory:AddReferenceOfByUserId

Add a reference by specifying a user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Inventory Model Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
itemName	string	Item Model Name
itemSetName	string	Name identifying the item set
referenceOf	string	References for this possession

{
    "action": "Gs2Inventory:AddReferenceOfByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Inventory Model Name",
        "userId": "[string]User Id",
        "itemName": "[string]Item Model Name",
        "itemSetName": "[string]Name identifying the item set",
        "referenceOf": "[string]References for this possession"
    }
}

action: Gs2Inventory:AddReferenceOfByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Inventory Model Name"
  userId: "[string]User Id"
  itemName: "[string]Item Model Name"
  itemSetName: "[string]Name identifying the item set"
  referenceOf: "[string]References for this possession"

Gs2Inventory:DeleteReferenceOfByUserId

Delete references by specifying user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Inventory Model Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
itemName	string	Item Model Name
itemSetName	string	Name identifying the item set
referenceOf	string	References for this possession

{
    "action": "Gs2Inventory:DeleteReferenceOfByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Inventory Model Name",
        "userId": "[string]User Id",
        "itemName": "[string]Item Model Name",
        "itemSetName": "[string]Name identifying the item set",
        "referenceOf": "[string]References for this possession"
    }
}

action: Gs2Inventory:DeleteReferenceOfByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Inventory Model Name"
  userId: "[string]User Id"
  itemName: "[string]Item Model Name"
  itemSetName: "[string]Name identifying the item set"
  referenceOf: "[string]References for this possession"

Gs2Inventory:AcquireSimpleItemsByUserId

Add items to inventory

Actions for which quantity can be specified: NO

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Simple Inventory Model Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
acquireCounts	AcquireCount[]	List of quantity of items to be obtained

{
    "action": "Gs2Inventory:AcquireSimpleItemsByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Simple Inventory Model Name",
        "userId": "[string]User Id",
        "acquireCounts": [
            {
                "itemName": "[string]Simple Item Model Name",
                "count": "[long]Quantity to be obtained"
            }
        ]
    }
}

action: Gs2Inventory:AcquireSimpleItemsByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Simple Inventory Model Name"
  userId: "[string]User Id"
  acquireCounts: 
    - itemName: "[string]Simple Item Model Name"
      count: "[long]Quantity to be obtained"

Gs2Inventory:AcquireBigItemByUserId

Add items to inventory

Actions for which quantity can be specified: YES

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Big Inventory Model Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
itemName	string	Big Item Model Name
acquireCount	string	Quantity of items to be obtained

{
    "action": "Gs2Inventory:AcquireBigItemByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Big Inventory Model Name",
        "userId": "[string]User Id",
        "itemName": "[string]Big Item Model Name",
        "acquireCount": "[string]Quantity of items to be obtained"
    }
}

action: Gs2Inventory:AcquireBigItemByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Big Inventory Model Name"
  userId: "[string]User Id"
  itemName: "[string]Big Item Model Name"
  acquireCount: "[string]Quantity of items to be obtained"