# SDK 사용 가이드

## SDK 사용 가이드 <a href="#u0rlleycroyaqs3qsidsnbtrk5w-3d" id="u0rlleycroyaqs3qsidsnbtrk5w-3d"></a>

스크립트에서 SDK를 사용할 수 있도록 고도몰 모든 상점에는 아래의 스크립트가 설치되어 있습니다.

```javascript
<script src="//obs-address/godomall-sdk.js" onload="GodomallSDK.setup()">
</script>
```

{% hint style="danger" %}
SDK 사용 시에는 위 스크립트가 완전히 로드된 이후에 실행될 수 있도록 반드시 다음과 같이 defer 처리를 해주셔야 합니다. **defer 처리를 하지 않는 경우 오류가 발생할 수 있습니다.**
{% endhint %}

```javascript
<script defer>
    var mySDK = GodomallSDK.init('SystemKey');
    mySDK.getMemberProfile(function(err, res) {
    });
</script>
```

GodomallSDK.init('시스템키') 스크립트를 삽입할 때마다 새로운 객체가 생성됩니다.

> ### **결과정보**

SDK 실행 시 결과는 아래와 같이 전달됩니다.

```javascript
/**
 * 조회 및 처리 실패 / err
 * return {}
 */
{
    name: '오류 명칭',
    kind: '오류 종류',
    status: 'HTTP 상태 코드',
    message: '오류 메시지',
    data: {전체 오류 정보}
}

/**
 * 조회 및 처리 성공 / res
 * return {} or []
 */
// 사용 메소드에 따라 {}객체, []배열로 전달
```

> ### **메소드 구조**

기본구조에서 추가 파라미터가 없을 경우 version = '1.0' 으로 고정됩니다.

```javascript
// 기본 구조
mySDK.[메소드](callback)

// 추가 파리미터가 있을 경우의 구조
mySDK.[메소드]({ 추가 파라미터 }, callback)
```

> ### **SDK 목록**

사용 가능한 SDK는 다음과 같습니다.

| 변수명              | 설명                 |
| ---------------- | ------------------ |
| getMemberSummary | 회원 요약 정보           |
| getMemberProfile | 회원 프로필             |
| getMallInfo      | 쇼핑몰 식별 정보          |
| getMallLocation  | 접속 페이지 정보          |
| getGoods         | 상품 번호로 상품 상세 정보 조회 |
| getCart          | 장바구니 조회            |
| getGoodsSearch   | 상품 검색              |
| getOrders        | 주문 상세 조회           |

> ### **SDK 목록 상세**

#### <mark style="background-color:green;">**회원 요약 정보**</mark>

**제공 데이터**

| 필드명                     | 데이터 형식 | 설명                   |
| ----------------------- | ------ | -------------------- |
| totalCartGoodsCount     | number | 장바구니 총 개수 (상품 기준)    |
| totalCartCount          | number | 장바구니 총 개수 (상품 옵션 기준) |
| totalOrderAmount        | number | 총 주문 금액              |
| totalOrderGoodsCount    | number | 총 주문 상품 개수           |
| totalPaymentAmount      | number | 총 결제 금액              |
| usableCouponCount       | number | 사용 가능한 쿠폰 개수         |
| totalCartQuantity       | number | 장바구니 수량 합계           |
| totalOrderCount         | number | 총 주문 수               |
| totalOrderGoodsQuantity | number | 주문 상품 수량 합계          |

**사용 예시**

```javascript
/*
 새로 생성되는 객체의 변수명은 반드시 systemKey를 발급받은 앱의 일련번호를 기재해 주셔야 합니다.
*/

<script defer>    
    var 변수명_SDK = GodomallSDK.init('systemKey');
    변수명_SDK.getMemberProfile(function(err, res) {
        if (err) {
            console.log(err.name, err.kind, err.data, err.status, err.message);
        } else {
            console.log(res);
        }
    });
    변수명_SDK.getMemberSummary(function(err, res) {
        if (res) {
            // 필요한 코드 작성
        }
    });
</script>
```

