이 문서는 REST API를 구현한 JEEOKSHOP-STORE API 사용 방법을 안내합니다.
개요
Http 동사
본 REST API에서 사용하는 HTTP 동사(verbs)는 가능한 표준 HTTP 와 REST 규약을 따릅니다.
동사 | 용례 |
---|---|
|
리소스를 가져올 때 사용 |
|
새 리소스를 만들 때 사용 |
|
기존 리소스를 수정할 때 사용 |
|
기존 리소스의 일부를 수정할 때 사용 |
|
기존 리소스를 삭제할 떄 사용 |
HTTP 상태 코드
본 REST API에서 사용하는 HTTP 상태 코드는 가능한 표준 HTTP와 REST 규약을 따릅니다.
상태 코드 | 용례 |
---|---|
|
요청을 성공적으로 처리함 |
|
새 리소스를 성공적으로 생성함. 응답의 |
|
기존 리소스를 성공적으로 수정함. |
|
잘못된 요청을 보낸 경우. 응답 본문에 더 오류에 대한 정보가 담겨있다. |
|
요청한 리소스가 없음. |
|
클라이언트의 요청이 서버의 상태와 충돌이 발생한 경우. |
기본 정보
Host : store.jeeokshop.jeeok.com
로그인 및 권한정보를 request header에 포함하여 인증
Key | Value | Description |
---|---|---|
|
|
로그인 후 리턴 받은 accessToken |
사용자 모드
스토어
사용자는 스토어 목록을 확인하고 상세 정보를 확인 할 수 있습니다.
스토어 목록
요청
GET /stores?searchCondition=NAME&searchKeyword=%EA%B5%90%EC%B4%8C%EC%B9%98%ED%82%A8&searchMemberId&page=0&size=10&searchMemberId= HTTP/1.1
Host: store.jeeokshop.jeeok.com
Parameter | Description |
---|---|
|
검색 조건 |
|
검색 키워드 |
|
검색 페이지 |
|
검색 사이즈 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3395
{"transaction_time":"2022-11-20T19:09:01.3614358","code":"SUCCESS","message":null,"errors":null,"data":[{"storeId":74,"storeName":"교촌치킨19","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]},{"storeId":73,"storeName":"교촌치킨18","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]},{"storeId":72,"storeName":"교촌치킨17","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]},{"storeId":71,"storeName":"교촌치킨16","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]},{"storeId":70,"storeName":"교촌치킨15","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]},{"storeId":69,"storeName":"교촌치킨14","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]},{"storeId":68,"storeName":"교촌치킨13","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]},{"storeId":67,"storeName":"교촌치킨12","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]},{"storeId":66,"storeName":"교촌치킨11","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]},{"storeId":65,"storeName":"교촌치킨10","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]}]}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
스토어 고유번호 |
|
|
스토어 이름 |
|
|
스토어 영업 시작 시간 |
|
|
스토어 영업 종료 시간 |
|
|
스토어 전화번호 |
|
|
스토어 주소 |
|
|
카테고리 이름 |
|
|
카테고리 정렬번호 |
스토어 상세
요청
GET /stores/75 HTTP/1.1
Host: store.jeeokshop.jeeok.com
Parameter | Description |
---|---|
|
스토어 고유 번호 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 430
{"transaction_time":"2022-11-20T19:09:01.3884347","code":"SUCCESS","message":null,"errors":null,"data":{"storeId":75,"storeName":"교촌치킨","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
스토어 고유번호 |
|
|
스토어 이름 |
|
|
스토어 영업 시작 시간 |
|
|
스토어 영업 종료 시간 |
|
|
스토어 전화번호 |
|
|
스토어 주소 |
|
|
카테고리 이름 |
|
|
카테고리 정렬번호 |
호감 스토어
사용자는 내 호감 스토어를 조회 할 수 있고, 추가 및 삭제 할 수 있습니다.
내 호감 스토어 목록
요청
GET /front/favoriteStores?searchMemberId&page=0&size=10&searchMemberId= HTTP/1.1
member-id: 10
Host: store.jeeokshop.jeeok.com
Parameter | Description |
---|---|
|
검색 페이지 |
|
검색 사이즈 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 584
{"transaction_time":"2022-11-20T19:09:00.2274361","code":"SUCCESS","message":null,"errors":null,"data":[{"favoriteStoreId":8,"storeId":6,"storeName":"store_name"},{"favoriteStoreId":10,"storeId":6,"storeName":"store_name"},{"favoriteStoreId":12,"storeId":6,"storeName":"store_name"},{"favoriteStoreId":14,"storeId":6,"storeName":"store_name"},{"favoriteStoreId":16,"storeId":6,"storeName":"store_name"},{"favoriteStoreId":18,"storeId":6,"storeName":"store_name"},{"favoriteStoreId":20,"storeId":6,"storeName":"store_name"},{"favoriteStoreId":22,"storeId":6,"storeName":"store_name"}]}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
호감 스토어 고유번호 |
|
|
호감 스토어 고유번호 |
|
|
호감 스토어 고유번호 |
내 호감 스토어 상세
요청
GET /front/favoriteStores/7 HTTP/1.1
Host: store.jeeokshop.jeeok.com
Parameter | Description |
---|---|
|
호감 스토어 고유번호 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 162
{"transaction_time":"2022-11-20T19:09:00.1668358","code":"SUCCESS","message":null,"errors":null,"data":{"favoriteStoreId":7,"storeId":5,"storeName":"store_name"}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
호감 스토어 고유번호 |
|
|
호감 스토어 고유번호 |
|
|
호감 스토어 고유번호 |
내 호감 스토어 추가
요청
Parameter | Description |
---|---|
|
스토어 고유번호 |
POST /front/favoriteStores/stores/4 HTTP/1.1
member-id: 10
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 130
{"transaction_time":"2022-11-20T19:09:00.1338355","code":"SUCCESS","message":null,"errors":null,"data":{"addedFavoriteStoreId":6}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
추가된 호감 스토어 고유번호 |
내 호감 스토어 삭제
요청
Parameter | Description |
---|---|
|
호감 스토어 고유번호 |
DELETE /front/favoriteStores/5 HTTP/1.1
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 108
{"transaction_time":"2022-11-20T19:09:00.0973813","code":"SUCCESS","message":null,"errors":null,"data":null}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
데이터 |
매니저 모드
스토어
매니저는 스토어를 조회, 저장, 수정 그리고 삭제 할 수 있습니다.
내 스토어 목록
요청
GET /manager/stores?searchCondition=NAME&searchKeyword=%EA%B5%90%EC%B4%8C%EC%B9%98%ED%82%A8&searchMemberId&page=0&size=10&searchMemberId= HTTP/1.1
member-id: 1
Host: store.jeeokshop.jeeok.com
Parameter | Description |
---|---|
|
검색 조건 |
|
검색 키워드 |
|
검색 페이지 |
|
검색 사이즈 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2911
{"transaction_time":"2022-11-20T19:09:01.2724349","code":"SUCCESS","message":null,"errors":null,"data":[{"storeId":53,"storeName":"교촌치킨14","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A14","categoryOrder":1},{"categoryName":"시리즈A15","categoryOrder":2}]},{"storeId":52,"storeName":"교촌치킨13","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A13","categoryOrder":1},{"categoryName":"시리즈A14","categoryOrder":2}]},{"storeId":51,"storeName":"교촌치킨12","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A12","categoryOrder":1},{"categoryName":"시리즈A13","categoryOrder":2}]},{"storeId":50,"storeName":"교촌치킨11","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A11","categoryOrder":1},{"categoryName":"시리즈A12","categoryOrder":2}]},{"storeId":49,"storeName":"교촌치킨10","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A10","categoryOrder":1},{"categoryName":"시리즈A11","categoryOrder":2}]},{"storeId":48,"storeName":"교촌치킨9","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A9","categoryOrder":1},{"categoryName":"시리즈A10","categoryOrder":2}]},{"storeId":47,"storeName":"교촌치킨8","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A8","categoryOrder":1},{"categoryName":"시리즈A9","categoryOrder":2}]},{"storeId":46,"storeName":"교촌치킨7","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A7","categoryOrder":1},{"categoryName":"시리즈A8","categoryOrder":2}]},{"storeId":45,"storeName":"교촌치킨6","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A6","categoryOrder":1},{"categoryName":"시리즈A7","categoryOrder":2}]},{"storeId":44,"storeName":"교촌치킨5","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A5","categoryOrder":1},{"categoryName":"시리즈A6","categoryOrder":2}]}]}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
스토어 고유번호 |
|
|
스토어 이름 |
|
|
스토어 영업 시작 시간 |
|
|
스토어 영업 종료 시간 |
|
|
스토어 전화번호 |
|
|
스토어 주소 |
|
|
카테고리 이름 |
|
|
카테고리 정렬번호 |
내 스토어 상세
요청
Parameter | Description |
---|---|
|
스토어 고유 번호 |
GET /manager/stores/54 HTTP/1.1
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 429
{"transaction_time":"2022-11-20T19:09:01.314436","code":"SUCCESS","message":null,"errors":null,"data":{"storeId":54,"storeName":"교촌치킨","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
스토어 고유번호 |
|
|
스토어 이름 |
|
|
스토어 영업 시작 시간 |
|
|
스토어 영업 종료 시간 |
|
|
스토어 전화번호 |
|
|
스토어 주소 |
|
|
카테고리 이름 |
|
|
카테고리 정렬번호 |
내 스토어 등록
요청
POST /manager/stores HTTP/1.1
Content-Type: application/json;charset=UTF-8
member-id: 1
Content-Length: 323
Host: store.jeeokshop.jeeok.com
{"storeName":"교촌치킨","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","zipcode":"12345","address":"서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]}
Path | Type | Description |
---|---|---|
|
|
스토어 이름 |
|
|
스토어 영업 시작 시간 |
|
|
스토어 영업 종료 시간 |
|
|
스토어 전화번호 |
|
|
스토어 우편번호 |
|
|
스토어 주소 |
|
|
카테고리 이름 |
|
|
카테고리 정렬번호 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 123
{"transaction_time":"2022-11-20T19:09:01.1904327","code":"SUCCESS","message":null,"errors":null,"data":{"savedStoreId":37}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
저장된 스토어 고유번호 |
내 스토어 수정
요청
Parameter | Description |
---|---|
|
스토어 고유번호 |
PUT /manager/stores/36 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 435
Host: store.jeeokshop.jeeok.com
{"storeName":"BHC치킨","businessOpeningHours":"1800","businessClosingHours":"2300","phoneNumber":"01012345678","zipcode":"12345","address":"서울시","storeCategories":[{"categoryId":82,"categoryName":"시리즈A0","categoryOrder":1},{"categoryId":83,"categoryName":"시리즈A1","categoryOrder":2},{"categoryId":84,"categoryName":"시리즈A2","categoryOrder":3},{"categoryId":85,"categoryName":"new시리즈A","categoryOrder":4}]}
Path | Type | Description |
---|---|---|
|
|
스토어 이름 |
|
|
스토어 영업 시작 시간 |
|
|
스토어 영업 종료 시간 |
|
|
스토어 전화번호 |
|
|
스토어 우편번호 |
|
|
스토어 주소 |
|
|
카테고리 고유번호 |
|
|
카테고리 이름 |
|
|
카테고리 정렬번호 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 124
{"transaction_time":"2022-11-20T19:09:01.157436","code":"SUCCESS","message":null,"errors":null,"data":{"updatedStoreId":36}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
수정된 스토어 고유번호 |
내 스토어 삭제
요청
Parameter | Description |
---|---|
|
스토어 고유번호 |
DELETE /manager/stores/38 HTTP/1.1
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 108
{"transaction_time":"2022-11-20T19:09:01.2144336","code":"SUCCESS","message":null,"errors":null,"data":null}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
데이터 |
내 스토어 상품
매니저는 스토어의 상품을 조회, 저장, 수정 그리고 삭제 할 수 있습니다.
내 스토어 상품 목록
요청
Parameter | Description |
---|---|
|
스토어 고유번호 |
GET /manager/stores/14/items?searchCondition=NAME&searchKeyword=%EA%B5%90%EC%B4%8C%EC%98%A4%EB%A6%AC%EC%A7%80%EB%82%A0&searchStoreId&searchStoreId= HTTP/1.1
Host: store.jeeokshop.jeeok.com
Parameter | Description |
---|---|
|
검색 조건 |
|
검색 키워드 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2435
{"transaction_time":"2022-11-20T19:09:00.6994348","code":"SUCCESS","message":null,"errors":null,"data":[{"itemId":28,"itemName":"교촌오리지날0","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":29,"itemName":"교촌오리지날1","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":30,"itemName":"교촌오리지날2","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":31,"itemName":"교촌오리지날3","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":32,"itemName":"교촌오리지날4","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":33,"itemName":"교촌오리지날5","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":34,"itemName":"교촌오리지날6","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":35,"itemName":"교촌오리지날7","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":36,"itemName":"교촌오리지날8","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":37,"itemName":"교촌오리지날9","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":38,"itemName":"교촌오리지날10","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":39,"itemName":"교촌오리지날11","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":40,"itemName":"교촌오리지날12","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":41,"itemName":"교촌오리지날13","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":42,"itemName":"교촌오리지날14","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"}]}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
상품 고유번호 |
|
|
상품 이름 |
|
|
판매여부 |
|
|
상품 가격 |
|
|
재고수량 |
|
|
상품 이미지 |
내 스토어 상품 상세
요청
Parameter | Description |
---|---|
|
스토어 고유번호 |
|
상품 고유번호 |
GET /manager/stores/13/items/27 HTTP/1.1
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 257
{"transaction_time":"2022-11-20T19:09:00.6534336","code":"SUCCESS","message":null,"errors":null,"data":{"itemId":27,"itemName":"교촌오리지날","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
상품 고유번호 |
|
|
상품 이름 |
|
|
판매여부 |
|
|
상품 가격 |
|
|
재고수량 |
|
|
상품 이미지 |
내 스토어 상품 등록
요청
Parameter | Description |
---|---|
|
스토어 고유번호 |
POST /manager/stores/12/items HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 165
Host: store.jeeokshop.jeeok.com
{"itemName":"교촌오리지날","itemPrice":10000,"stockQuantity":100,"photoPath":"https://jeeok.com/item/picture","photoName":"교촌오리지날","categoryId":34}
Path | Type | Description |
---|---|---|
|
|
상품 이름 |
|
|
상품 가격 |
|
|
재고수량 |
|
|
이미지 주소 |
|
|
이미지 이름 |
|
|
카테고리 고유번호 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 122
{"transaction_time":"2022-11-20T19:09:00.6214342","code":"SUCCESS","message":null,"errors":null,"data":{"savedItemId":26}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
저장된 상품 고유번호 |
내 스토어 상품 수정
요청
Parameter | Description |
---|---|
|
스토어 고유번호 |
|
상품 고유번호 |
PUT /manager/stores/15/items/43 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 163
Host: store.jeeokshop.jeeok.com
{"itemName":"교촌오리지날","salesYn":"Y","itemPrice":10000,"stockQuantity":100,"photoPath":"https://jeeok.com/item/picture","photoName":"교촌오리지날"}
Path | Type | Description |
---|---|---|
|
|
상품 이름 |
|
|
판매 여부 |
|
|
상품 가격 |
|
|
재고수량 |
|
|
이미지 주소 |
|
|
이미지 이름 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 124
{"transaction_time":"2022-11-20T19:09:00.7344366","code":"SUCCESS","message":null,"errors":null,"data":{"updatedItemId":43}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
수정된 상품 고유번호 |
내 스토어 상품 삭제
요청
Parameter | Description |
---|---|
|
스토어 고유번호 |
|
상품 고유번호 |
DELETE /manager/stores/16/items/44 HTTP/1.1
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 108
{"transaction_time":"2022-11-20T19:09:00.7654375","code":"SUCCESS","message":null,"errors":null,"data":null}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
데이터 |
관리자 모드
스토어
관리자는 스토어를 조회, 저장, 수정 그리고 삭제 할 수 있습니다.
스토어 목록 조회
요청
GET /admin/stores?searchCondition=NAME&searchKeyword=%EA%B5%90%EC%B4%8C%EC%B9%98%ED%82%A8&searchMemberId&page=0&size=10&searchMemberId= HTTP/1.1
Host: store.jeeokshop.jeeok.com
Parameter | Description |
---|---|
|
검색 조건 |
|
검색 키워드 |
|
검색 페이지 |
|
검색 사이즈 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2911
{"transaction_time":"2022-11-20T19:09:01.0304335","code":"SUCCESS","message":null,"errors":null,"data":[{"storeId":33,"storeName":"교촌치킨14","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A14","categoryOrder":1},{"categoryName":"시리즈A15","categoryOrder":2}]},{"storeId":32,"storeName":"교촌치킨13","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A13","categoryOrder":1},{"categoryName":"시리즈A14","categoryOrder":2}]},{"storeId":31,"storeName":"교촌치킨12","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A12","categoryOrder":1},{"categoryName":"시리즈A13","categoryOrder":2}]},{"storeId":30,"storeName":"교촌치킨11","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A11","categoryOrder":1},{"categoryName":"시리즈A12","categoryOrder":2}]},{"storeId":29,"storeName":"교촌치킨10","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A10","categoryOrder":1},{"categoryName":"시리즈A11","categoryOrder":2}]},{"storeId":28,"storeName":"교촌치킨9","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A9","categoryOrder":1},{"categoryName":"시리즈A10","categoryOrder":2}]},{"storeId":27,"storeName":"교촌치킨8","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A8","categoryOrder":1},{"categoryName":"시리즈A9","categoryOrder":2}]},{"storeId":26,"storeName":"교촌치킨7","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A7","categoryOrder":1},{"categoryName":"시리즈A8","categoryOrder":2}]},{"storeId":25,"storeName":"교촌치킨6","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A6","categoryOrder":1},{"categoryName":"시리즈A7","categoryOrder":2}]},{"storeId":24,"storeName":"교촌치킨5","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A5","categoryOrder":1},{"categoryName":"시리즈A6","categoryOrder":2}]}]}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
스토어 고유번호 |
|
|
스토어 이름 |
|
|
스토어 영업 시작 시간 |
|
|
스토어 영업 종료 시간 |
|
|
스토어 전화번호 |
|
|
스토어 주소 |
|
|
카테고리 이름 |
|
|
카테고리 정렬번호 |
스토어 단건 조회
요청
Parameter | Description |
---|---|
|
스토어 고유 번호 |
GET /admin/stores/35 HTTP/1.1
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 430
{"transaction_time":"2022-11-20T19:09:01.1094362","code":"SUCCESS","message":null,"errors":null,"data":{"storeId":35,"storeName":"교촌치킨","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","address":"(12345) 서울시","storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
스토어 고유번호 |
|
|
스토어 이름 |
|
|
스토어 영업 시작 시간 |
|
|
스토어 영업 종료 시간 |
|
|
스토어 전화번호 |
|
|
스토어 주소 |
|
|
카테고리 이름 |
|
|
카테고리 정렬번호 |
스토어 저장
요청
POST /admin/stores HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 336
Host: store.jeeokshop.jeeok.com
{"storeName":"교촌치킨","businessOpeningHours":"1700","businessClosingHours":"2200","phoneNumber":"01012345678","zipcode":"12345","address":"서울시","memberId":1,"storeCategories":[{"categoryName":"시리즈A0","categoryOrder":1},{"categoryName":"시리즈A1","categoryOrder":2},{"categoryName":"시리즈A2","categoryOrder":3}]}
Path | Type | Description |
---|---|---|
|
|
스토어 이름 |
|
|
스토어 영업 시작 시간 |
|
|
스토어 영업 종료 시간 |
|
|
스토어 전화번호 |
|
|
스토어 우편번호 |
|
|
스토어 주소 |
|
|
회원 고유번호 |
|
|
카테고리 이름 |
|
|
카테고리 정렬번호 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 123
{"transaction_time":"2022-11-20T19:09:01.0804353","code":"SUCCESS","message":null,"errors":null,"data":{"savedStoreId":34}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
저장된 스토어 고유번호 |
스토어 수정
요청
Parameter | Description |
---|---|
|
스토어 고유번호 |
PUT /admin/stores/18 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 435
Host: store.jeeokshop.jeeok.com
{"storeName":"BHC치킨","businessOpeningHours":"1800","businessClosingHours":"2300","phoneNumber":"01012345678","zipcode":"12345","address":"서울시","storeCategories":[{"categoryId":42,"categoryName":"시리즈A0","categoryOrder":1},{"categoryId":43,"categoryName":"시리즈A1","categoryOrder":2},{"categoryId":44,"categoryName":"시리즈A2","categoryOrder":3},{"categoryId":45,"categoryName":"new시리즈A","categoryOrder":4}]}
Path | Type | Description |
---|---|---|
|
|
스토어 이름 |
|
|
스토어 영업 시작 시간 |
|
|
스토어 영업 종료 시간 |
|
|
스토어 전화번호 |
|
|
스토어 우편번호 |
|
|
스토어 주소 |
|
|
카테고리 고유번호 |
|
|
카테고리 이름 |
|
|
카테고리 정렬번호 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 125
{"transaction_time":"2022-11-20T19:09:00.9484349","code":"SUCCESS","message":null,"errors":null,"data":{"updatedStoreId":18}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
수정된 스토어 고유번호 |
스토어 삭제
요청
Parameter | Description |
---|---|
|
스토어 고유번호 |
DELETE /admin/stores/17 HTTP/1.1
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 108
{"transaction_time":"2022-11-20T19:09:00.9024333","code":"SUCCESS","message":null,"errors":null,"data":null}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
데이터 |
상품
관리자는 상품을 조회, 저장, 수정 그리고 삭제 할 수 있습니다.
상품 목록 조회
요청
GET /admin/items?searchCondition=NAME&searchKeyword=%EA%B5%90%EC%B4%8C%EC%98%A4%EB%A6%AC%EC%A7%80%EB%82%A0&searchStoreId&page=0&size=10&searchStoreId= HTTP/1.1
Host: store.jeeokshop.jeeok.com
Parameter | Description |
---|---|
|
검색 조건 |
|
검색 키워드 |
|
검색 페이지 |
|
검색 사이즈 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1653
{"transaction_time":"2022-11-20T19:09:00.5414327","code":"SUCCESS","message":null,"errors":null,"data":[{"itemId":2,"itemName":"교촌오리지날","salesYn":"Y","price":16000,"stockQuantity":150,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":10,"itemName":"교촌오리지날0","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":11,"itemName":"교촌오리지날1","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":12,"itemName":"교촌오리지날2","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":13,"itemName":"교촌오리지날3","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":14,"itemName":"교촌오리지날4","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":15,"itemName":"교촌오리지날5","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":16,"itemName":"교촌오리지날6","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":17,"itemName":"교촌오리지날7","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"},{"itemId":18,"itemName":"교촌오리지날8","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"}]}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
상품 고유번호 |
|
|
상품 이름 |
|
|
판매여부 |
|
|
상품 가격 |
|
|
재고수량 |
|
|
상품 이미지 |
상품 단건 조회
요청
Parameter | Description |
---|---|
|
상품 고유번호 |
GET /admin/items/8 HTTP/1.1
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 256
{"transaction_time":"2022-11-20T19:09:00.4364332","code":"SUCCESS","message":null,"errors":null,"data":{"itemId":8,"itemName":"교촌오리지날","salesYn":"Y","price":10000,"stockQuantity":100,"photo":"https://jeeok.com/item/picture/교촌오리지날"}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
상품 고유번호 |
|
|
상품 이름 |
|
|
판매여부 |
|
|
상품 가격 |
|
|
재고수량 |
|
|
상품 이미지 |
상품 저장
요청
POST /admin/items HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 177
Host: store.jeeokshop.jeeok.com
{"itemName":"교촌오리지날","itemPrice":10000,"stockQuantity":100,"photoPath":"https://jeeok.com/item/picture","photoName":"교촌오리지날","storeId":7,"categoryId":29}
Path | Type | Description |
---|---|---|
|
|
상품 이름 |
|
|
상품 가격 |
|
|
재고수량 |
|
|
이미지 주소 |
|
|
이미지 이름 |
|
|
스토어 고유번호 |
|
|
카테고리 고유번호 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 121
{"transaction_time":"2022-11-20T19:09:00.4014338","code":"SUCCESS","message":null,"errors":null,"data":{"savedItemId":7}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
저장된 상품 고유번호 |
상품 수정
요청
Parameter | Description |
---|---|
|
상품 고유번호 |
PUT /admin/items/9 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 163
Host: store.jeeokshop.jeeok.com
{"itemName":"교촌오리지날","salesYn":"Y","itemPrice":10000,"stockQuantity":100,"photoPath":"https://jeeok.com/item/picture","photoName":"교촌오리지날"}
Path | Type | Description |
---|---|---|
|
|
상품 이름 |
|
|
판매 여부 |
|
|
상품 가격 |
|
|
재고수량 |
|
|
이미지 주소 |
|
|
이미지 이름 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 122
{"transaction_time":"2022-11-20T19:09:00.473434","code":"SUCCESS","message":null,"errors":null,"data":{"updatedItemId":9}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
수정된 상품 고유번호 |
상품 삭제
요청
Parameter | Description |
---|---|
|
상품 고유번호 |
DELETE /admin/items/25 HTTP/1.1
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 108
{"transaction_time":"2022-11-20T19:09:00.5774335","code":"SUCCESS","message":null,"errors":null,"data":null}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
데이터 |
카테고리
관리자는 카테고리를 조회, 저장, 수정 그리고 삭제 할 수 있습니다.
카테고리 목록 조회
요청
GET /admin/categories?searchCondition=NAME&searchKeyword=A%EC%8B%9C%EB%A6%AC%EC%A6%88&searchMemberId&searchStoreId&page=0&size=10&searchMemberId=&searchStoreId= HTTP/1.1
Host: store.jeeokshop.jeeok.com
Parameter | Description |
---|---|
|
검색 조건 |
|
검색 키워드 |
|
검색 페이지 |
|
검색 사이즈 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 755
{"transaction_time":"2022-11-20T19:08:56.3356083","code":"SUCCESS","message":null,"errors":null,"data":[{"categoryId":9,"categoryName":"A시리즈0","categoryOrder":1},{"categoryId":10,"categoryName":"A시리즈1","categoryOrder":2},{"categoryId":11,"categoryName":"A시리즈2","categoryOrder":3},{"categoryId":12,"categoryName":"A시리즈3","categoryOrder":4},{"categoryId":13,"categoryName":"A시리즈4","categoryOrder":5},{"categoryId":14,"categoryName":"A시리즈5","categoryOrder":6},{"categoryId":15,"categoryName":"A시리즈6","categoryOrder":7},{"categoryId":16,"categoryName":"A시리즈7","categoryOrder":8},{"categoryId":17,"categoryName":"A시리즈8","categoryOrder":9},{"categoryId":18,"categoryName":"A시리즈9","categoryOrder":10}]}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
카테고리 고유번호 |
|
|
카테고리명 |
|
|
정렬번호 |
카테고리 단건 조회
요청
Parameter | Description |
---|---|
|
카테고리 고유번호 |
GET /admin/categories/8 HTTP/1.1
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 166
{"transaction_time":"2022-11-20T19:08:56.1076074","code":"SUCCESS","message":null,"errors":null,"data":{"categoryId":8,"categoryName":"A시리즈","categoryOrder":1}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
카테고리 고유번호 |
|
|
카테고리명 |
|
|
정렬번호 |
카테고리 저장
요청
POST /admin/categories HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 59
Host: store.jeeokshop.jeeok.com
{"categoryName":"A시리즈","categoryOrder":1,"storeId":1}
Path | Type | Description |
---|---|---|
|
|
카테고리명 |
|
|
정렬번호 |
|
|
스토어 고유번호 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 125
{"transaction_time":"2022-11-20T19:08:56.0816058","code":"SUCCESS","message":null,"errors":null,"data":{"savedCategoryId":7}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
저장된 카테고리 고유번호 |
카테고리 수정
요청
Parameter | Description |
---|---|
|
카테고리 고유번호 |
PUT /admin/categories/24 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 47
Host: store.jeeokshop.jeeok.com
{"categoryName":"B시지르","categoryOrder":2}
Path | Type | Description |
---|---|---|
|
|
카테고리명 |
|
|
정렬번호 |
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 128
{"transaction_time":"2022-11-20T19:08:56.3796128","code":"SUCCESS","message":null,"errors":null,"data":{"updatedCategoryId":24}}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
수정된 상품 고유번호 |
카테고리 삭제
요청
Parameter | Description |
---|---|
|
카테고리 고유번호 |
DELETE /admin/categories/6 HTTP/1.1
Host: store.jeeokshop.jeeok.com
응답
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 108
{"transaction_time":"2022-11-20T19:08:55.9166065","code":"SUCCESS","message":null,"errors":null,"data":null}
Path | Type | Description |
---|---|---|
|
|
api 요청 시간 |
|
|
SUCCESS or ERROR |
|
|
메시지 |
|
|
에러 |
|
|
데이터 |