パートナーAPI
ガイド

APIを使用してカタログの製品詳細を管理する

小売業者は、さまざまなAPIエンドポイントを使用してカタログの商品詳細を管理できます。これらのAPIを使用すると、次のことができます。

  • 商品在庫を更新する
  • カタログから商品を削除する
  • 商品に関する詳細情報を取得する

商品在庫の更新

商品在庫を更新するには、商品をCitrusAdと再同期し、在庫をゼロに設定します。小売業者は通常、次のような変更を反映するためにこれらの更新を毎日実行します。

  • 商品名の更新。
  • 在庫状況。商品の在庫がゼロに設定されている場合、その商品は売り切れていることを示します。ただし、新しい在庫が翌日に到着する場合があります。

リクエスト指標

クエリと本文のパラメータは次のとおりです。

クエリパラメータ

対象type説明
teamId文字列、任意チームのID。もし teamId が指定されていない場合は、認証で指定された teamId がデフォルトになります。

本文パラメータ

対象type説明
catalogId文字列、必須商品が属するカタログの識別子。catalogIDは、EpsilonのRetail Media UIまたは小売業者から取得できます。
gtin文字列、必須商品のGTIN（Global Trade Item Number）。
inventory数字、任意商品の在庫数。
price数字、任意商品の価格。
categoryHierarchy文字列の配列、任意商品が属するカテゴリーの階層。
tags文字列の配列、任意製品に関連付けられたタグ。
filters文字列の配列、任意商品に適用されたフィルター。
POST $BASE_URL/v1/catalog-products?teamId=<YOUR_TEAM_ID> HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "catalogProducts": [
        {
            "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
            "gtin": "23556578965543",
            "inventory": 0,
            "price": "19.99",
            "tags": [
                 "imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL"
            ],
            "filters": [
                 "category:Health&Beauty","category:Grocery","Brand:Covergirl","Special_Flag:0"
            ]
        }
    ]
}

カタログから商品を削除する

商品をカタログに追加した後で、削除が必要となる場合があります。商品を削除するには、以下の手順に沿って操作します。

リクエスト指標

エンドポイントはリクエストごとに1つの商品コード（通常はGTIN ID）を受け入れます。商品を削除するには、次のようにDELETE HTTPリクエストを作成します。

DELETE $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>

処理時間

商品の削除プロセスには30分から1時間ほどかかります。

📘

重要

商品が在庫切れの場合は、削除するのではなく、在庫を0に設定します。商品を削除すると、在庫が戻っても、広告主はCitrusAdプラットフォームでその商品を選択できなくなります。

エラー処理

商品が見つからない場合は、その商品がCitrusAdシステムに取り込まれていない可能性があります。

商品の詳細を取得する

カタログ内の商品の現在の情報を後で取得する必要がある場合があります。これを行うには、次のようにGET HTTPリクエストを送信します。

GET $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
対象type説明
catalogId文字列、必須商品が属するカタログの識別子。catalogIDは、EpsilonのRetail Media UIまたは小売業者から取得できます。
Product code文字列、必須これは通常、商品のGTIN（Global Trade Item Number）です。

これで、CitrusAdのシステムにある、指定された商品コードに対応した商品の最新情報が表示されます。

📘

注意事項

商品の更新は、CitrusAdのシステムでは即座に処理されません。CitrusAdが更新を完全に取り込み、反映するまでには、しばらく時間がかかる場合があります。商品情報が取得時にすぐに更新されなくても心配しないでください。

更新： 4か月前