#### <mark style="background-color:green;">**회원 프로필**</mark>

**제공 데이터**

<table><thead><tr><th>필드명</th><th width="249">데이터 형식</th><th>설명</th></tr></thead><tbody><tr><td>sno</td><td>number</td><td>회원번호</td></tr><tr><td>id</td><td>string</td><td>회원 아이디</td></tr><tr><td>name</td><td>string</td><td>성명</td></tr><tr><td>email</td><td>string</td><td>이메일</td></tr><tr><td>cellPhone</td><td>string</td><td>휴대전화번호</td></tr><tr><td>mileage</td><td>number</td><td>적립금</td></tr><tr><td>deposit</td><td>number</td><td>예치금</td></tr><tr><td>grade</td><td>array</td><td>회원 등급 정보</td></tr><tr><td>     sno</td><td>number</td><td>회원 등급 번호</td></tr><tr><td>     name</td><td>string</td><td>회원 등급명</td></tr><tr><td>age</td><td>number</td><td>만 나이</td></tr><tr><td>gender</td><td>string</td><td>성별<br>- MALE : 남성<br>- FEMALE : 여성<br>- UNKNOWN : 모름</td></tr><tr><td>zipcode</td><td>string</td><td>우편번호</td></tr><tr><td>address</td><td>string</td><td>주소</td></tr><tr><td>addressDetail</td><td>string</td><td>상세주소</td></tr><tr><td>adultFlag</td><td>string</td><td>성인인증여부<br>- Y : 인증완료<br>- N : 미인증</td></tr><tr><td>mailingFlag</td><td>string</td><td>이메일 수신여부<br>- Y : 수신허용<br>- N : 수신거부</td></tr><tr><td>smsFlag</td><td>string</td><td>SMS 수신여부<br>- Y : 수신허용<br>- N : 수신거부</td></tr><tr><td>signupDateTime</td><td>string</td><td>가입 일시</td></tr></tbody></table>

**사용 예시**

```javascript
/* 
새로 생성되는 객체의 변수명은 반드시 systemKey를 발급받은 앱의 일련번호를 기재해 주셔야 합니다.
*/

<script defer>
    var 변수명_SDK = GodomallSDK.init('systemKey');
    변수명_SDK.getMemberProfile(function(err, res) {
        if (err) {
            오류 핸들링이 필요하다면 코드 작성
        } else if (res) {
            // 필요한 코드 작성
        }
    });
</script>
```

#### <mark style="background-color:green;">**쇼핑몰 식별 정보**</mark>

**제공 데이터**

<table><thead><tr><th>필드명</th><th width="249">데이터 형식</th><th>설명</th></tr></thead><tbody><tr><td>mallDomain</td><td>string</td><td>쇼핑몰 도메인</td></tr><tr><td>mallNm</td><td>string</td><td>쇼핑몰 명</td></tr><tr><td>mallNmEng</td><td>string</td><td>쇼핑몰 영문 명</td></tr><tr><td>mallUsageStatus</td><td>array</td><td>몰 사용 여부<br>- Y : 사용<br>- N : 미사용</td></tr><tr><td>     kr</td><td>string</td><td>국문몰  사용  여부<br>- Y : 사용<br>- N : 미사용</td></tr><tr><td>     us</td><td>string</td><td>영문몰  사용  여부<br>- Y : 사용<br>- N : 미사용</td></tr><tr><td>     cn</td><td>string</td><td>중문몰  사용  여부<br>- Y : 사용<br>- N : 미사용</td></tr><tr><td>     jp</td><td>string</td><td>일문몰  사용  여부<br>- Y : 사용<br>- N : 미사용</td></tr></tbody></table>

<mark style="color:red;">※ 커스터마이징 상점의 경우 쇼핑몰명 (mallNm), 쇼핑몰영문명 (mallNmEng), 해외몰 사용 여부 (mallUsageStatus)는 응답되지 않을 수 있습니다.</mark>

