ZEPETO.Module.Shop
Type | Description |
|---|---|
ShopService | ShopService enables operations connected to the ZEPETO shop within the World. This service lets players access shop information, such as thumbnail images of owned or wish-listed items, and send gifts to other players. |
The CategoryResponse class provides the API call result and the ZEPETO shop item category information. | |
The ContentItemListResponse class provides the API call result and the retrieved item list. | |
ItemKeyword | Item category. |
The ContentItemResponse class provides the API call result and the item information. | |
Background type to be used for gift notification popup. | |
The ItemGiftResponse class provides the result of item gifting. | |
CategoryInfo | ZEPETO shop item category information. |
Category | Item category. |
enum |
ShopService
class
ShopService enables operations connected to the ZEPETO shop within the World. This service lets players access shop information, such as thumbnail images of owned or wish-listed items, and send gifts to other players.
Methods
DownloadItemThumbnail
static DownloadItemThumbnail(itemCode: string) → BaseRequest<TextureResponse>
This asynchronous method retrieves the thumbnail of an item.
Parameter | Type | Description |
|---|---|---|
itemCode | string | Item Code |
Returns: BaseRequest<TextureResponse> — A BaseRequest object. When the asynchronous process is complete, you can access the TextureResponse object by the responseData property.
GetMyCategoryAsync
static GetMyCategoryAsync() → BaseRequest<CategoryResponse>
This method retrieves the item category information from the ZEPETO shop inventory of the local player's user account.
Returns: BaseRequest<CategoryResponse> — A BaseRequest object. When the asynchronous process is complete, you can access the CategoryResponse object by the responseData property.
GetMyContentItemListAsync
static GetMyContentItemListAsync(itemKeyword: ItemKeyword, pageToken?: string) → BaseRequest<ContentItemListResponse>
This asynchronous method retrieves the item list for each item category.
Parameter | Type | Description |
|---|---|---|
itemKeyword | ItemKeyword | Item category. |
pageToken (optional) | string | Page token. When calling this method for the first time, set this parameter to null. |
Returns: BaseRequest<ContentItemListResponse> — A BaseRequest object. When the asynchronous process is complete, you can access the ContentItemListResponse object by the responseData property.
GetContentItemAsync
static GetContentItemAsync(itemId: string) → BaseRequest<ContentItemResponse>
This asynchronous method retrieves the item information.
Parameter | Type | Description |
|---|---|---|
itemId | string | Item Code. |
Returns: BaseRequest<ContentItemResponse> — A BaseRequest object. When the asynchronous process is complete, you can access the ContentItemResponse object by the responseData property.
GetMyWishContentItemListAsync
static GetMyWishContentItemListAsync() → BaseRequest<ContentItemListResponse>
This asynchronous method retrieves the item list from the ZEPETO shop wish list of the local player's user account.
Returns: BaseRequest<ContentItemListResponse> — A BaseRequest object. When the asynchronous process is complete, you can access the ContentItemListResponse object by the responseData property.
CategoryResponse
class · extends BaseResponse
The CategoryResponse class provides the API call result and the ZEPETO shop item category information.
Properties
Name | Type | Description |
|---|---|---|
category | CategoryInfo | ZEPETO shop item category information. |
ContentItemListResponse
class · extends PlayBaasResponse
The ContentItemListResponse class provides the API call result and the retrieved item list.
Properties
Name | Type | Description |
|---|---|---|
items | Item[] | Item List. |
nextPageToken | string | The nextPageToken is included in the response when numerous items are available, allowing retrieval of the subsequent item list. When no items remain, nextPageToken is set to null. |
ItemKeyword
enum
Item category.
Name | Value |
|---|---|
all | 0 |
hair | 1 |
onepiece | 2 |
top | 3 |
outwear | 4 |
pants | 5 |
skirt | 6 |
socks | 7 |
footwear | 8 |
headwear | 9 |
eyewear | 10 |
jewelry | 11 |
makeup | 12 |
accessory | 13 |
bodyfigure | 14 |
animal | 15 |
none | 16 |
ContentItemResponse
class · extends PlayBaasResponse
The ContentItemResponse class provides the API call result and the item information.
Properties
Name | Type | Description |
|---|---|---|
item | Item | Item. |
GiftBackgroundType
enum
Background type to be used for gift notification popup.
Name | Value |
|---|---|
Type01 | 1 |
Type02 | 2 |
Type03 | 3 |
Type04 | 4 |
ItemGiftResponse
class · extends PurchaseBaseResponse
The ItemGiftResponse class provides the result of item gifting.
Properties
Name | Type | Description |
|---|---|---|
zem | number | Remaining ZEM balance in the local player's user account after completing gifting. |
coin | number | Remaining coin balance in the local player's user account after completing gifting. |
CategoryInfo
class
ZEPETO shop item category information.
Properties
Name | Type | Description |
|---|---|---|
displayName | string | The localized display name of the shop inventory tab. |
categories | Category[] | Item category list under the inventory tab. |
Category
class
Item category.
Properties
Name | Type | Description |
|---|---|---|
displayName | string | The localized display name of the item category. |
keyword | ItemKeyword | Enum representing the item category. |
ItemRequestType
enum
Name | Value |
|---|---|
Purchase | 0 |
Gift | 1 |