ZEPETO.Inventory
13 min
type description inventorylistresponse /#inventorylistresponse the inventorylistresponse class provides the api call result and the product inventory information list inventoryrecord /#inventoryrecord inventory product information inventoryresponse /#inventoryresponse the inventoryresponse class provides the api call result and the retrieved inventory product information inventoryservice /#inventoryservice inventoryservice manages operations associated with the player's in world product inventory checkinventoryrequest /#checkinventoryrequest class for checking the existence of a specific product in a user's inventory checkinventoryresponse /#checkinventoryresponse class representing the response for checking the existence of a product in the inventory inventoryerror /#inventoryerror the error code specifies the reason for the failure of inventory related requests inventorylistresponse class · extends productbaseresponse the inventorylistresponse class provides the api call result and the product inventory information list properties name type description products inventoryrecord\[] /#inventoryrecord list of product inventory information inventoryrecord class inventory product information properties name type description productid string product id quantity bigint quantity of the product createdat date date and time when the product was added to the inventory updatedat date date and time when the product information was last updated inventoryresponse class · extends productbaseresponse the inventoryresponse class provides the api call result and the retrieved inventory product information properties name type description product inventoryrecord /#inventoryrecord inventory product information inventoryservice class inventoryservice manages operations associated with the player's in world product inventory methods getlistasync static getlistasync() → baserequest\<inventorylistresponse> this asynchronous method retrieves the player's inventory product information list returns baserequest\<inventorylistresponse> — a baserequest object when the asynchronous process is complete, you can access the inventorylistresponse object by the responsedata property getasync static getasync(productid string) → baserequest\<inventoryresponse> this asynchronous method retrieves the player's inventory product information based on the provided product id parameter type description productid string id of the product to fetch returns baserequest\<inventoryresponse> — a baserequest object when the asynchronous process is complete, you can access the inventoryresponse object by the responsedata property hasasync static hasasync(productid string) → checkinventoryrequest this asynchronous method checks the existence of a product in the player's inventory parameter type description productid string id of the product to check returns checkinventoryrequest /#checkinventoryrequest — a checkinventoryrequest object when the asynchronous process is complete, you can access the checkinventoryresponse object by the responsedata property checkinventoryrequest class · extends baseapirequest class for checking the existence of a specific product in a user's inventory properties name type description responsedata checkinventoryresponse /#checkinventoryresponse response data of checkinventoryresponse checkinventoryresponse class · extends productbaseresponse class representing the response for checking the existence of a product in the inventory properties name type description isexist boolean a boolean value that indicates whether a specific product exists in the user's inventory inventoryerror enum the error code specifies the reason for the failure of inventory related requests name value description unknown 1 error unknown error networkerror 0 error errors related to network issues, including disconnections or unstable connections