**사용 예시**

```javascript
<script defer>
    var 변수명_SDK = GodomallSDK.init('systemKey');
    변수명_SDK.getMallInfo(function(err, res) {
        if (res) {
            // 필요한 코드 작성
        }
    });
</script>
```

#### <mark style="background-color:green;">**접속 페이지 정보**</mark>

**제공 데이터**

<table><thead><tr><th>필드명</th><th width="249">데이터 형식</th><th>설명</th></tr></thead><tbody><tr><td>path</td><td>string</td><td>현재 경로 (기본 도메인 제외)<br>ex. /member/join_method.php</td></tr><tr><td>pathSegments</td><td>array</td><td>현재 경로에 대한 배열 정보<br>ex. goods, member,join_method..</td></tr></tbody></table>

**사용 예시**

```javascript
<script defer>
    var 변수명_SDK = GodomallSDK.init('systemKey');
    변수명_SDK.getMallLocation(function(err, res) {
        if (res) {
            // 필요한 코드 작성
        }
    });
</script>
```

#### <mark style="background-color:green;">**상품 번호로 상품 상세 정보 조회**</mark>

**요청 파라메터**

<table><thead><tr><th width="249">필드명</th><th>데이터 형식</th><th>설명</th></tr></thead><tbody><tr><td>goodsNo</td><td>string</td><td>상품 번호</td></tr></tbody></table>

**제공 데이터**

<table><thead><tr><th>필드명</th><th width="249">데이터 형식</th><th>설명</th></tr></thead><tbody><tr><td>sno</td><td>number</td><td>상품 번호</td></tr><tr><td>name</td><td>string</td><td>상품명</td></tr><tr><td>images</td><td>array</td><td>상품 이미지 목록</td></tr><tr><td>     kind</td><td>string</td><td>상품 이미지 종류</td></tr><tr><td>     sortNo</td><td>number</td><td>상품 이미지 순번</td></tr><tr><td>     url</td><td>string</td><td>상품 이미지 url</td></tr><tr><td>status</td><td>array</td><td>상품 상태</td></tr><tr><td>     sellFlag</td><td>string</td><td>판매 상태<br>- Y : 판매중<br>- N : 판매 중지</td></tr><tr><td>     soldOutFlag</td><td>string</td><td>품절 상태<br>- Y : 판매중<br>- N : 판매 중지</td></tr><tr><td>options</td><td>array</td><td>상품 옵션</td></tr><tr><td>     sno</td><td>number</td><td>상품 옵션 번호</td></tr><tr><td>     option1</td><td>array</td><td>옵션 1</td></tr><tr><td>          name</td><td>string</td><td>옵션 제목</td></tr><tr><td>          value</td><td>string</td><td>옵션 값</td></tr><tr><td>     option2</td><td>array</td><td>옵션 2</td></tr><tr><td>     option3</td><td>array</td><td>옵션 3</td></tr><tr><td>     option4</td><td>array</td><td>옵션 4</td></tr><tr><td>     option5</td><td>array</td><td>옵션 5</td></tr><tr><td>     originPrice</td><td>number</td><td>상품 옵션 가격</td></tr><tr><td>     discountAmount</td><td>number</td><td>타임세일 할인 가격</td></tr><tr><td>     stockCount</td><td>number</td><td>옵션 재고 수</td></tr><tr><td>     memo</td><td>string</td><td>옵션 메모</td></tr><tr><td>textOptions</td><td>array</td><td>텍스트 상품 옵션</td></tr><tr><td>     name</td><td>string</td><td>옵션 제목</td></tr><tr><td>     price</td><td>number</td><td>옵션 가격</td></tr><tr><td>     requiredFlag</td><td>string</td><td>옵션 필수 여부<br>- Y : 사용<br>- N : 미사용</td></tr><tr><td>addGoods</td><td>array</td><td>추가 상품</td></tr><tr><td>     title</td><td>string</td><td>추가 상품 제목</td></tr><tr><td>     requiredFlag</td><td>string</td><td>추가 상품 필수 여부<br>- Y : 필수<br>- N : 미필수</td></tr><tr><td>     items</td><td>array</td><td>추가 상품 정보</td></tr><tr><td>          sno</td><td>number</td><td>추가 상품 번호</td></tr><tr><td>          name</td><td>string</td><td>추가 상품 명</td></tr><tr><td>          price</td><td>number</td><td>추가 상품 가격</td></tr><tr><td>registerDateTime</td><td>string</td><td>등록 일시</td></tr></tbody></table>

