Skip to content

백엔드 API 명세

street62 edited this page Apr 25, 2022 · 1 revision

배포 URL

http://15.165.236.13


1. 주문 생성

1.1) 요청 : "/orders"로 post 요청

{
    "itemId": "3",
    "count": "5"
}

필요 인자값

  • itemId : 상품 id
  • count : 상품 갯수

1.2) 응답

{
    "orderId": 4,
    "orderMemberName": "sampleMember",
    "deliveryAddress": "서울특별시 강남구",
    "orderItemName": "땃쥐고기",
    "originalItemPrice": 10000,
    "discountedItemPrice": 8000,
    "orderItemCount": 3,
    "discountPolicy": "런칭특가",
    "deliveryType": "새벽배송",
    "deliveryFee": 2500,
    "totalPrice": 26500,
    "mileage": 240
}

각 변수가 의미하는 것

  • orderId : 생성된 주문 id
  • orderMemberName : 주문회원명
  • deliveryAddress : 배송지 주소
  • orderItemName : 주문 상품명
  • originalItemPrice : 단일상품 원가(할인 전)
  • discountedItemPrice : 단일상품 할인가
  • orderItemCount : 주문한 상품 개수
  • discountPolicy : 가격 할인 정책(런칭특가, 이벤트특가, ...)
  • deliveryType : 배송 유형(일반 전국배송/새벽배송)
  • deliveryFee : 배송료
  • totalPrice : 총 주문 금액
  • mileage : 본 주문으로 적립되는 적립금

2. 상품 목록

2.1) 요청 "/items?section=xxxx"로 get요청

  • section=xxxx : 인자로 섹션 식별자를 넘기면 됨
    • main : 메인반찬
    • soup : 국물요리
    • side : 밑반찬

2.2) 응답

{
    "items": [
        {
            "itemId": 1,
            "name": "sampleItem",
            "description": "샘플 아이템입니다.",
            "originalPrice": 10000,
            "discountedPrice": 9000,
            "discountPolicy": "이벤트특가",
            "mainImage": "https://i.imgur.com/A14QwVW.jpeg"
        }
    ]
}
  • items : 리스트. 포함된 각각의 요소들은 목록요청에 보여지는 내용들
    • itemId : 상품 Id(식별자)
    • name : 상품명
    • description : 상품 간단 설명
    • originalPrice : 단일상품 현재 원가
    • discountedPrice : 단일상품 현재 할인가
    • discountPolicy : 상품에 현재 적용된 할인정책
    • mainImage : 메인 이미지

3. 상품 상세

3.1) 요청 : "/items/{itemId}로 get 요청

  • itemId : 상품 식별자

3.2) 응답

{
    "name": "오리 주물럭_반조리",
    "description": "감칠맛 나는 매콤한 양념",
    "originalPrice": 10000,
    "discountedPrice": 8000,
    "discountPolicy": "런칭특가",
    "mileage": 80,
    "supportDawnDelivery": true,
    "deliveryFee": 2500,
    "deliveryFeeFreeMinPay": 40000,
    "stock": 10,
    "mainImages": [
        "https://i.imgur.com/A14QwVW.jpeg",
        "https://i.imgur.com/AD3MbBi.jpeg"
    ],
    "subImages": [
        "https://i.imgur.com/Jvh1OQm.jpeg"
    ]
}
  • name : 상품명
  • description : 상품 간단 설명
  • originalPrice : 단일상품 현재 원가
  • discountedPrice : 단일상품 현재 할인가
  • discountPolicy : 상품에 현재 적용된 할인정책
  • supportDawnDelivery: 새벽배송 지원 여부
  • mileage : 상품 1개 구매시 적립금
  • supportDawnDelivery : 새벽배송을 지원하는 지의 여부
    • 일반 전국배송은 전체 상품이 기본적으로 지원.
    • 이에 추가적으로 새벽배송이 가능한지의 여부(boolean).
    • true일 때 전국배송 + 새벽배송 지원. false이면 전국배송만 가능
  • deliveryFee : 배송료
  • deliveryFeeFreeMinPay : 무료배송 가능 최소금액
  • stock : 현재 남아있는 재고 수량
  • mainImages, subImages: 메인 이미지/서브 이미지(List)