ZEPETO.Inventory
형식 | 설명 |
|---|---|
InventoryListResponse 클래스는 API 호출 결과와 상품 인벤토리 정보 목록을 제공합니다. | |
인벤토리 상품 정보입니다. | |
InventoryResponse 클래스는 API 호출 결과와 가져온 인벤토리 상품 정보를 제공합니다. | |
InventoryService는 플레이어의 World 내 상품 인벤토리와 관련된 작업을 관리합니다. | |
사용자의 인벤토리에 특정 상품이 있는지 확인하기 위한 클래스입니다. | |
인벤토리 내 상품 존재 여부 확인에 대한 응답을 나타내는 클래스입니다. | |
인벤토리 관련 요청이 실패한 원인을 나타내는 오류 코드입니다. |
InventoryListResponse
class · extends ProductBaseResponse
InventoryListResponse 클래스는 API 호출 결과와 상품 인벤토리 정보 목록을 제공합니다.
속성
이름 | 형식 | 설명 |
|---|---|---|
products | 상품 인벤토리 정보 목록입니다. |
InventoryRecord
class
인벤토리 상품 정보입니다.
속성
이름 | 형식 | 설명 |
|---|---|---|
productId | string | 상품 ID입니다. |
quantity | bigint | 상품의 수량입니다. |
createdAt | Date | 상품이 인벤토리에 추가된 날짜와 시간입니다. |
updatedAt | Date | 상품 정보가 마지막으로 갱신된 날짜와 시간입니다. |
InventoryResponse
class · extends ProductBaseResponse
InventoryResponse 클래스는 API 호출 결과와 가져온 인벤토리 상품 정보를 제공합니다.
속성
이름 | 형식 | 설명 |
|---|---|---|
product | 인벤토리 상품 정보입니다. |
InventoryService
class
InventoryService는 플레이어의 World 내 상품 인벤토리와 관련된 작업을 관리합니다.
메서드
GetListAsync
static GetListAsync() → BaseRequest<InventoryListResponse>
플레이어의 인벤토리 상품 정보 목록을 가져오는 비동기 메서드입니다.
반환값: BaseRequest<InventoryListResponse> — BaseRequest 객체입니다. 비동기 처리가 완료되면 responseData 속성을 통해 InventoryListResponse 객체에 접근할 수 있습니다.
GetAsync
static GetAsync(productId: string) → BaseRequest<InventoryResponse>
전달된 상품 ID를 기준으로 플레이어의 인벤토리 상품 정보를 가져오는 비동기 메서드입니다.
매개변수 | 형식 | 설명 |
|---|---|---|
productId | string | 가져올 상품의 ID입니다. |
반환값: BaseRequest<InventoryResponse> — BaseRequest 객체입니다. 비동기 처리가 완료되면 responseData 속성을 통해 InventoryResponse 객체에 접근할 수 있습니다.
HasAsync
static HasAsync(productId: string) → CheckInventoryRequest
플레이어의 인벤토리에 상품이 있는지 확인하는 비동기 메서드입니다.
매개변수 | 형식 | 설명 |
|---|---|---|
productId | string | 확인할 상품의 ID입니다. |
반환값: CheckInventoryRequest — CheckInventoryRequest 객체입니다. 비동기 처리가 완료되면 responseData 속성을 통해 CheckInventoryResponse 객체에 접근할 수 있습니다.
CheckInventoryRequest
class · extends BaseAPIRequest
사용자의 인벤토리에 특정 상품이 있는지 확인하기 위한 클래스입니다.
속성
이름 | 형식 | 설명 |
|---|---|---|
responseData | CheckInventoryResponse의 응답 데이터입니다. |
CheckInventoryResponse
class · extends ProductBaseResponse
인벤토리 내 상품 존재 여부 확인에 대한 응답을 나타내는 클래스입니다.
속성
이름 | 형식 | 설명 |
|---|---|---|
isExist | boolean | 특정 상품이 사용자의 인벤토리에 있는지 여부를 나타내는 불리언 값입니다. |
InventoryError
enum
인벤토리 관련 요청이 실패한 원인을 나타내는 오류 코드입니다.
이름 | 값 | 설명 |
|---|---|---|
Unknown | -1 | 오류: 알 수 없는 오류입니다. |
NetworkError | 0 | 오류: 연결 끊김이나 불안정한 연결 등 네트워크 문제와 관련된 오류입니다. |