**사용 예시**

```javascript
<script defer>
    var 변수명_SDK = GodomallSDK.init('systemKey');
    변수명_SDK.getGoods(
        {
            goodsNo: 1000
        },
        function(err, res) {
            if (res) {
                // 필요한 코드 작성
            }
        }
    });
</script>
```

#### <mark style="background-color:green;">**장바구니 조회**</mark>

**제공 데이터**

<table><thead><tr><th>필드명</th><th width="249">데이터 형식</th><th>설명</th></tr></thead><tbody><tr><td>totalAmount</td><td>number</td><td><p>상품 옵션 합산 가격</p><p><sub>(상품+옵션+텍스트옵션+추가상품)-(상품+회원+쿠폰)</sub></p></td></tr><tr><td>shipping</td><td>array</td><td>배송비 정보</td></tr><tr><td>     amount</td><td>number</td><td>배송비 금액</td></tr><tr><td>     chargeType</td><td>string</td><td>배송비 지불 방식</td></tr><tr><td>sno</td><td>number</td><td>장바구니 번호</td></tr><tr><td>addGoods</td><td>array</td><td>추가 상품 정보</td></tr><tr><td>     sno</td><td>number</td><td>추가 상품 번호</td></tr><tr><td>     price</td><td>number</td><td>추가 상품 가격 (개당)</td></tr><tr><td>     count</td><td>number</td><td>추가 상품 개수</td></tr><tr><td>registerDateTime</td><td>string</td><td>등록 일자</td></tr><tr><td>goods</td><td>array</td><td>상품 정보</td></tr><tr><td>     sno</td><td>number</td><td>상품 번호</td></tr><tr><td>     textOptions</td><td>array</td><td>텍스트 옵션</td></tr><tr><td>          sno</td><td>number</td><td>텍스트 옵션 번호</td></tr><tr><td>          price</td><td>number</td><td>텍스트 옵션 가격</td></tr><tr><td>          title</td><td>string</td><td>텍스트 옵션 제목</td></tr><tr><td>          value</td><td>string</td><td>텍스트 옵션 값</td></tr><tr><td>     count</td><td>number</td><td>상품 개수</td></tr><tr><td>     name</td><td>string</td><td>상품명</td></tr><tr><td>     option</td><td>array</td><td>상품 옵션 정보</td></tr><tr><td>          sno</td><td>number</td><td>상품 옵션 번호</td></tr><tr><td>          price</td><td>number</td><td>옵션 가격</td></tr><tr><td>          option 1~5</td><td>array</td><td>옵션 (1~5)</td></tr><tr><td>                title</td><td>string</td><td>옵션 제목</td></tr><tr><td>               value</td><td>string</td><td>옵션값</td></tr><tr><td>          discountAmount</td><td>number</td><td>옵션 할인된 가격</td></tr><tr><td>benefit</td><td>array</td><td>구매혜택 정보</td></tr><tr><td>     sale</td><td>array</td><td>구매혜택 - 할인</td></tr><tr><td>          coupon</td><td>number</td><td>구매혜택 - 쿠폰 할인 </td></tr><tr><td>          member</td><td>number</td><td>구매 혜택 - 회원 등급 할인</td></tr><tr><td>          goods</td><td>number</td><td>구매 혜택 - 상품 할인</td></tr><tr><td>     mileage</td><td>array</td><td>구매 혜택 - 마일리지</td></tr><tr><td>          coupon</td><td>number</td><td>구매 혜택 - 쿠폰 마일리지</td></tr><tr><td>          member</td><td>number</td><td>구매 혜택 - 회원 등급 마일리지</td></tr><tr><td>          goods</td><td>number</td><td>구매 혜택 - 상품 마일리지</td></tr></tbody></table>

