이 문서는 신규로 생성되는 OpenAPI에 대한 내용만 다루고있습니다.
이 문서는 품고와 연동하기 위한 다양한 기능적 방법과 리소스에 대한 설명을 제공합니다.
품고 API는 HTTPS를 통하여 제공되며, 응답값은 JSON을 활용합니다.
품고API의 호스트명 open.poomgo.com
1. 인증
일부 품고 API를 사용하기 위해서는 OpenAPI Key가 필요합니다. 키를 발급받기 위해서 아래 문서를 참고해주세요.
2. 유의 사항
2.1. 분당 호출 회수 제한
품고API는 1분당 호출회수가 최대 20회로 제한되어있습니다. 제한을 초과하게되는 경우 HTTP 429 Too Many Requests 응답을 받게되며, 이는 1분간 유지됩니다.
2.2. 일반적인 에러 형태 (4xx)
품고API 요청을 수행중 일반적인 에러가 발생했을 경우, 아래와 같은 형태를 따라 출력하게 됩니다.
{
"requestId": "6984126ca1f19eef65ecff485fff134d",
"code": "error-code",
"displayMessage": "에러에 대한 설명 메시지"
}
JavaScript
복사
3. 공통
3.1. 페이지네이션(Pagination)
일반적으로 품고 API는 아래와 같은 Pagination 규칙을 따르고 있습니다. (일부 API 제외)
{
"status": 200,
"page": 1,
"pageSize": 20,
"totalPages": 3,
"order": "DESC",
"rowCount": 20,
"total": 50,
"data": [ ...ActualData ]
}
JavaScript
복사
4. 송장 API
송장API는 출고된 송장에 대한 내역을 제공하는 API입니다.
HTTP 요청 | 인증 필요 여부 | 설명 | 지원버전 |
GET /tracking?numbers={number:csv} | 필요하지 않음 | 품고 추적번호를 통해, 물건의 현재 출고상태 또는 운송 진행 상태정보를 수신합니다. | v1 |
GET /invoice | 필요 | 품고를 통해 출고한 모든 운송장 정보를 검색 및 조회할 수 있습니다. | v2 |
