shop api error response 안내

[FAQ] 샵바이프리미엄 1:1문의를 통해 문의가 자주 들어오는 공통질문을 모아서 답변하는 콘텐츠입니다.

개요

• 샵바이 api 는 기본적으로 rest api 기반으로 http response code 를 기준으로 에러 여부를 판단할 수 있습니다.

  • 2XX : 성공

  • 4XX : 클라이언트에서 잘못 보낸 경우

  • 5XX : 서버에 이상이 생긴 경우

---

일반적인 오류 케이스 샘플

{
  "timestamp": "2023-03-27 18:38:55",
  "path": "POST /server/profile/accumulations",
  "status": 400,
  "error": [],
  "code": "F0005",
  "message": "회원을 찾을 수 없습니다."
}

---

validation 오류 케이스 샘플

{
  "timestamp": "2023-03-27 18:48:48",
  "path": "POST /server/profile/accumulations",
  "status": 400,
  "error": [
    {
      "property": "reasonDetail",
      "reason": "\"지급 상세사유는 0 까지 입력가능합니다.\""
    }
  ],
  "code": "99999",
  "message": "오류가 발생하였습니다. 잠시 후 다시 시도해 주세요."
}