**사용 예시**

```javascript
<script defer>
    
    mySDK.getCarts(function(err, res) {
        console.log(err, res)
    });
</script>
```

**샘플 구조**

```javascript
[
  {
    "sno": 1,
    "goods": {
      "sno": 1000004033,
      "name": "쿠폰사용가능범위_카테고리B",
      "count": 1,
      "option": {
        "sno": 7462,
        "option1": {
          "title": "타이틀1",
          "value": "옵션값1"
        },
        "option2": {
          "title": "타이틀1",
          "value": "옵션값1"
        },
        "option3": {
          "title": "타이틀1",
          "value": "옵션값1"
        },
        "option4": {
          "title": "타이틀1",
          "value": "옵션값1"
        },
        "option5": {
          "title": "타이틀1",
          "value": "옵션값1"
        },
        "price": 1000,
        "discountAmount": 0
      },
      "textOptions": [
        {
          "sno": 10,
          "price": 1000,
          "title": "텍스트 옵션 제목",
          "value": "텍스트 옵션 값"
        }
      ]
    },
    "addGoods": [
      {
        "sno": 1000004033,
        "count": 1,
        "price": 1000
      }
    ],
    "benefit": {
      "sale": {
        "goods": 0,
        "member": 0,
        "coupon": 0
      },
      "mileage": {
        "goods": 0,
        "member": 0,
        "coupon": 0
      }
    },
    "totalAmount": 2000,
    "shipping": {
      "amount": 2500,
      "chargeType": "PREPAID"
    },
    "registerDateTime": "2024-08-28 14:59:04"
  }
]
```

#### <mark style="background-color:green;">**상품 검색**</mark>

**요청 파라메터**

<table><thead><tr><th width="249">필드명</th><th>데이터 형식</th><th>설명</th></tr></thead><tbody><tr><td>searchType</td><td>string</td><td>검색 타입<br><sub>GOODS_NO: 상품 번호</sub><br><sub>GOODS_NAME: 상품명</sub><br><sub>GOODS_CODE: 자체 상품 코드</sub><br><sub>MAKER_NAME: 제조사</sub><br><sub>ORIGIN_NAME: 원산지</sub><br><sub>SEARCH_WORD: 검색 키워드</sub></td></tr><tr><td>keyword</td><td>string</td><td>검색 키워</td></tr><tr><td>page</td><td>number</td><td>베이지 번호</td></tr><tr><td>pageSize</td><td>number</td><td>페이지당 항목 수</td></tr><tr><td>sort</td><td>string</td><td>정렬 기준</td></tr></tbody></table>

**제공 데이터**

| 필드명              | 데이터 형식 | 설명       |
| ---------------- | ------ | -------- |
| contents         | array  | 조회 결과    |
| sno              | number | 상품 번호    |
| price            | number | 상품 가격    |
| registerDateTime | string | 등록 일시    |
| name             | string | 상품 명     |
| discountAmount   | number | 할인 금액    |
| totalCount       | number | 전체 조회 건수 |

**사용 예시**

```javascript
<script defer>

    mySDK.getGoodsSearch({
        searchType: 'GOODS_NAME',
        keyword: '상품명',
        page: 1,
        pageSize: 100,
        sort: '+GOODS_NO,-REGISTER_DATE'
    }, function(err, res) {
        console.log(err, res)
    });
</script>

# searchType : GOODS_NO, GOODS_NAME, GOODS_CODE, MAKER_NAME, ORIGIN_NAME, SEARCH_WORD
# sort : +GOODS_NAME,+GOODS_NO,+REGISTER_DATE,-GOODS_NAME,-GOODS_NO,-REGISTER_DATE
   ('+' : 오름차순, '-' : 내림차순)
```

