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 の場合、failedCount と failures で商品単位のエラーを確認します。

ショップごとに、同時に実行できるインポートジョブは一つだけです。