커머스 서비스 API 문서 - 상품 API

GET /product/v1/home/products HTTP/1.1
Host: localhost:8080

{
  "success" : true,
  "data" : {
    "hotNew" : [ {
      "id" : 1,
      "title" : "책 1",
      "author" : "저자",
      "publisher" : "출판사",
      "coverImage" : "http://image.com",
      "categoryTitle" : "소설 > 국내 도서"
    } ],
    "recommend" : [ {
      "id" : 1,
      "title" : "책 1",
      "author" : "저자",
      "publisher" : "출판사",
      "coverImage" : "http://image.com",
      "categoryTitle" : "소설 > 국내 도서"
    } ],
    "bestseller" : [ {
      "id" : 1,
      "title" : "책 1",
      "author" : "저자",
      "publisher" : "출판사",
      "coverImage" : "http://image.com",
      "categoryTitle" : "소설 > 국내 도서"
    } ]
  },
  "error" : null
}

GET /product/v1/categories HTTP/1.1
Content-Type: application/json
Host: localhost:8080

{
  "success" : true,
  "data" : {
    "childCategories" : [ {
      "id" : 1,
      "parentId" : 0,
      "name" : "한국도서",
      "depth" : 1,
      "childCategories" : [ {
        "id" : 3,
        "parentId" : 1,
        "name" : "문학 소설",
        "depth" : 2,
        "childCategories" : null
      } ]
    }, {
      "id" : 2,
      "parentId" : 0,
      "name" : "외국도서",
      "depth" : 1,
      "childCategories" : [ {
        "id" : 4,
        "parentId" : 2,
        "name" : "문학 소설",
        "depth" : 2,
        "childCategories" : null
      } ]
    } ]
  },
  "error" : null
}

GET /product/v1/products?productCategoryId=2&searchWord=%EA%B5%AD%EB%82%B4%EB%8F%84%EC%84%9C&page=1&size=20&homeProductType=HOT_NEW HTTP/1.1
Host: localhost:8080

{
  "success" : true,
  "data" : {
    "products" : [ {
      "id" : 1,
      "title" : "[개발팀]국내도서 테스트 상품 (테스트 상품입니다.)",
      "author" : "Rudolph Swift",
      "price" : 29475,
      "discountedPrice" : 25317,
      "publisher" : "YES24",
      "publishDate" : "2024-10-21",
      "isbn" : "1111111111",
      "description" : "‘국가란 무엇인가’ 이후, ‘역사란 무엇인가’를 묻다\n\n유시민과 함께 역사의 갈피를 찾다!\n\n\n\n『거꾸로 읽는 세계사』로부터 30년, 작가 유시민 글쓰기의 새로운 시작. 헤로도토스의 『역사』, 투키디데스의 『펠로폰네소스 전쟁사』부터 유발 하라리의 『사피엔스』까지 고대로부터 최근까지 역사를 사로잡은 18권의 역사서들을 9장으로 나누어 훑으며 ‘역사’라는 화두를 전개해간다. 각 역사서의 주요 내용과 시대적인 맥락, 서사의 새로운 초점과 해석, 역사가의 생애 등을 유시민만의 언어로 요약했다.\n\n\n\n여기에 역사가의 속마음을 전달하고, 놓치지 말아야 할 부분을 체크해 주거나, 이해하지 못해도 좋다고 위로하고 격려하는 안내자 역할까지 맡았다. 역사에 대한 애정과 역사 공부의 중요성을 몸소 보여주며, 자신의 역사 공부법을 공개하는 셈이다.",
      "pages" : 900,
      "coverImage" : "https://shopping-phinf.pstatic.net/main_4964421/49644215637.20240806201630.jpg",
      "previewLink" : "https://search.shopping.naver.com/book/catalog/49644215637",
      "stockQuantity" : 90,
      "rating" : 3.9,
      "status" : "ON_SALE",
      "category" : {
        "id" : 2,
        "name" : "외국도서",
        "parentCategory" : {
          "id" : 0,
          "name" : "전체"
        }
      }
    }, {
      "id" : 2,
      "title" : "국내도서The Challenge of Greatness (The Legacy of Great Teachers)",
      "author" : "Gose, Michael",
      "price" : 31672,
      "discountedPrice" : 28778,
      "publisher" : "국내총판도서",
      "publishDate" : "2024-10-21",
      "isbn" : "9781610480901",
      "description" : "The Challenge of Greatness:  The Legacy of Great Teachers reveals the characteristics and teaching strategies of Great Teachers.  Simultaneously the book describes a Pantheon of thirty-two great teachers, and challenges the reader to continue their legacy by becoming one.  Recognizing the uniqueness of a great teacher, the book raises the kind of issues they face, and a range of possibilities from which they find solutions.",
      "pages" : 140,
      "coverImage" : "https://shopping-phinf.pstatic.net/main_3247428/32474284194.20220520074619.jpg",
      "previewLink" : "https://search.shopping.naver.com/book/catalog/32474284194",
      "stockQuantity" : 31,
      "rating" : 4.1,
      "status" : "ON_SALE",
      "category" : {
        "id" : 2,
        "name" : "외국도서",
        "parentCategory" : {
          "id" : 0,
          "name" : "전체"
        }
      }
    } ],
    "pagination" : {
      "currentPage" : 1,
      "totalPage" : 1,
      "pageSize" : 20,
      "totalCount" : 2,
      "hasNextPage" : true,
      "hasPreviousPage" : false
    }
  },
  "error" : null
}