#### <mark style="background-color:green;">**주문 상세 조회**</mark>

**제공 데이터**

| 필드명             | 데이터 형식 | 설명                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| --------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| orderDateTime   | string | 주문 날짜                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| receiver        | array  | 배송지 목록                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| zipcode         | string | 수령인 우편번호                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| addressDetail   | string | 수령인 상세 주소                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| address         | string | 수령인 주소                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| sno             | number | 배송지 일련 번호                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| name            | string | 수령인 이름                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| message         | string | 배송 메시지                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| cellPhone       | string | 수령인 휴대폰 번호                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| method          | string | <p><sub>결제 방법</sub><br><sub>EB: 에스크로 계좌이체, EC: 에스크로 신용카드, EV: 에스크로 가상계좌, FB: 간편결제 계좌이체, FC: 간편결제 신용카드, FH: 간편결제 휴대폰, FP: 간편결제 포인트, FV: 간편결제 가상계좌, FA: 간편결제 무통장입금, GB: 무통장 입금, PB: 계좌이체, PC: 신용카드, PH: 휴대폰, PV: 가상계좌, PK: 간편결제 카카오페이, PL: 간편결제 후불결제, PN: 간편결제 네이버페이, GD: 예치금, GM: 마일리지, GZ: 전액할인, GR: 기타</sub> </p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| settleAmount    | number | 실 결제 금액                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| channel         | string | <p><sub>주문 채널</sub><br><sub>SHOP: 쇼핑몰, NAVERPAY: 네이버페이, PAYCO: 페이코, ETC: 기타</sub></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| orderGoods      | array  | 주문 상품 목록                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| totalGoodsPrice | number | 총 상품 가격                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| quantity        | number | 상품 수량                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| sno             | number | 주문 상품 번호                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| receiverSno     | number | 배송지 일련 번호                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| goods           | array  | 상품 정보                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| sno             | number | 상품 번호                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| textOptions     | array  | 상품 텍스트 옵션 목록                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| price           | number | 텍스트 옵션 가격                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| title           | string | 텍스트 옵션 제목                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| value           | string | 텍스트 옵션 값                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| name            | string | 상품명                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| option          | array  | 상품 옵션                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| price           | number | 상품 가격                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| option 1\~5     | array  | 옵션 (1\~5)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| title           | string | 텍스트 옵션 값                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| value           | string | 상품명                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| optionPrice     | number | 옵션 가격                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| type            | string | <p>상품 유형<br><sup>GOODS: 상품, ADD\_GOODS: 추가상품</sup></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| status          | string | <p>상품 상태<br><sub>ORDER: 입금대기, PAYMENT: 결제완료, GOODS\_READY: 상품준비중, GOODS\_PLACEMENT: 구매발주, GOODS\_RECEIVED: 상품입고, GOODS\_SHIPPED: 상품출고, 
DELIVERY: 배송중</sub>, 
<sub>DELIVERY\_COMPLETE: 배송완료, 
SETTLE: 구매확정, 
BACK\_REQUEST: 반품접수, BACK\_IN\_TRANSIT: 반송중, BACK\_ON\_HOLD: 반품보류, BACK\_COMPLETE: 반품회수완료, REFUND\_REQUEST: 환불접수, REFUND\_ON\_HOLD: 환불보류, REFUND\_COMPLETE: 환불완료, EXCHANGE\_REQUEST: 교환접수, EXCHANGE\_IN\_TRANSIT: 반송중, EXCHANGE\_REDELIVERY: 재배송중, EXCHANGE\_ON\_HOLD: 교환보류, EXCHANGE\_COMPLETE: 교환완료, PAYMENT\_ATTEMPT: 결제시도, PAYMENT\_CUSTOMER\_ABORTED: 
고객결제중단, 
PAYMENT\_FAILED: 결제실패, CANCEL\_AUTO: 자동취소, CANCEL\_OUT\_OF\_STOCK: 품절취소, CANCEL\_ADMIN: 관리자취소, CANCEL\_CUSTOMER\_REQUEST: 고객취소요청, ADDITIONAL\_PAYMENT\_PENDING: 추가입금대기, ADDITIONAL\_PAYMENT\_COMPLETE: 
추가결제완료, ADDITIONAL\_DELIVERY\_IN\_PROGRESS: 추가배송중, ADDITIONAL\_DELIVERY\_COMPLETE: 
추가배송완료, ADDITIONAL\_EXCHANGE\_COMPLETE: 
교환추가완료</sub></p> |
| benefit         | array  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| sale            | array  | 할인                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| coupon          | number | 쿠폰 할인 금액                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| member          | number | 회원 할인 금액                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| deposit         | number | 예치금 할인 금액                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| goods           | number | 상품 할인 금액                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| mileage         | number | 마일리지 할인 금액                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| apiOrderNo      | string | API 주문 번호                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| sno             | string | 주문 번호                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| orderer         | array  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| zipcode         | string | 주문자 우편번호                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| addressDetail   | string | 주문자 상세주소                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| address         | string | 주문자 주소                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| name            | string | 주문자 이름                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| email           | string | 주문자 이메일                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| cellPhone       | string | 주문자 휴대폰 번호                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| shippingAmount  | number | 총 배송비                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| paymentDateTime | string | 결제 날짜                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| gifts           | array  | 사은품 목록                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| quantity        | number | 사은품 수량                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| name            | string | 사은품 이름                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |

