스템프 수정
생성된 스템프 정보를 수정하는 API입니다.
고객의 적립 도장 수(stamps), 혜택 사용 여부(useYn), PIN 초기화(resetPinYn) 등의 정보를 변경할 수 있습니다.
이 API는 퍼스널 요금제 이상에서만 제공됩니다.
PUT
/api/stamp/v1/update
{
"stampIdx": 1457,
"cardIdx": 172,
"stamps": 7,
"resetPinYn": "Y",
"userEml": "example@gmail.com"
}Request Parameters
- stampIdxintegerrequired
- 스템프 IDX.
- cardIdxinteger
- 카드 IDX. 카드 IDX는 대시보드의 “스템프 카드” 페이지에서 확인할 수 있습니다.
- stampsinteger
- 스템프에 적립된 도장 개수를 지정합니다.
현재 고객이 모은 도장의 총 개수를 나타냅니다. 값을 변경하면 스템프 적립 현황이 갱신되며, 증가·감소 모두 가능합니다.
모든 도장을 채운 경우(stamps= 카드에 설정된 최대 도장 수)에는useYn을Y로 변경하여 혜택 사용 상태로 처리해야 합니다. - resetPinYnstring
- Default:N
- Enum:YN
- 스템프를 사용하는 고객의 PIN 번호를 초기화할지 여부를 지정합니다.
Y: 고객이 설정한 PIN 번호를 초기화합니다. 초기화 후, 고객은 스템프 페이지 접속 시 새 PIN 번호를 다시 설정해야 합니다.
N: 기존 PIN 번호를 유지합니다. - useYnstring
- Default:N
- Enum:YN
- 스템프의 혜택 사용 여부를 지정합니다.
Y: 고객이 모든 도장을 채우고 혜택(예: 무료 음료, 할인 등)을 사용한 상태입니다. 혜택 사용 후에는 해당 스템프가 비활성화되며, 새 스템프를 발급해야 합니다.
N: 아직 혜택을 사용하지 않은 상태입니다. - domainstring
- Default:https://vvd.bz
- 스템프 도메인. 값이 비어있으면 기본 도메인으로 저장됩니다.
프리미엄 요금제 이상에서는, 링크 도메인 관리에서 등록한 커스텀 도메인을 지정할 수 있습니다. - strtYmddate
- 스템프 유효 시작일. 예: 2025-01-01
- endYmddate
- 스템프 유효 만료일. 예: 2025-12-31
만료일은 오늘로 부터 최대 5년까지 설정할 수 있습니다. - activeYnstring
- Default:Y
- Enum:YN
- 스템프 활성화 여부. 비활성화되면 고객이 스템프를 사용할 수 없습니다.
- memostring
- 내부 참고용 메모.
- userIdstring
- 사용자 ID. 스템프 발급 대상자를 관리하는데 사용됩니다.
일반적으로 웹사이트 회원의 로그인 ID를 입력합니다.
설정되지 않으면 시스템에 의해 자동으로 사용자 ID가 생성됩니다. - userNmstring
- 사용자 이름. 내부 관리용.
- userPhnnostring
- 사용자 연락처. 내부 관리용.
- userEmlstring
- 사용자 이메일. 내부 관리용.
- userEtc1string
- 추가 내부 관리용 필드.
- userEtc2string
- 추가 내부 관리용 필드.
{
"code": 0,
"message": "",
"result": null
}Response Parameters
- codeinteger
- 응답 코드: 0 = 성공, 그 외 값 = 오류
- messagestring
- 응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
- resultnull