APIを介したカタログの同期

製品を同期するには、プッシュする catalogId が必要です。ほとんどの統合では、テクニカルアカウントマネージャーがこれを作成します。カタログが作成され次第、テクニカルアカウントマネージャーは、これをCitrusAdポータルに表示されるようにします。

カタログ作成のコンテキスト

以下は、カタログを作成するためのコンテキストの例です。

POST $BASE_URL/v1/catalogs HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "catalogs": [
        {
            "name": "Retailer A"
        }
    ]
}

成功すると、以下のオブジェクトが返されます。

{
    "catalogs": [
        {
            "teamId": "9f48572c-0a5b-4997-9a0e-ed74f4d32dc6",
            "name": "Retailer A",
            "id": "216af452-d219-4807-b8ca-578bba446541"
        }
    ]
}

❗️

オブジェクトが正常に返されると、新しいカタログの id を受け取ります。同じリクエストを再度送信すると、新しい idが発行され、2つのカタログが作成されます。

📘

製品の同期に、この id が必要になります。

複数のカタログを作成する

複数のカタログを作成する場合、1回のリクエストで100個まで配列できます。以下は、2つのカタログを作成するためのコンテキストの例です。

POST $BASE_URL/v1/catalogs HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "catalogs": [
        {
            "name": "Retailer A"
        },
        {
            "name": "Retailer B"
        }
    ]
}

成功すると、以下のオブジェクトが返されます(各カタログにはそれぞれ個別の idがあります)。

{
    "catalogs": [
        {
            "teamId": "9f48572c-0a5b-4997-9a0e-ed74f4d32dc6",
            "name": "Retailer A",
            "id": "216af452-d219-4807-b8ca-578bba446541"
        },
        {
            "teamId": "9f48572c-0a5b-4997-9a0e-ed74f4d32dc6",
            "name": "Retailer B",
            "id": "75047339-65f5-41b8-8f2c-e76b04716cd4"
        }
    ]
}

🚧

カタログは、一度作成されるとデフォルトで非表示になります。ネームスペースでカタログを閲覧できるようにしたい場合は、テクニカルアカウントマネージャーにお問い合わせください。