Transaction Action of GS2-Inventory

VerifyAction

Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId

Verify current max inventory capacity by specifying user ID

Actions for which quantity can be specified: YES

	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
multiplyValueSpecifyingQuantity	bool	Whether to multiply the value used for verification when specifying the quantity
timeOffsetToken	string	Time offset token

Enumeration type definition to specify as verifyType

Enumerator String Definition	Description
less	Current max inventory capacity is less than the specified value
lessEqual	Current max inventory capacity is less than or equal to the specified value
greater	Current max inventory capacity is greater than the specified value
greaterEqual	Current max inventory capacity is greater than or equal to the specified value
equal	Current max inventory capacity is equal to the specified value
notEqual	Current max inventory capacity is not equal to the specified value

{
    "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:VerifyItemSetByUserId

Verify possession quantity by specifying the user ID

Actions for which quantity can be specified: YES

	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
multiplyValueSpecifyingQuantity	bool	Whether to multiply the value used for verification when specifying the quantity
timeOffsetToken	string	Time offset token

Enumeration type definition to specify as verifyType

Enumerator String Definition	Description
less	Possession quantity is less than the specified value
lessEqual	Possession quantity is less than or equal to the specified value
greater	Possession quantity is greater than the specified value
greaterEqual	Possession quantity is greater than or equal to the specified value
equal	Possession quantity is equal to the specified value
notEqual	Possession quantity is not equal to the specified value

{
    "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

Verify the reference source by specifying the user ID

Actions for which quantity can be specified: 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
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
timeOffsetToken	string	Time offset token

Enumeration type definition to specify as verifyType

Enumerator String Definition	Description
not_entry	That the specified referent is not yet registered.
already_entry	The specified reference must already be registered.
empty	Zero elements registered as referents.
not_empty	At least one element registered as a reference source

{
    "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:VerifySimpleItemByUserId

Verify the quantity of possessions in simple items by specifying user ID

Actions for which quantity can be specified: YES

	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
multiplyValueSpecifyingQuantity	bool	Whether to multiply the value used for verification when specifying the quantity
timeOffsetToken	string	Time offset token

Enumeration type definition to specify as verifyType

Enumerator String Definition	Description
less	Possession quantity is less than the specified value
lessEqual	Possession quantity is less than or equal to the specified value
greater	Possession quantity is greater than the specified value
greaterEqual	Possession quantity is greater than or equal to the specified value
equal	Possession quantity is equal to the specified value
notEqual	Possession quantity is not equal to the specified value

{
    "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:VerifyBigItemByUserId

Verify possession quantity of big items by user ID

Actions for which quantity can be specified: YES

	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
multiplyValueSpecifyingQuantity	bool	Whether to multiply the value used for verification when specifying the quantity
timeOffsetToken	string	Time offset token

Enumeration type definition to specify as verifyType

Enumerator String Definition	Description
less	Possession quantity is less than the specified value
lessEqual	Possession quantity is less than or equal to the specified value
greater	Possession quantity is greater than the specified value
greaterEqual	Possession quantity is greater than or equal to the specified value
equal	Possession quantity is equal to the specified value
notEqual	Possession quantity is not equal to the specified value

{
    "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",
})

ConsumeAction

Gs2Inventory:ConsumeItemSetByUserId

Consume items by specifying the 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
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"
    }
}

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:ConsumeSimpleItemsByUserId

Consume simple items by specifying 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 simple items 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"
    }
}

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:ConsumeBigItemByUserId

Consume big items by specifying 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 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"
    }
}

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",
})

AcquireAction

Gs2Inventory:AddCapacityByUserId

Add inventory capacity size by specifying user ID

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
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"
    }
}

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 user ID

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.
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"
    }
}

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 items by specifying the user ID

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
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"
    }
}

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

Acquire items by specifying the user ID and setting the grade in GS2-Grade

Actions for which quantity can be specified: NO

Reversible action: NO

	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.
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"
    }
}

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

	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
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"
    }
}

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

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
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"
    }
}

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 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.
acquireCounts	AcquireCount[]	List of quantity of simple items 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"
    }
}

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 the quantity of simple items by specifying user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
inventoryName	string	Simple Inventory Model Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
counts	HeldCount[]	List of quantity of simple items to be obtained
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"
    }
}

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 items by specifying 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
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"
    }
}

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 the quantity of big items by specifying user ID

Actions for which quantity can be specified: YES

Reversible action: NO

	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
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"
    }
}

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",
})