GET /product/v1/products/1 HTTP/1.1
Host: localhost:8080

{
  "success" : true,
  "data" : {
    "id" : 1,
    "title" : "[개발팀]국내도서 테스트 상품 (테스트 상품입니다.)",
    "author" : "Rudolph Swift",
    "price" : 29475,
    "discountedPrice" : 25317,
    "publisher" : "YES24",
    "publishDate" : "2024-10-21",
    "isbn" : "1111111111",
    "description" : "‘국가란 무엇인가’ 이후, ‘역사란 무엇인가’를 묻다\n\n유시민과 함께 역사의 갈피를 찾다!\n\n\n\n『거꾸로 읽는 세계사』로부터 30년, 작가 유시민 글쓰기의 새로운 시작. 헤로도토스의 『역사』, 투키디데스의 『펠로폰네소스 전쟁사』부터 유발 하라리의 『사피엔스』까지 고대로부터 최근까지 역사를 사로잡은 18권의 역사서들을 9장으로 나누어 훑으며 ‘역사’라는 화두를 전개해간다. 각 역사서의 주요 내용과 시대적인 맥락, 서사의 새로운 초점과 해석, 역사가의 생애 등을 유시민만의 언어로 요약했다.\n\n\n\n여기에 역사가의 속마음을 전달하고, 놓치지 말아야 할 부분을 체크해 주거나, 이해하지 못해도 좋다고 위로하고 격려하는 안내자 역할까지 맡았다. 역사에 대한 애정과 역사 공부의 중요성을 몸소 보여주며, 자신의 역사 공부법을 공개하는 셈이다.",
    "pages" : 900,
    "coverImage" : "https://shopping-phinf.pstatic.net/main_4964421/49644215637.20240806201630.jpg",
    "previewLink" : "https://search.shopping.naver.com/book/catalog/49644215637",
    "stockQuantity" : 90,
    "rating" : 3.9,
    "status" : "ON_SALE",
    "category" : {
      "id" : 2,
      "name" : "외국도서",
      "parentCategory" : {
        "id" : 0,
        "name" : "전체"
      }
    }
  },
  "error" : null
}

GET /product/v1/reviews?productId=1 HTTP/1.1
Host: localhost:8080

{
  "success" : true,
  "data" : {
    "reviews" : [ {
      "reviewId" : 1,
      "content" : "이 책 너무 재밌어요",
      "score" : 5,
      "email" : "abc@naver.com",
      "productId" : 1,
      "createdAt" : "2024-10-21",
      "lastModifiedByUserAt" : "2024-10-21",
      "orderProductId" : null
    }, {
      "reviewId" : 2,
      "content" : "이 책 재밌긴 한데 아쉬워요",
      "score" : 3,
      "email" : "bbb@naver.com",
      "productId" : 1,
      "createdAt" : "2024-10-21",
      "lastModifiedByUserAt" : "2024-10-21",
      "orderProductId" : null
    }, {
      "reviewId" : 3,
      "content" : "어려워요 읽다 말았어요",
      "score" : 1,
      "email" : "ddd@naver.com",
      "productId" : 1,
      "createdAt" : "2024-10-21",
      "lastModifiedByUserAt" : "2024-10-21",
      "orderProductId" : null
    } ]
  },
  "error" : null
}

