Tracking API
택배사 목록을 조회하고 운송장 정보를 조회하는 API 들에 대해 다룹니다.
페이지네이션과 관련된 자세한 내용은 Pagination 문서를 참고해주세요.
Query.carriers (택배사 목록 조회)
기본
Query.carriers 를 사용하여 택배사 목록을 조회할 수 있습니다.
아래는 사용할 수 있는 택배사를 10개 가져오는 예시 입니다. 페이지네이션과 관련된 내용은 Pagination 문서를 참고해주세요.
국가 지정
Query.carriers의 countryCode에 선호 국가를 지정하여 택배사 정렬 순서에 힌트(선호도)를 제공할 수 있습니다.
현재 countryCode 지정은 가능하나 결과에는 반영되지 않으며 GA 릴리즈 이후 부터 반영이 예정되어 있습니 다.
텍스트로 택배사 검색
Query.carriers의 searchText를 사용하여 원하는 택배사를 검색할 수 있습니다.
입력된 Text를 기반으로 사용자가 원하는 택배사를 유추하여 가능성이 높은 택배사 목록을 제공 합니다.
운송업체 추가 요청
Delivery Tracker 가 제공하지 않는 운송업체 추가가 필요한 경우 이곳 을 참고 해주세요.
Query.track (운송장 정보 조회)
Query.track를 사용하여 택배사 ID 와 운송장 번호를 통해 운송장 정보를 조회할 수 있습니다.
변경 사항을 추적하기 위해 Track API 를 주기적으로 Polling 하는 방법은 권장하지 않습니다. 변경 사항 추적이 필요한 경우 Tracking Webhook API 를 사용하시기 바랍니다.
권장 Timeout 은 최대 15 초 입니다.
마지막 정보 조회하기
딜리 버리 트래커를 사용하는 많은 사용자들이 배송 완료 여부를 판단하기 위해 마지막 상태 조회를 필요로 합니다. 딜리버리 트래커에서는 TrackInfo.lastEvent 를 통해 마지막 이벤트만을 조회할 수 있습니다.
다양한 정보 조회하기
아래 예시는 특정 운송장 번호의 최근 이벤트 10개를 조회하는 예시를 보여주고 있습니다. 10개 이상의 이벤트가 필요한 경우 Pagination 을 통해 더 많은 이벤트를 조회할 수 있습니다.
이외에도 TrackInfo에는 발송자 정보 등의 문서에 언급되지 않은 다양한 정보들을 포함하고 있으며, 자세한 내용은 TrackInfo를 참고해주세요.