Search Info

Search Company Info

Search Order Infos

GET /api/orders

Access Permissions

Role	Description
ADMIN	어드민
MANAGER	관리자
SELLER	판매자
CUSTOMER	구매자

Request Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Request Parameter

Name	Type	Description
page	Integer	Page number
size	Integer	Page Size (10,30,50)
sort	String	Value of the 'orderby' (ex) createdAt)
direction	String	Direction of the sorting (DESC, ASC)
keyword	String	주문일(createAt), 상품명(productName), 주문상태(state)

Response

200

{
  "status": 200,
  "data": [
    {
      "orderId": 98765,
      "userId": 12345,
      "state": "주문완료",
      "address": {
        "addressId": 1,
        "zip": "12354",
        "address": "서울시 서초구 서초대로1",
        "addressDetail": "123호",
        "recipientName": "홍길동",
        "phoneNumber": "010-1234-5678"
      },
      "orderItems": [
        {
          "productId": 67890,
          "quantity": 2,
          "originalPrice": 30000,
          "discountedPrice": 19900,
          "productName": "계산기",
          "productOption": "분홍/ L",
          "categoryCode": 110124,
          "companyId": "주피터"
        }
      ],
      "deliveryPrice": 2500,
      "totalPrice": 22400,
      "paymentMethod": "CREDIT_CARD",
      "memo": "부재 시 문 앞에 놔주세요.",
      "createdDate": "2024-09-27 12:00:00"
    },
    {
      "orderId": 87654,
      "userId": 12345,
      "state": "배송중",
      "address": {
        "addressId": 2,
        "zip": "98765",
        "address": "서울시 강남구 테헤란로 10",
        "addressDetail": "901호",
        "recipientName": "김철수",
        "phoneNumber": "010-9876-5432"
      },
      "orderItems": [
        {
          "productId": 12345,
          "quantity": 30,
          "originalPrice": 3000,
          "discountedPrice": 1500,
          "productName": "영양간식 맛밤",
          "productOption": "80g",
          "categoryCode": 132316,
          "companyId": "가을청과"
        }
      ],
      "deliveryPrice": 2500,
      "totalPrice": 47500,
      "paymentMethod": "PAYPAL",
      "memo": "",
      "createdDate": "2024-09-28 09:00:00"
    }
  ],
  "error": null,
  "timeStamp": "2024-09-27 12:00:00"
}

ERROR

{ 
    "status": 400, // ERROR 코드 ex) 400, 401, 403, 404 등
    "data": null,
    "error": {
        "message": "ERROR 발생 시 e.getmessage 결과"
    },
    "timeStamp": "2024-09-27 12:00:00"
}