후불매장 추가주문에 대한 웹훅

[boime]

어떤 제품을 사용하나요?

• 제품: Open API
• SDK 또는 API 버전: Open API v1
• 환경: aws linux / aws linux

무엇이 궁금한가요?

OpenAPI를 사용하여 연동할 때, 후불매장의 추가 주문(기존 orderId)에 대한 웹훅은 따로 지원하지 않나요?
아니면 기존 웹훅을 활용하는 건가요?
테스트 상으로는 추가주문 시 이벤트가 전달되지 않습니다.
사용중인 이벤트는 다음과 같이 9종입니다.
order.order.created.v1
order.order.requested.v1
order.order.accepted.v1
order.order.opened.v1
order.order.completed.v1
order.order.cancelled.v1
order.order.declined.v1
order.order.expired.v1
order.call.created.v1

[토스플레이스-개발자센터]

안녕하세요. 토스플레이스 개발자센터입니다.

추가 주문 전용 웹훅 이벤트는 제공하지 않습니다.

후불 주문의 정상 흐름에서 발생하는 웹훅 이벤트는 order.order.opened.v1(주문 시작됨)과 order.order.completed.v1(주문 완료됨) 두 가지이며, 추가 주문에 대응하는 별도 이벤트는 정의되어 있지 않습니다.

lineItems 갱신 구조

추가 주문은 별도 주문으로 생성되는 것이 아니라, 동일한 order.id 내에서 lineItems가 갱신되는 구조입니다. 주문 조회 API는 조회 시점의 전체 lineItems를 반환하므로, 추가 주문 후 같은 orderId로 조회하시면 변경된 내역 전체를 확인하실 수 있습니다.

lineItems 변경 방법

주문 내역을 변경하실 때는 update-line-items API(PUT)를 사용해 주세요. 이 API는 기존 내역을 전부 취소하고 새 내역으로 전체 교체하는 방식입니다. 추가 주문을 반영하실 때는 기존 내역과 추가 내역을 합산한 전체 lineItems와 재계산한 chargePrice를 함께 전달해 주세요. 이 변경에 대응하는 웹훅 이벤트는 별도로 발생하지 않으며, 변경 결과는 주문 조회 API로 확인하실 수 있습니다.

[boime]

@토스플레이스-개발자센터
후불 매장에서 발생하는 추가 주문 확인은 실시간이 안되고 폴링을 해야 한다는 얘기네요?

[토스플레이스-개발자센터]

안녕하세요. 토스플레이스 개발자센터입니다.

네, 현재 Open API로 후불 매장의 추가 주문을 계속 확인하시려면 주문 조회 API를 주기적으로 호출하는 방식(폴링)이 필요합니다. 동일한 orderId에 상품이 추가되는 시점의 별도 웹훅은 제공하지 않습니다.

• 주문 조회 API로 해당 orderId의 lineItems를 조회하고, 이전 조회 결과와 비교해 변경 내역을 확인해 주세요.
• 조회 주기는 API 호출량 제한을 고려해 조정해 주세요.

앞서 안내 드린 update-line-items는 주문을 변경하는 API이므로, 추가 주문 내역을 확인하기 위해 호출하실 필요는 없습니다.

추가 주문 웹훅과 조회 방식에 대한 이전 답변도 함께 참고해 주세요.