파트너 API
가이드

API를 사용하여 카탈로그에서 제품 세부 정보 관리하기

소매업체는 여러 API 엔드포인트를 사용하여 카탈로그의 제품 세부 정보를 관리할 수 있습니다. 이러한 API를 통해 다음을 수행할 수 있습니다.

  • 제품 재고 업데이트
  • 카탈로그에서 제품 삭제
  • 제품에 대한 자세한 정보 검색

제품 재고 업데이트

제품의 재고를 업데이트하려면 제품을 CitrusAd와 다시 동기화하고 재고를 0으로 설정합니다. 소매업체는 일반적으로 다음과 같은 변경 사항을 반영하기 위해 매일 이러한 업데이트를 수행합니다.

  • 제품 이름 업데이트
  • 재고 상태: 제품의 재고가 0으로 설정되어 있으면 제품이 품절되었음을 나타내는 것이며 다음 날 새로운 재고가 도착할 수 있습니다.

요청 매개 변수

다음은 쿼리 및 본문 매개 변수입니다.

쿼리 매개 변수

개체유형설명
팀 ID문자열, 선택 사항팀 ID입니다 . teamId 가 제공되지 않은 경우 인증에 지정된 teamId 로 기본값이 설정됩니다.

본문 매개 변수

개체유형설명
카탈로그 ID문자열, 필수 항목제품이 속한 카탈로그의 식별자입니다. Epsilon의 소매 미디어 UI 또는 소매업체에서 CatalogID를 확인할 수 있습니다.
gtin문자열, 필수 항목제품의 글로벌 거래 제품 번호(GTIN)입니다.
재고숫자, 선택 사항제품의 재고 수입니다.
가격숫자, 선택 사항제품의 가격입니다.
categoryHierarchy문자열 배열, 선택 사항제품이 속한 카테고리의 계층입니다.
태그문자열 배열, 선택 사항제품과 관련된 태그입니다.
필터문자열 배열, 선택 사항제품에 적용된 필터입니다.
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"
            ]
        }
    ]
}

카탈로그에서 제품 삭제

카탈로그에 올라가 있는 제품을 삭제해야 하는 경우가 있습니다. 제품을 삭제하려면 아래 단계를 따르세요.

요청 매개 변수

엔드포인트는 요청당 하나의 제품 코드를 허용하며 이 코드는 일반적으로 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>
개체유형설명
카탈로그 ID문자열, 필수 항목제품이 속한 카탈로그의 식별자입니다. Epsilon의 소매 미디어 UI 또는 소매업체에서 CatalogID를 확인할 수 있습니다.
제품 코드문자열, 필수 항목일반적으로 제품의 글로벌 거래 제품 번호(GTIN)입니다.

지정된 제품 코드에 대한 CitrusAd 시스템에서 수집한 현재의 정보를 수신해야 합니다.

📘

참고

CitrusAd 시스템에서는 제품 업데이트가 즉시 처리되지 않습니다. CitrusAd가 업데이트를 완전히 수집하고 반영하는 데 다소 시간이 소요될 수 있습니다. 검색 시 제품 정보가 즉시 업데이트되지 않더라도 걱정하지 마십시오.

업데이트됨 4개월 전