Ideal House
콘텐츠로 이동

Ideal House Product Import API#

Product Import API를 사용하여 Ideal House 카탈로그의 상품을 가져오고, 목록을 조회하고, 논리적으로 삭제하세요. 일괄 가져오기는 상품 1~500개를 받아 비동기로 처리합니다. 목록 조회 및 삭제 작업은 동기로 처리합니다.

기본 URL#

text
https://sdkapi.ideal.house

모든 요청에 HTTPS를 사용하세요. JSON 요청 및 응답 본문은 UTF-8로 인코딩됩니다.

시작하기 전에#

Ideal House는 초기 설정 과정에서 다음 값을 제공합니다.

  • Shop ID
  • Client ID
  • Client Secret

Client ID와 Client Secret은 서버 측 인증 정보입니다. Client Secret을 브라우저 코드, 모바일 애플리케이션, 공개 저장소, 로그 또는 다른 클라이언트 측 환경에 노출하지 마세요.

인증#

모든 요청에 다음 헤더를 포함하세요.

http
X-Client-Id: <YOUR_CLIENT_ID>
X-Client-Secret: <YOUR_CLIENT_SECRET>

JSON 본문이 있는 요청에는 다음도 포함하세요.

http
Content-Type: application/json

요청의 shopId는 인증 정보에 연결된 스토어와 일치해야 합니다. 일치하지 않으면 403 Forbidden을 반환합니다.

API 요약#

메서드경로목적
POST/product-import/products비동기 상품 가져오기 배치 제출.
GET/product-import/products/status현재 또는 가장 최근 가져오기 작업 조회.
GET/product-import/products스토어의 현재 상품 목록 조회.
DELETE/product-import/products상품 ID 또는 SKU로 상품 하나를 논리적으로 삭제.

일괄 가져오기 흐름#

  1. POST /product-import/products로 상품 배치를 제출하세요.
  2. 202 Accepted 응답에서 반환된 jobId를 저장하세요.
  3. GET /product-import/products/status를 2~5초마다 폴링하세요.
  4. 상태가 completed 또는 failed가 되면 폴링을 중단하세요.
  5. 작업이 completed이면 failedCountfailures에서 항목별 오류를 확인하세요.

스토어별로 한 번에 하나의 가져오기 작업만 활성 상태일 수 있습니다.