소개
Advanced Integrated Visibility 배송 조회 번호 수신 등록은 Advanced Integrated Visibility 수신 등록자가 배송 조회 번호 기반 웹훅 프로젝트를 관리하고 API 엔드포인트를 사용해 새 배송 조회 번호 추가, 작업 세부정보 편집, 보기 등의 프로젝트 관련 작업을 수행할 수 있도록 마련되었습니다.
참고:
- Advanced Integrated Visibility 프로젝트에 대한 Admin 또는 Contributor 액세스가 있어야 합니다
- Advanced Integrated Visibility와 그 기능에 관한 자세한 정보는 Advanced Integrated Visibility 문서 페이지를 참조하세요.
Advanced Integrated Visibility 배송 조회 번호 구독의 이점
Advanced Integrated Visibility 배송 조회 번호 구독의 이점은 다음과 같습니다.
- API 엔드포인트를 사용해 Advanced Integrated Visibility 프로젝트의 배송 조회 번호를 손쉽게 업데이트하고 관리할 수 있습니다.
- 이 API를 사용하면 각 배송 조회 번호를 하나씩 연결할 필요 없이 하나의 API 트랜잭션 내 프로젝트에 여러 배송 조회 번호를 연결할 수 있습니다.
- API 요청을 연속으로 제출하고 해당 요청의 성공/실패 로그 세부정보를 확인할 수 있습니다.
Advanced Integrated Visibility 배송 조회 번호 구독 활용 방법
아래 엔드포인트를 사용해 Advanced Integrated Visibility 프로젝트를 관리합니다.
이 API는 위 스크린샷에 설명된 것처럼 프로젝트 개요를 통해서만 액세스할 수 있습니다.
배송 조회 번호 연결
이 엔드포인트를 사용해 비동기식 작업을 트리거한 후 한 개 이상의 배송 조회 번호를 특정 Advanced Integrated Visibility 프로젝트에 연결할 수 있습니다.
이 요청에 필요한 입력 정보는 다음과 같습니다.
- 작업 – 요청 제출 시 수행할 작업을 지정합니다. 예: ADD
- 배송 조회 번호 세부정보 – 배송 조회 번호를 지정합니다
한 번 요청 시 최대 1,000개의 배송 조회 번호를 연결할 수 있습니다. 이 요청에 성공하면 응답에서 작업 ID, 현재 작업 상태, 작업 생성 및 작업 완료 타임스탬프가 반환됩니다. 이 작업 ID는 나중에 비동기식 작업의 상태를 확인하는 데 사용할 수 있습니다.
배송 조회 번호 작업 상태
이 엔드포인트를 사용해 비동기식 작업(대기열에 있는 한 개 이상의 연속 요청)의 상태 또는 제출된 모든 작업의 상태를 가져올 수 있습니다.
이 요청에 필요한 입력 정보는 다음과 같습니다.
- 작업 ID – 상태를 가져올 작업 ID를 지정합니다.
참고: 작업 ID는 이 엔드포인트의 선택 입력 항목입니다. 작업 ID를 지정하지 않으면 제출된 모든 작업의 상태를 가져옵니다.
이 요청에 성공하면 응답에서 작업 ID, 현재 작업 상태, 작업 생성 및 작업 완료 타임스탬프가 반환됩니다. 응답에는 작업의 현재 상태가 표시됩니다. 또한 성공 메시지, 오류 또는 경고도 표시되어 문제가 발생한 경우 사용자가 확인하고 해결할 수 있습니다.
- 작업 상태가 완료됨으로 표시되면 모든 배송 조회 번호가 검증되었으며 성공적으로 처리되었다는 의미입니다.
- 완료됨 상태는 배송 조회 번호가 검증되고 처리되었음을 의미합니다. 모든 배송 조회 번호가 Advanced Integrated Visibility 프로젝트에 추가되었다는 의미는 아닙니다.
- 여러 배송 조회 번호 연결을 시도한 후 일부만 연결되고 나머지는 연결에 실패한 경우에도 작업 상태는 완료됨으로 업데이트됩니다. 연결 요청 내 각 배송 조회 번호의 상태를 확인하려면 일괄 보고서를 다운로드해야 합니다.
- 작업 상태가 실패로 표시되면 여러 사유/심각한 오류로 인해 요청을 처리하지 못했다는 의미이며, 사용자는 다시 시도해야 합니다.
참고:
상태 유형과 각 설명은 다음과 같습니다.
| 작업 상태 | 설명 |
|---|---|
제출됨 |
모든 기본적인 유효성 검사를 진행한 후 작업이 시스템에 제출되었으며, 비동기식으로 처리됩니다. |
수락됨 |
작업이 수락되었으며 대기열에 올라갑니다. |
수락 불가 |
내부 오류 또는 시스템 장애로 인해 작업이 수락되지 않았으며, 사용자는 다시 시도해야 합니다. |
대기 중 |
작업이 처리 대기 중이며, 곧 프로세스가 시작됩니다. |
진행 중 |
작업이 시작되었으며 진행 중인 상태입니다. |
완료됨 |
작업이 완료되었으며 사용자가 보고서 가져오기 또는 파일 내보내기를 사용할 수 있습니다. |
실패 |
여러 사유로 인해 작업이 실패했으며 사용자는 다시 시도해야 합니다. |
배송 조회 번호 작업 세부정보
이 엔드포인트를 사용해 완료됨 상태인 비동기식 작업의 JSON 보고서를 다운로드할 수 있습니다.
이 요청과 관련된 필수 입력 정보는 다음과 같습니다.
- 작업 ID – 상태를 가져올 작업 ID를 지정합니다.
참고:
- 작업 ID는 이 엔드포인트의 필수 입력 항목입니다.
- 한 번에 비동기식 작업 한 개의 보고서만 다운로드할 수 있습니다.
- 작업이 완료되지 않은 상태에서 보고서를 다운로드하면 오류 메시지가 표시됩니다.
이 요청에 성공하면 응답에서 JSON 형식의 작업 보고서가 제공됩니다.
비즈니스 규칙
- 각 요청의 한 Advanced Integrated Visibility 프로젝트에 최대 1,000개의 발송 배송 조회 번호를 연결할 수 있습니다.
- 제공된 Advanced Integrated Visibility 프로젝트에 연결 가능한 배송 조회 번호 수에 대한 제한은 없습니다.
- 연결된 배송 조회 번호는 제공된 Advanced Integrated Visibility 프로젝트로부터 40일 후 분리됩니다.
- 생성된 작업 ID 상태 및 세부정보는 90일이 지나면 제공된 Advanced Integrated Visibility 프로젝트에서 이용할 수 없습니다.
- 수취인 주소, 수취인 서명 등 보호된 배송 조회 정보는 Advanced Integrated Visibility 배송 조회 번호 구독을 통해 이용할 수 없습니다.
Response