COMMERCE_SERP に site zalando を指定すると検索結果の商品をストアの順に受け取り、COMMERCE_PRODUCT に商品の url を渡すとその商品を 1 つ読み取ります。完了した検索または商品ページ 1 件につき 0.5 クレジットです。
検索
GET /v1/async/task/{id} をポーリングするか Webhook で受け取ります。非同期タスクを参照してください。
パラメータ
site: 必須。zalandoです。query: 必須。検索語で、1-500 文字です。limit: 任意の整数、1-40。デフォルトは 20 です。country: 任意。デフォルトはストアの国のDEです。ほかの国は422 REGION_UNSUPPORTEDで拒否されます。
include は省略してください。include: {} でも、クレジットを確保する前に payload.include の 422 VALIDATION_ERROR を返します。
レスポンス例
結果フィールド
site、query、countryはリクエストの値です。returnedCountはproductsの件数です。- 各商品は
rank、productId、title、urlを含みます。productIdはストア独自の商品 ID です。rankはストアのデフォルトの並び順で、ストアが広告と表示した商品は除きます。 price、imageUrl、brandは、検索結果の画面に表示されている場合に含みます。priceは商品ごとのcurrency(ISO 4217)の数値で、容量ごとに価格が異なる場合は最も低い価格です。- Zalando は評価とレビュー数を表示しません。
- 検索ごとに、ストアの検索結果の 1 ページ目から商品を取得します。このページには最大 24 件の商品が表示されます。
商品ページ
パラメータ
url: 必須。Zalando の商品ページで、2,048 文字以内です。形式はzalando.de/{name}-{sku}.htmlです。検索結果の商品urlはそのまま渡せます。トラッキングコードなど結果に影響しないパラメータは読み取り前に取り除きます。country: 任意。デフォルトはページの国のDEです。ほかの国は422 REGION_UNSUPPORTEDで拒否されます。
include は省略してください。include: {} でも、クレジットを確保する前に payload.include の 422 VALIDATION_ERROR を返します。
レスポンス例
結果フィールド
site、country、url、productIdでページを識別します。urlは読み取ったページで、productIdは検索結果の ID と同じです。titleは常に含みます。brand、price、currency、inStock、images、description、options、categoriesは、ページに表示されている場合に含みます。priceは、クーポンと送料を適用する前にページが最初に表示する購入価格で、currency(ISO 4217)の値です。inStockは在庫の有無です。imagesは商品ギャラリーの写真を、ページの順に最大 30 枚含みます。descriptionは段落ごとに 1 行のプレーンテキストで、最大 10,000 文字です。画像の中にしかない文字は含みません。descriptionは、ストアが検索エンジン向けに公開している短い要約です。optionsはサイズや色などの選択肢を最大 20 個、選択肢ごとにvaluesを最大 100 個含みます。ほかのフィールドは、ページが最初に選択している選択肢のものです。categoriesは最も広いカテゴリから最も狭いカテゴリまでの、最大 10 階層です。
エラーと課金
- 商品が 1 つもない検索は、失敗したタスクとして終了します。
- ストアが 404 または 410 で応答する商品ページ(削除された商品など)は
PAGE_UNAVAILABLEで終了し、メッセージにストアの応答が入ります。ストアが 403、412、429、435 で読み取りを拒否した場合、タスクは待機して最大 6 分間再試行します。ほかの読み取り失敗と、それより長く続く拒否はENGINE_NO_RESULTで終了します。 - 課金は完了したタスクだけで、検索または商品ページ 1 件につき 0.5 クレジットです。