Transaction Action of GS2-Inventory

ConsumeAction

Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId

Verify current max inventory capacity by user ID

Actions for which quantity can be specified: YES

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstring
Set #{userId} to replace the currently logged in user ID.
inventoryNamestringInventory Model Name
verifyTypeenum [
“less”,
“lessEqual”,
“greater”,
“greaterEqual”,
“equal”,
“notEqual”
]
Type of verification
currentInventoryMaxCapacityintMaximum capacity
multiplyValueSpecifyingQuantityboolWhether to multiply the value used for verification when specifying the quantity
timeOffsetTokenstringTime offset token
{
    "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",
        "multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
        "timeOffsetToken": "[string]Time offset token"
    }
}
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"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").consume.verify_inventory_current_max_capacity_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    inventoryName="[string]Inventory Model Name",
    verifyType="[string]Type of verification",
    currentInventoryMaxCapacity="[int]Maximum capacity",
    multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:ConsumeItemSetByUserId

Consume inventory items by user ID

Actions for which quantity can be specified: YES

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringInventory Model Name
userIdstring
Set #{userId} to replace the currently logged in user ID.
itemNamestringItem Model Name
consumeCountlongAmount to consume
itemSetNamestringName identifying the item set
timeOffsetTokenstringTime offset token
{
    "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",
        "timeOffsetToken": "[string]Time offset token"
    }
}
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"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").consume.consume_item_set_by_user_id({
    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",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:VerifyItemSetByUserId

Verify possession quantity by user ID

Actions for which quantity can be specified: YES

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstring
Set #{userId} to replace the currently logged in user ID.
inventoryNamestringInventory Model Name
itemNamestringItem Model Name
verifyTypeenum [
“less”,
“lessEqual”,
“greater”,
“greaterEqual”,
“equal”,
“notEqual”
]
Type of verification
itemSetNamestringName identifying the item set
countlongQuantity in possession
multiplyValueSpecifyingQuantityboolWhether to multiply the value used for verification when specifying the quantity
timeOffsetTokenstringTime offset token
{
    "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",
        "multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
        "timeOffsetToken": "[string]Time offset token"
    }
}
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"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").consume.verify_item_set_by_user_id({
    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",
    multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:VerifyReferenceOfByUserId

Verification regarding the reference source by specifying the user ID

Actions for which quantity can be specified: YES

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringInventory Model Name
userIdstring
Set #{userId} to replace the currently logged in user ID.
itemNamestringItem Model Name
itemSetNamestringName identifying the item set
referenceOfstringReferences for this possession
verifyTypeenum [
“not_entry”,
“already_entry”,
“empty”,
“not_empty”
]
Type of verification
timeOffsetTokenstringTime offset token
{
    "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",
        "timeOffsetToken": "[string]Time offset token"
    }
}
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"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").consume.verify_reference_of_by_user_id({
    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",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:ConsumeSimpleItemsByUserId

Consume simple items in simple inventory by user ID

Actions for which quantity can be specified: NO

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringSimple Inventory Model Name
userIdstring
Set #{userId} to replace the currently logged in user ID.
consumeCountsConsumeCount[]List of quantity of simple items to be consumed
timeOffsetTokenstringTime offset token
{
    "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"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}
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"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").consume.consume_simple_items_by_user_id({
    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"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:VerifySimpleItemByUserId

Verify the quantity possessed in simple inventory by specifying the user ID

Actions for which quantity can be specified: YES

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstring
Set #{userId} to replace the currently logged in user ID.
inventoryNamestringSimple Inventory Model Name
itemNamestringSimple Item Model Name
verifyTypeenum [
“less”,
“lessEqual”,
“greater”,
“greaterEqual”,
“equal”,
“notEqual”
]
Type of verification
countlongQuantity in possession
multiplyValueSpecifyingQuantityboolWhether to multiply the value used for verification when specifying the quantity
timeOffsetTokenstringTime offset token
{
    "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",
        "multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
        "timeOffsetToken": "[string]Time offset token"
    }
}
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"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").consume.verify_simple_item_by_user_id({
    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",
    multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:ConsumeBigItemByUserId

Consume big items in big inventory by user ID

Actions for which quantity can be specified: YES

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringBig Inventory Model Name
userIdstring
Set #{userId} to replace the currently logged in user ID.
itemNamestringBig Item Model Name
consumeCountstringQuantity of big items to be consumed
timeOffsetTokenstringTime offset token
{
    "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 big items to be consumed",
        "timeOffsetToken": "[string]Time offset token"
    }
}
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 big items to be consumed"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").consume.consume_big_item_by_user_id({
    namespaceName="[string]Namespace name",
    inventoryName="[string]Big Inventory Model Name",
    userId="[string]User Id",
    itemName="[string]Big Item Model Name",
    consumeCount="[string]Quantity of big items to be consumed",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:VerifyBigItemByUserId

Verify possession quantity of big items by user ID

Actions for which quantity can be specified: YES

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstring
Set #{userId} to replace the currently logged in user ID.
inventoryNamestringBig Inventory Model Name
itemNamestringBig Item Model Name
verifyTypeenum [
“less”,
“lessEqual”,
“greater”,
“greaterEqual”,
“equal”,
“notEqual”
]
Type of verification
countstringQuantity in possession
multiplyValueSpecifyingQuantityboolWhether to multiply the value used for verification when specifying the quantity
timeOffsetTokenstringTime offset token
{
    "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",
        "multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
        "timeOffsetToken": "[string]Time offset token"
    }
}
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"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").consume.verify_big_item_by_user_id({
    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",
    multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2Inventory:AddCapacityByUserId

Add capacity size

Actions for which quantity can be specified: YES

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringInventory Model Name
userIdstringSet #{userId} to replace the currently logged in user ID.
addCapacityValueintCapacity size to be added
timeOffsetTokenstringTime offset token
{
    "action": "Gs2Inventory:AddCapacityByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Inventory Model Name",
        "userId": "[string]User Id",
        "addCapacityValue": "[int]Capacity size to be added",
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Inventory:AddCapacityByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Inventory Model Name"
  userId: "[string]User Id"
  addCapacityValue: "[int]Capacity size to be added"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").acquire.add_capacity_by_user_id({
    namespaceName="[string]Namespace name",
    inventoryName="[string]Inventory Model Name",
    userId="[string]User Id",
    addCapacityValue="[int]Capacity size to be added",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:SetCapacityByUserId

Set capacity size

Actions for which quantity can be specified: YES

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringInventory Model Name
userIdstringSet #{userId} to replace the currently logged in user ID.
newCapacityValueintNew maximum capacity for inventory
timeOffsetTokenstringTime offset token
{
    "action": "Gs2Inventory:SetCapacityByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Inventory Model Name",
        "userId": "[string]User Id",
        "newCapacityValue": "[int]New maximum capacity for inventory",
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Inventory:SetCapacityByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Inventory Model Name"
  userId: "[string]User Id"
  newCapacityValue: "[int]New maximum capacity for inventory"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").acquire.set_capacity_by_user_id({
    namespaceName="[string]Namespace name",
    inventoryName="[string]Inventory Model Name",
    userId="[string]User Id",
    newCapacityValue="[int]New maximum capacity for inventory",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:AcquireItemSetByUserId

Add items to inventory

Actions for which quantity can be specified: YES

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringInventory Model Name
itemNamestringItem Model Name
userIdstringSet #{userId} to replace the currently logged in user ID.
acquireCountlongQuantity to be obtained
expiresAtlongEffective date
createNewItemSetboolEven if there is room in an existing ItemSet, you can create a new ItemSet
itemSetNamestringName identifying the item set
timeOffsetTokenstringTime offset token
{
    "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",
        "timeOffsetToken": "[string]Time offset token"
    }
}
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"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").acquire.acquire_item_set_by_user_id({
    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",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:AcquireItemSetWithGradeByUserId

Add items to inventory while setting the grade to GS2-Grade

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringInventory Model Name
itemNamestringItem Model Name
userIdstringSet #{userId} to replace the currently logged in user ID.
gradeModelIdstringGrade Model GRN
gradeValuelongGrade value to set
timeOffsetTokenstringTime offset token
{
    "action": "Gs2Inventory:AcquireItemSetWithGradeByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Inventory Model Name",
        "itemName": "[string]Item Model Name",
        "userId": "[string]User Id",
        "gradeModelId": "[string]Grade Model GRN",
        "gradeValue": "[long]Grade value to set",
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Inventory:AcquireItemSetWithGradeByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Inventory Model Name"
  itemName: "[string]Item Model Name"
  userId: "[string]User Id"
  gradeModelId: "[string]Grade Model GRN"
  gradeValue: "[long]Grade value to set"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").acquire.acquire_item_set_with_grade_by_user_id({
    namespaceName="[string]Namespace name",
    inventoryName="[string]Inventory Model Name",
    itemName="[string]Item Model Name",
    userId="[string]User Id",
    gradeModelId="[string]Grade Model GRN",
    gradeValue="[long]Grade value to set",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:AddReferenceOfByUserId

Add a reference by specifying a user ID

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringInventory Model Name
userIdstringSet #{userId} to replace the currently logged in user ID.
itemNamestringItem Model Name
itemSetNamestringName identifying the item set
referenceOfstringReferences for this possession
timeOffsetTokenstringTime offset token
{
    "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",
        "timeOffsetToken": "[string]Time offset token"
    }
}
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"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").acquire.add_reference_of_by_user_id({
    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",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:DeleteReferenceOfByUserId

Delete references by specifying user ID

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringInventory Model Name
userIdstringSet #{userId} to replace the currently logged in user ID.
itemNamestringItem Model Name
itemSetNamestringName identifying the item set
referenceOfstringReferences for this possession
timeOffsetTokenstringTime offset token
{
    "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",
        "timeOffsetToken": "[string]Time offset token"
    }
}
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"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").acquire.delete_reference_of_by_user_id({
    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",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:AcquireSimpleItemsByUserId

Add simple items to simple inventory

Actions for which quantity can be specified: NO

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringSimple Inventory Model Name
userIdstringSet #{userId} to replace the currently logged in user ID.
acquireCountsAcquireCount[]List of quantity of simple items to be obtained
timeOffsetTokenstringTime offset token
{
    "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"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}
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"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").acquire.acquire_simple_items_by_user_id({
    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"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:SetSimpleItemsByUserId

Set any value for the quantity of simple items held in simple inventory

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringSimple Inventory Model Name
userIdstringSet #{userId} to replace the currently logged in user ID.
countsHeldCount[]List of quantity of simple items to be obtained
timeOffsetTokenstringTime offset token
{
    "action": "Gs2Inventory:SetSimpleItemsByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Simple Inventory Model Name",
        "userId": "[string]User Id",
        "counts": [
            {
                "itemName": "[string]Simple Item Model Name",
                "count": "[long]Number of items held"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Inventory:SetSimpleItemsByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Simple Inventory Model Name"
  userId: "[string]User Id"
  counts: 
    - itemName: "[string]Simple Item Model Name"
      count: "[long]Number of items held"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").acquire.set_simple_items_by_user_id({
    namespaceName="[string]Namespace name",
    inventoryName="[string]Simple Inventory Model Name",
    userId="[string]User Id",
    counts={
        {
            itemName="[string]Simple Item Model Name",
            count="[long]Number of items held"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:AcquireBigItemByUserId

Add big items to big inventory

Actions for which quantity can be specified: YES

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringBig Inventory Model Name
userIdstringSet #{userId} to replace the currently logged in user ID.
itemNamestringBig Item Model Name
acquireCountstringQuantity of big items to be obtained
timeOffsetTokenstringTime offset token
{
    "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 big items to be obtained",
        "timeOffsetToken": "[string]Time offset token"
    }
}
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 big items to be obtained"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").acquire.acquire_big_item_by_user_id({
    namespaceName="[string]Namespace name",
    inventoryName="[string]Big Inventory Model Name",
    userId="[string]User Id",
    itemName="[string]Big Item Model Name",
    acquireCount="[string]Quantity of big items to be obtained",
    timeOffsetToken="[string]Time offset token",
})

Gs2Inventory:SetBigItemByUserId

Set arbitrary values to big items in big inventory

Actions for which quantity can be specified: YES

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
inventoryNamestringBig Inventory Model Name
userIdstringSet #{userId} to replace the currently logged in user ID.
itemNamestringBig Item Model Name
countstringQuantity of big items to be set
timeOffsetTokenstringTime offset token
{
    "action": "Gs2Inventory:SetBigItemByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "inventoryName": "[string]Big Inventory Model Name",
        "userId": "[string]User Id",
        "itemName": "[string]Big Item Model Name",
        "count": "[string]Quantity of big items to be set",
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Inventory:SetBigItemByUserId
request:
  namespaceName: "[string]Namespace name"
  inventoryName: "[string]Big Inventory Model Name"
  userId: "[string]User Id"
  itemName: "[string]Big Item Model Name"
  count: "[string]Quantity of big items to be set"
  timeOffsetToken: "[string]Time offset token"
transaction.service("inventory").acquire.set_big_item_by_user_id({
    namespaceName="[string]Namespace name",
    inventoryName="[string]Big Inventory Model Name",
    userId="[string]User Id",
    itemName="[string]Big Item Model Name",
    count="[string]Quantity of big items to be set",
    timeOffsetToken="[string]Time offset token",
})