글로벌 오더
SDK 연동하기
글로벌 오더 통합형 JavaScript SDK는 브라우저 환경에서 글로벌 오더를 새 탭 또는 iframe으로 열 수 있는 메서드를 제공합니다. SDK 사용을 위한 준비와 메서드 사용법을 알아봅니다.
1. SDK 설치
SDK를 사용하기 위해 다음 스크립트를 HTML의 <head>
태그 내에 추가해주세요.
2. 메서드
글로벌 오더 통합형 SDK에서 제공하는 주요 메서드입니다.
orderInNewTab(products)
새로운 탭에서 글로벌 체크아웃을 호출하는 메서드입니다. products
파라미터에 주문 정보를 전달합니다.
- 파라미터
products
(타입:CartProduct[]
): 주문 정보 배열입니다.(상세 타입은 아래 ‘3. 주문 상품 정보 연동’ 참고)
- 리턴 타입
Promise<void>
: 주문 프로세스가 성공적으로 완료되면 resolve됩니다. 실패 시 에러가 reject됩니다.
Promise 사용
async/await 사용
orderInIframe(request)
iframe을 사용하여 글로벌 체크아웃을 호출하는 메서드입니다. request
파라미터는 주문 정보와 부모 URL을 포함합니다.
- 파라미터
request
(타입:IframeCartProductRequest
): 주문 정보와 부모 페이지 URL을 포함하는 객체입니다. (상세 타입은 아래 ‘3. 주문 상품 정보 연동’ 참고)
- 리턴 타입
Promise<string>
: iframe 로드에 사용할 URL을 반환합니다. 실패 시 에러가 reject됩니다.
Promise 사용
iframe을 로드할 부모 페이지의 URL
async/await 사용
iframe을 로드할 부모 페이지의 URL
iframe을 노출할 페이지의 코드
3. 주문 상품 정보 연동
Parameter 상세 설명
orderInIframe
메서드 요청 시 사용되는 데이터 구조
개별 장바구니 상품 정보 (orderInNewTab
의 products
배열 요소, IframeCartProductRequest
의 products
배열 요소)
상품 정보
선택된 옵션 정보
통화별 가격 정보
Example 1: 옵션이 있고, 할인율이 적용된 상품 (KRW 사용)
Example 2: 옵션이 없고, 할인율이 적용되지 않은 상품 (KRW 사용)
Example 3: 조합형 옵션 상품 (USD 사용)
4. 주의 사항
-
sellerClientKey
의 사용sellerClientKey
는 딜리버드 파트너스에서 제공한 판매자 고유값입니다.- 모든
ProductRequest
객체에는 반드시sellerClientKey
가 포함되어야 합니다.
-
options
와selectedOptions
의 사용selectedOptions
의title
은 반드시productRequest
의options
중 동일한title
이 존재해야 합니다.- 상품에 옵션이 없는 경우에도
productRequest
의options
배열은 길이가 1 이상이어야 합니다. 빈 옵션을 추가하고,selectedOptions
에도title
와quantity
를 포함하여 전달해야 합니다.
-
할인 가격 설정 (
discountRate
,originalPrices
)discountRate
가 0보다 크다면, 할인 전 가격인originalPrices
필드는 필수적으로 포함되어야 합니다.discountRate
가 0이라면,originalPrices
는 선택 사항이며, 값을 전달해도 할인 계산에 사용되지 않습니다.
-
통화 사용 설정 (
PricesByCurrency
)prices
및originalPrices
(해당하는 경우),OptionRequest
의prices
필드에는PricesByCurrency
타입 객체를 사용합니다.- 기본 통화는 KRW입니다. KRW 가격(
krw
)은 항상 필수입니다. - 화폐 단위를 USD를 사용하는 판매자의 경우,
usd
값을 포함해야 합니다. (krw
값도 필수) - 쇼핑몰의 기본 화폐 단위를 KRW가 아닌 USD로 사용하고 싶으신 경우, 딜리버드 파트너스 문의하기를 통해 별도 문의가 필요합니다.