Transaction Action of GS2-Inventory
VerifyAction
Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId
Verify current max inventory capacity by specifying a user ID
Whether the action allows quantity specification: YES
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||||||||||||||||
| inventoryName | string | ✓ | ~ 128 chars | Inventory Model Name | ||||||||||||||||
| verifyType | String Enum enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } | ✓ | Type of verification
| |||||||||||||||||
| currentInventoryMaxCapacity | int | ✓ | 0 ~ 2147483646 | Current max inventory capacity | ||||||||||||||||
| multiplyValueSpecifyingQuantity | bool | ✓ | true | Whether to multiply the value used for verification when specifying the quantity | ||||||||||||||||
| timeOffsetToken | string | ~ 1024 chars | 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]Current max inventory 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]Current max inventory capacity"
multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
timeOffsetToken: "[string]Time offset token"transaction.service("inventory").verify.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]Current max inventory capacity",
multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
timeOffsetToken="[string]Time offset token",
})Gs2Inventory:VerifyItemSetByUserId
Verify the quantity of Item Sets in possession by specifying the user ID
Whether the action allows quantity specification: YES
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||||||||||||||||
| inventoryName | string | ✓ | ~ 128 chars | Inventory Model Name Inventory model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| itemName | string | ✓ | ~ 128 chars | Item Model Name | ||||||||||||||||
| verifyType | String Enum enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } | ✓ | Type of verification
| |||||||||||||||||
| itemSetName | string | ~ 36 chars | Name identifying the item set | |||||||||||||||||
| count | long | ✓ | 0 ~ 9223372036854775805 | Quantity in possession | ||||||||||||||||
| multiplyValueSpecifyingQuantity | bool | ✓ | true | Whether to multiply the value used for verification when specifying the quantity | ||||||||||||||||
| timeOffsetToken | string | ~ 1024 chars | 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"
}
}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").verify.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
Verify the reference source by specifying the user ID
Whether the action allows quantity specification: YES
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||
| inventoryName | string | ✓ | ~ 128 chars | Inventory Model Name | ||||||||||||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||||||||||||
| itemName | string | ✓ | ~ 128 chars | Item Model Name | ||||||||||||
| itemSetName | string | ✓ | UUID | ~ 36 chars | Name identifying the Item Set Maintains a unique name for each item set. Names are automatically generated in UUID (Universally Unique Identifier) format and used to identify each item set. | |||||||||||
| referenceOf | string | ✓ | ~ 1024 chars | References for this possession | ||||||||||||
| verifyType | String Enum enum { “not_entry”, “already_entry”, “empty”, “not_empty” } | ✓ | Type of verification
| |||||||||||||
| timeOffsetToken | string | ~ 1024 chars | 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"
}
}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").verify.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:VerifySimpleItemByUserId
Verify the quantity of possessions in simple items by specifying a user ID
Whether the action allows quantity specification: YES
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||||||||||||||||
| inventoryName | string | ✓ | ~ 128 chars | Simple Inventory Model Name Simple Inventory model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| itemName | string | ✓ | ~ 128 chars | Simple Item Model Name | ||||||||||||||||
| verifyType | String Enum enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } | ✓ | Type of verification
| |||||||||||||||||
| count | long | ✓ | 0 ~ 9223372036854775805 | Quantity in possession | ||||||||||||||||
| multiplyValueSpecifyingQuantity | bool | ✓ | true | Whether to multiply the value used for verification when specifying the quantity | ||||||||||||||||
| timeOffsetToken | string | ~ 1024 chars | 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"
}
}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").verify.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:VerifyBigItemByUserId
Verify possession quantity of Big Items by specifying a user ID
Whether the action allows quantity specification: YES
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||||||||||||||||
| inventoryName | string | ✓ | ~ 128 chars | Big Inventory Model Name Big Inventory Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| itemName | string | ✓ | ~ 128 chars | Big Item Model Name | ||||||||||||||||
| verifyType | String Enum enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } | ✓ | Type of verification
| |||||||||||||||||
| count | string | ✓ | ~ 1024 chars | Quantity in possession Integer value strings up to 1024 digits | ||||||||||||||||
| multiplyValueSpecifyingQuantity | bool | ✓ | true | Whether to multiply the value used for verification when specifying the quantity | ||||||||||||||||
| timeOffsetToken | string | ~ 1024 chars | 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"
}
}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").verify.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",
})ConsumeAction
Gs2Inventory:ConsumeItemSetByUserId
Consume Item Sets by specifying the user ID
Item Set hold Item Model name, quantity held, expiration date, and other details.
Whether the action allows quantity specification: YES
Whether the action is reversible: YES
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Inventory Model Name | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| itemName | string | ✓ | ~ 128 chars | Item Model Name | ||
| consumeCount | long | ✓ | 1 ~ 9223372036854775805 | Consumption quantity | ||
| itemSetName | string | ~ 36 chars | Name identifying the Item Set | |||
| timeOffsetToken | string | ~ 1024 chars | 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]Consumption quantity",
"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]Consumption quantity"
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]Consumption quantity",
itemSetName="[string]Name identifying the Item Set",
timeOffsetToken="[string]Time offset token",
})Gs2Inventory:ConsumeSimpleItemsByUserId
Consume Simple Items by specifying a user ID
Whether the action allows quantity specification: NO
Whether the action is reversible: YES
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Simple Inventory Model Name Simple Inventory model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| consumeCounts | List<ConsumeCount> | ✓ | 1 ~ 100 items | List of consumption quantity of Simple Items | ||
| timeOffsetToken | string | ~ 1024 chars | 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]Consumption quantity"
}
],
"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]Consumption quantity"
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]Consumption quantity"
}
},
timeOffsetToken="[string]Time offset token",
})Gs2Inventory:ConsumeBigItemByUserId
Consume Big Items by specifying a user ID
Whether the action allows quantity specification: YES
Whether the action is reversible: YES
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Big Inventory Model Name Big Inventory Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| itemName | string | ✓ | ~ 128 chars | Big Item Model Name Big Item model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| consumeCount | string | ✓ | ~ 1024 chars | Consumption quantity of Big Item Integer value strings up to 1024 digits | ||
| timeOffsetToken | string | ~ 1024 chars | 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]Consumption quantity of Big Item",
"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]Consumption quantity of Big Item"
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]Consumption quantity of Big Item",
timeOffsetToken="[string]Time offset token",
})AcquireAction
Gs2Inventory:AddCapacityByUserId
Add inventory capacity size by specifying a user ID
Whether the action allows quantity specification: YES
Whether the action is reversible: NO
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Inventory Model Name | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| addCapacityValue | int | ✓ | 1 ~ 2147483646 | Capacity size to be added | ||
| timeOffsetToken | string | ~ 1024 chars | 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"
}
}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 inventory capacity size by specifying a user ID
Whether the action allows quantity specification: YES
Whether the action is reversible: NO
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Inventory Model Name | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| newCapacityValue | int | ✓ | 1 ~ 2147483646 | New maximum capacity for inventory | ||
| timeOffsetToken | string | ~ 1024 chars | 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"
}
}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
Acquire Item Sets by specifying the user ID
Item Set hold Item Model name, quantity held, expiration date, and other details.
Whether the action allows quantity specification: YES
Whether the action is reversible: YES
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Inventory Model Name Inventory model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| itemName | string | ✓ | ~ 128 chars | Item Model Name | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| acquireCount | long | ✓ | 1 ~ 9223372036854775805 | Acquisition quantity | ||
| expiresAt | long | ✓ | 0 | Expiration date Unix time, milliseconds | ||
| createNewItemSet | bool | ✓ | false | Even if there is room in an existing Item Set, you can create a new Item Set | ||
| itemSetName | string | ~ 36 chars | Name identifying the Item Set | |||
| timeOffsetToken | string | ~ 1024 chars | 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]Acquisition quantity",
"expiresAt": "[long]Expiration date",
"createNewItemSet": "[bool]Even if there is room in an existing Item Set, you can create a new Item Set",
"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]Acquisition quantity"
expiresAt: "[long]Expiration date"
createNewItemSet: "[bool]Even if there is room in an existing Item Set, you can create a new Item Set"
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]Acquisition quantity",
expiresAt="[long]Expiration date",
createNewItemSet="[bool]Even if there is room in an existing Item Set, you can create a new Item Set",
itemSetName="[string]Name identifying the Item Set",
timeOffsetToken="[string]Time offset token",
})Gs2Inventory:AcquireItemSetWithGradeByUserId
Acquire one Item Set while setting the grade to GS2-Grade by specifying the user ID.
Whether the action allows quantity specification: NO
Whether the action is reversible: NO
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Inventory Model Name Inventory model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| itemName | string | ✓ | ~ 128 chars | Item Model Name | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| gradeModelId | string | ✓ | ~ 1024 chars | Grade Model GRN | ||
| gradeValue | long | ✓ | 1 ~ 9223372036854775805 | Grade value to set | ||
| timeOffsetToken | string | ~ 1024 chars | 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"
}
}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
Whether the action allows quantity specification: NO
Whether the action is reversible: NO
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Inventory Model Name | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| itemName | string | ✓ | ~ 128 chars | Item Model Name | ||
| itemSetName | string | ✓ | UUID | ~ 36 chars | Name identifying the Item Set Maintains a unique name for each item set. Names are automatically generated in UUID (Universally Unique Identifier) format and used to identify each item set. | |
| referenceOf | string | ✓ | ~ 1024 chars | References for this possession | ||
| timeOffsetToken | string | ~ 1024 chars | 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"
}
}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 the reference source by specifying the user ID
Whether the action allows quantity specification: NO
Whether the action is reversible: NO
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Inventory Model Name | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| itemName | string | ✓ | ~ 128 chars | Item Model Name | ||
| itemSetName | string | ✓ | UUID | ~ 36 chars | Name identifying the Item Set Maintains a unique name for each item set. Names are automatically generated in UUID (Universally Unique Identifier) format and used to identify each item set. | |
| referenceOf | string | ✓ | ~ 1024 chars | References for this possession | ||
| timeOffsetToken | string | ~ 1024 chars | 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"
}
}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
Acquire Simple Items by specifying a user ID
Whether the action allows quantity specification: NO
Whether the action is reversible: YES
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Simple Inventory Model Name Simple Inventory model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| acquireCounts | List<AcquireCount> | ✓ | 1 ~ 100 items | List of acquisition quantities for Simple Items | ||
| timeOffsetToken | string | ~ 1024 chars | 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]Acquisition quantity"
}
],
"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]Acquisition quantity"
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]Acquisition quantity"
}
},
timeOffsetToken="[string]Time offset token",
})Gs2Inventory:SetSimpleItemsByUserId
Set the quantity of simple items by specifying a user ID
Whether the action allows quantity specification: NO
Whether the action is reversible: NO
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Simple Inventory Model Name Simple Inventory model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| counts | List<HeldCount> | ✓ | 1 ~ 100 items | List of quantity of Simple Items in possession | ||
| timeOffsetToken | string | ~ 1024 chars | 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"
}
}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
Acquire Big Item by specifying a user ID
Whether the action allows quantity specification: YES
Whether the action is reversible: YES
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Big Inventory Model Name Big Inventory Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| itemName | string | ✓ | ~ 128 chars | Big Item Model Name Big Item model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| acquireCount | string | ✓ | ~ 1024 chars | Acquisition quantities for Big Item Integer value strings up to 1024 digits | ||
| timeOffsetToken | string | ~ 1024 chars | 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]Acquisition quantities for Big Item",
"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]Acquisition quantities for Big Item"
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]Acquisition quantities for Big Item",
timeOffsetToken="[string]Time offset token",
})Gs2Inventory:SetBigItemByUserId
Set the Big Item by specifying a user ID
Whether the action allows quantity specification: YES
Whether the action is reversible: NO
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| inventoryName | string | ✓ | ~ 128 chars | Big Inventory Model Name Big Inventory Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| itemName | string | ✓ | ~ 128 chars | Big Item Model Name Big Item model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| count | string | ✓ | ~ 1024 chars | Quantity of Big Item Integer value strings up to 1024 digits | ||
| timeOffsetToken | string | ~ 1024 chars | 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 Item",
"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 Item"
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 Item",
timeOffsetToken="[string]Time offset token",
})