**사용 예시**

```javascript
<script defer>

    mySDK.getOrders({

        orderNo: 2505121522000309
    }, function(err, res) {
        console.log(err, res)
    });


</script>
```

**샘플 구조**

```javascript
{
  "sno": "123456789",
  "apiOrderNo": "API123456789",
  "channel": "SHOP",
  "method": "GB",
  "orderGoods": [
    {
      "sno": 1,
      "type": "GOODS",
      "goods": {
        "sno": 101,
        "name": "테스트 상품",
        "option": {
          "option1": {
            "title": "색상",
            "value": "빨강"
          },
          "option2": {
            "title": "색상",
            "value": "빨강"
          },
          "option3": {
            "title": "색상",
            "value": "빨강"
          },
          "option4": {
            "title": "색상",
            "value": "빨강"
          },
          "option5": {
            "title": "색상",
            "value": "빨강"
          },
          "price": 1000,
          "optionPrice": 200
        },
        "textOptions": [
          {
            "title": "텍스트 옵션",
            "value": "옵션 값",
            "price": 500
          }
        ]
      },
      "quantity": 2,
      "totalGoodsPrice": 2000,
      "status": "DELIVERY_COMPLETE",
      "receiverSno": 10
    }
  ],
  "gifts": [
    {
      "name": "사은품",
      "quantity": 1
    }
  ],
  "benefit": {
    "sale": {
      "goods": 100,
      "member": 50,
      "coupon": 30,
      "mileage": 20,
      "deposit": 10
    }
  },
  "orderer": {
    "name": "홍길동",
    "zipcode": "12345",
    "address": "서울특별시 강남구 테헤란로",
    "addressDetail": "101호",
    "cellPhone": "010-1234-5678",
    "email": "test@example.com"
  },
  "receiver": [
    {
      "sno": 10,
      "name": "김철수",
      "zipcode": "54321",
      "address": "서울특별시 강남구 역삼로",
      "addressDetail": "202호",
      "cellPhone": "010-8765-4321",
      "message": "부재 시 경비실에 맡겨주세요."
    }
  ],
  "shippingAmount": 3000,
  "settleAmount": 5000,
  "orderDateTime": "2025-03-16 12:00:00",
  "paymentDateTime": "2025-03-16 12:05:00"
}
```