ZEPETO.Multiplay.Product

6 min

Type	Description
ProductError	The error code specifies the reason for the failure of in-World product-related requests.
PurchaseType	Enum representing the in-World product purchase type.
ProductStatus	Enum representing the in-World product status.
ProductType	Enum representing the in-World product type.
ProductRecord	In-World product information.

ProductError

enum

The error code specifies the reason for the failure of in-World product-related requests.

Name	Value	Description
Unknown	-1	Error: Unknown error.
NetworkError	0	Error: Errors related to network issues, including disconnections or unstable connections.

enum

Enum representing the in-World product purchase type.

Name	Value	Description
Consumable	"CONSUMABLE"	Consumable in-World product.
NonConsumable	"NON_CONSUMABLE"	Non-consumable in-World product.

enum

Enum representing the in-World product status.

Name	Value	Description
Active	"ACTIVE"	Active state.
InActive	"INACTIVE"	Inactive state.
Forbidden	"FORBIDDEN"	Forbidden state due to expiration of use.

enum

Enum representing the in-World product type.

Name	Value	Description
Item	"ITEM"	Single item in-World product.
ItemPackage	"ITEM_PACKAGE"	Item in-World product package, including multiple items.
CurrencyPackage	"CURRENCY_PACKAGE"	Currency in-World product package, including multiple currencies.

interface

In-World product information.

Name	Type	Description
productId	string	In-World Product ID.
name	string	In-World Product name.
price	number	In-World Product price.
purchaseType	PurchaseType	PurchaseType of the in-World product.
status	ProductStatus	ProductStatus of the in-World product.
productType	ProductType	ProductType of the in-World product.
currency	{ currencyId: string; name: string; isOfficialCurrency: boolean }	Returns the type of the currency used for purchasing the in-World product.
itemPackageUnits	{ productId: string; itemName: string; quantity: number }[]	Items included in the in-World product if ProductType is ItemPackage.
currencyPackageUnits	{ currencyId: string; currencyName: string; quantity: number }[]	Currencies included in the in-World product if ProductType is CurrencyPackage.