User Coupon Update Callback

타겟 서비스를 사용할 때 쇼핑몰 측에서 특정 조건의 쿠폰 정보만 업데이트 하는 방법을 제공합니다.

User Coupon Update Callback Spec

User Coupon Update Callback에는 두 가지 종류가 있습니다.

1. 만료일 기준 동기화: 기한만료 쿠폰 알림 캠페인을 사용하려면 꼭 구현되어야 합니다.
2. 특정 회원 기준 동기화: 타겟 발송시 쿠폰 정보를 활용하려면 꼭 구현되어야 합니다.

만료일 기준 동기화

만료일 기준 User Coupon Update Callback을 사용하려면 쇼핑몰 측에서 아래의 조건을 만족하는 API를 구현해야 합니다.

1. API를 호출하면 UserCoupon API을 이용하여 expires_after일 후에 만료되는 쿠폰의 정보를 크리마 측에 업데이트 해줍니다.
2. 업데이트에 성공한 쿠폰들의 code를 updated_coupon_codes에 담아서 반환합니다.
3. Callback URL을 소통하시는 API개발 담당자분에게 메일로 전달해주시면, 내부에서 등록을 해드립니다. 이후 담당자와 소통하여 검수를 진행하면 됩니다.

API Parameters(JSON)

POST shop_api_url HTTP/1.1

{
  "expires_after": 3
}

Response

HTTP/1.1 200 OK

{
  "updated_coupon_codes": ["test_id1_coupon1", "test_id1_coupon2", "test_id2_coupon1"]
}

특정 회원 기준 동기화

특정 회원 기준 User Coupon Update Callback을 사용하려면 쇼핑몰 측에서 아래의 조건을 만족하는 API를 구현해야 합니다.

1. API를 호출하면 UserCoupon API을 이용하여 user_codes의 아이디에 해당하는 고객이 현재 가지고 있는 사용 가능한 쿠폰 정보를 크리마 측에 업데이트 해줍니다.
2. 업데이트에 성공한 쿠폰들의 code를 updated_coupon_codes에 담아서 반환합니다.
3. Callback URL을 소통하시는 API개발 담당자분에게 메일로 전달해주시면, 내부에서 등록을 해드립니다. 이후 담당자와 소통하여 검수를 진행하면 됩니다.

API Parameters(JSON)

POST shop_api_url HTTP/1.1

{
  "user_codes": ["test_id1", "test_id2", "test_id3"]
}

Response

HTTP/1.1 200 OK

{
  "updated_coupon_codes": ["test_id1_coupon1", "test_id1_coupon2", "test_id2_coupon1"]
}