주문목록 가져오기

지원환경: React NativeWebView

실행환경: Toss App

getCompletedOrRefundedOrders

getCompletedOrRefundedOrders 는 인앱결제로 구매하고 환불한 주문 목록을 가져와요.
인앱결제 결제 및 상품 지급이 완료된 주문건와 환불된 주문건을 조회할 수 있어요.

결제는 완료되었지만 상품이 아직 지급되지 않은 주문건은 조회되지 않아요.
getPendingOrders함수를 통해 orderId를 조회하여 사용자에게 상품을 지급한 후 completeProductGrant함수를 통해 상품 지급을 완료 처리하세요.

앱 버전이 최소 지원 버전(안드로이드 5.231.0, iOS 5.231.0)보다 낮으면 undefined를 반환해요.

시그니처

function getCompletedOrRefundedOrders(params?: {
  key?: string | null;
}): Promise<CompletedOrRefundedOrdersResult | undefined>;

반환값

• Promise<{ CompletedOrRefundedOrdersResult } | undefined>
  

  페이지네이션을 포함한 주문 목록 객체를 반환해요.
  앱 버전이 최소 지원 버전(안드로이드 5.231.0, iOS 5.231.0)보다 낮으면 undefined를 반환해요.

반환 객체 프로퍼티

interface CompletedOrRefundedOrdersResult {
    hasNext: boolean;
    nextKey?: string | null;
    orders: {
        orderId: string;
        sku: string;
        status: 'COMPLETED' | 'REFUNDED';
        date: string;
    }[];
}

• hasNext필수 · boolean
  

  다음 페이지가 있는지 여부예요. `true`면 더 많은 주문이 남아 있어요.

• nextKey선택 · string | null · null
  

  다음 페이지 조회를 위한 커서 키예요. 이전 응답의 nextKey 값을 사용해요. 첫 호출 시에는 생략하거나 null로 전달해요.

• orders필수 · Array
  

  주문 정보를 담은 배열이에요. 각 요소는 하나의 주문을 나타내요.

• orders[].orderId필수 · string
  

  주문의 고유 ID 예요.

• orders[].sku필수 · string

  주문 상품의 고유 ID 예요.

• orders[].status필수 · {'COMPLETED' | 'REFUNDED'}

  주문의 상태예요. 'COMPLETED'는 주문이 완료된 상태, 'REFUNDED'는 환불된 상태를 의미해요.

• orders[].date필수 · string

  주문의 날짜 정보예요. ISO 8601 형식(YYYY-MM-DDTHH:mm:ss)을 사용해요.
  예를 들어 "2025-09-22T00:00:00" 형식으로 제공돼요.
  주문 상태가 `COMPLETED`라면 주문한 날짜를, `REFUNDED`라면 환불한 날짜를 나타내요.

예제

 import { IAP } from '@apps-in-toss/framework';
 
 async function fetchOrders() {
   try {
     const pendingOrders = await IAP.getCompletedOrRefundedOrders();
     return response;
   } catch (error) {
     console.error(error);
   }
 }