응답 코드 및 에러 코드 – Kakao Shopping Open API

참고 사항

API 조회 결과 성공 시에는 Http 상태코드가 200입니다.
응답바디는 각 API 에서 정의된 데이터 타입에 맞는 json 형식을 참고하면 됩니다.

실패의 경우 200을 제외한 Http 상태코드로 내려가며,
에러의 상세 내용을 공통 ErrorMessage 형식으로 반환됩니다.

에러 code는 -800 인 경우에 extras 필드가 존재하며, 카카오 쇼핑 서버에서 발생되는 경우입니다.
요청 바디 또는 파라미터가 있는 API는 요청 내용에 대한 Validation 이 실패한 경우에
공통으로 Http 상태코드 400이 반환되고, 에러 응답바디에 validation 실패 결과가 포함됩니다.

1) HTTP 상태 코드

상태코드	설명	비고
200	성공	API별로 정상 처리 결과는 응답바디를 참조하면 됩니다.
400	실패	잘못된 요청 오류. 주로 API에 필요한 필수 파라미터와 관련된 오류입니다.
401	실패	인증 오류.
403	실패	권한/퍼미션 오류
500	실패	시스템 오류
502	실패	시스템 오류
503	실패	서비스 점검중

2) ErrorMessage 타입

필드명	타입	필수여부	설명
code	Integer	필수	-800이 아닌경우는 카카오 플랫폼 서비스에서 제공하는 에러코드 참조하세요.
msg	String	필수	에러 msg 값의 경우 의미가 바뀌지 않는 범위에서 내용이 바뀔 수 있습니다.
extras	ExtraErrorMessage	선택	-800 인 경우 카카오 쇼핑 서버에서 발생하는 에러정보가 실립니다.

3) ExtraErrorMessage 타입

필드명	타입	필수여부	설명
error_code	Integer	필수	에러코드
error_message	String	필수	에러 메시지
validation	Map<String,Array	선택	key는 validation 에러가 발생한 요청필드명이고, value는 에러 메시지의 Array입니다.

4) 카카오쇼핑 에러 코드 (error_code)

호출 실패 시 HTTP 상태 코드 외에 JSON 형식의 에러 코드 및 원인을 메시지로 받을 수 있습니다.
에러 코드는 모두 음수로 표현됩니다.

error_code	설명	HTTP 상태코드
-10000	일시적인 장애입니다.	500
-10001	요청에 대한 validation 에러입니다.	400
-10002	잘못된 요청입니다.	400
-10003	사용자의 접근이 허용되지 않습니다.	400
-10004	존재하지 않는 리소스입니다.	400
-10006	일시적인 장애입니다.	503
-10007	지원하지 않는 버전입니다.	400
-10008	내부 점검 중입니다.	503
-11000	호출 API 에 따라 에러메시지 분기 노출됨. [선물하기] - 상품 권한이 없는 경우: ‘선물하기 상품 권한이 없습니다. 판매자센터 내 1:1 문의를 통해 api 권한을 신청해 주세요.’ - 주문 권한이 없는 경우: ‘선물하기 주문 권한이 없습니다. 판매자센터 내 1:1 문의를 통해 api 권한을 신청해 주세요.’ [톡스토어] - 상품 권한이 없는 경우: ‘톡스토어 상품 권한이 없습니다. 판매자센터 내 1:1 문의를 통해 api 권한을 신청해 주세요.’ - 주문 권한이 없는 경우: ‘톡스토어 주문 권한이 없습니다. 판매자센터 내 1:1 문의를 통해 api 권한을 신청해 주세요.’ [그 외 기타] 대행사 매핑/권한 확인이 필요합니다.	400
-12006	카테고리를 찾을 수 없습니다.	400
-12000	판매자를 찾을 수 없습니다.	400
-12002	상품을 찾을 수 없습니다.	400
-12003	옵션을 찾을 수 없습니다.	400
-12005	공지사항을 찾을 수 없습니다.	400
-12010	판매자 즉시할인을 찾을수 없습니다.	400
-12011	원산지를 찾을 수 없습니다.	400
-12020	상품문의를 찾을 수 없습니다.	400
-30000	modelId에 해당하는 정보가 없습니다. 모델 검색API로 검색한 modelId 값을 넣어주세요.	400
-18902	요청 데이터가 존재하지 않습니다.	400
-21005	해당 배송정보에 접근할 수 없습니다.	403
-23005	해당 주문정보에 접근할 수 없습니다.	403
-100004	등록되지 않은 대행사입니다.	400
-100005	API 인증키 발급 후 등록 가능합니다.	400
-100006	이미 등록된 대행사입니다.	400
-100007	대행사는 최대 3개까지 등록할 수 있습니다.	400
-110001	중복된 요청으로 오류가 발생했습니다. 다시 시도해주세요.	200

5) 인증 에러(401) 메시지 샘플

{
  "code": -401,
  "msg": "인증 에러"
}

6) 상품 Validation 에러 메시지 샘플

{
	"code": -800,
	"msg": "카카오톡 스토어 에러입니다.",
	"extras": {
		"error_message": "유효하지 않은 요청입니다.",
		"error_code": -10001,
		"validation": {
			"image.size": [
				"가로 350, 세로 500 픽셀 이상의 이미지를 등록해 주세요."
			]
		}
	}
}

이 섹션의 문서