POST /product/v1/reviews HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiIxIiwiaWF0IjoxNzI0NTIwNDc5LCJleHAiOjE3MjU3MzAwNzl9.i1WjcNXU2wBYjikGu5u0r41XmciafAfaMF3nNheb9cc7TUpai-tnMZCg3NUcTWP9
Content-Length: 70
Host: localhost:8080

{
  "productId" : 1,
  "content" : "재미있어요!",
  "score" : 5
}

{
  "success" : true,
  "data" : {
    "reviewId" : 1
  },
  "error" : null
}

PATCH /product/v1/reviews/2 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiIxIiwiaWF0IjoxNzI0NTIwNDc5LCJleHAiOjE3MjU3MzAwNzl9.i1WjcNXU2wBYjikGu5u0r41XmciafAfaMF3nNheb9cc7TUpai-tnMZCg3NUcTWP9
Content-Length: 51
Host: localhost:8080

{
  "content" : "재미있어요!",
  "score" : 5
}

{
  "success" : true,
  "data" : {
    "reviewId" : 2
  },
  "error" : null
}

DELETE /product/v1/reviews/2 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiIxIiwiaWF0IjoxNzI0NTIwNDc5LCJleHAiOjE3MjU3MzAwNzl9.i1WjcNXU2wBYjikGu5u0r41XmciafAfaMF3nNheb9cc7TUpai-tnMZCg3NUcTWP9
Host: localhost:8080

{
  "success" : true,
  "data" : null,
  "error" : null
}

GET /product/v1/reviews/me HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiIxIiwiaWF0IjoxNzI0NTIwNDc5LCJleHAiOjE3MjU3MzAwNzl9.i1WjcNXU2wBYjikGu5u0r41XmciafAfaMF3nNheb9cc7TUpai-tnMZCg3NUcTWP9
Host: localhost:8080

{
  "success" : true,
  "data" : {
    "reviews" : [ {
      "reviewId" : 1,
      "content" : "이 책 너무 재밌어요",
      "score" : 5,
      "productId" : 1,
      "productTitle" : "상품1",
      "productAuthor" : "작성자1",
      "productPublisher" : "출판사1",
      "productCoverImage" : "https://image1.com",
      "createdAt" : "2024-10-21",
      "lastModifiedByUserAt" : "2024-10-21"
    }, {
      "reviewId" : 2,
      "content" : "이 책 재밌긴 한데 아쉬워요",
      "score" : 5,
      "productId" : 2,
      "productTitle" : "상품2",
      "productAuthor" : "작성자2",
      "productPublisher" : "출판사2",
      "productCoverImage" : "https://image2.com",
      "createdAt" : "2024-10-21",
      "lastModifiedByUserAt" : "2024-10-21"
    } ]
  },
  "error" : null
}

POST /product/v1/products/order/before HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiIxIiwiaWF0IjoxNzI0NTIwNDc5LCJleHAiOjE3MjU3MzAwNzl9.i1WjcNXU2wBYjikGu5u0r41XmciafAfaMF3nNheb9cc7TUpai-tnMZCg3NUcTWP9
Content-Length: 115
Host: localhost:8080

{
  "products" : [ {
    "productId" : 1,
    "quantity" : 2
  }, {
    "productId" : 3,
    "quantity" : 4
  } ]
}

{
  "success" : true,
  "data" : {
    "products" : [ {
      "productId" : 1,
      "title" : "[개발팀]국내도서 테스트 상품 (테스트 상품입니다.)",
      "coverImage" : "https://shopping-phinf.pstatic.net/main_4964421/49644215637.20240806201630.jpg",
      "quantity" : 12,
      "price" : 353700,
      "discountedPrice" : 303804
    } ]
  },
  "error" : null
}