주문 API - Soobinnn/CAT-24 GitHub Wiki

주문 API

쇼핑몰에서 쇼핑몰 고객이 상품을 구입하기 위해 쇼핑몰에 요청한 내역입니다. 쇼핑몰 운영자는 결제가 완료된 주문 정보를 참고하여 쇼핑몰 고객에게 물건을 배송합니다. 주문 정보에는 주문과 결제를 진행한 주문자의 정보와 상품을 배송 받을 수령자 정보가 포함됩니다.

Orders Properties

Attribute Description
order_no 카테고리 분류
delivery_no 분류 Depth
order_date 부모 카테고리 분류
total_sum 분류명
access_YN 카테고리 전체이름
member_no 최상위 카테고리 분류
display_order 진열순서
reg_id 등록자
reg_date 등록일
update_id 수정자
update_date 수정일
orderdetail_no 주문상세번호
amount 수량
sum 가격

Front API

EndPoints

- 해당 주문내역 전체 조회

Definition

GET /api/v1/orders/{id}

- Request Example

	curl -X 'GET' /api/v1/orders/isb9082
             -H 'content-type: application/json' \
             -H 'X-Api-Version: {version}'

- Response Example

{
	"data": [ {
	    "order_no" : "20190804-111111",
	    "delivery_no" : 1,
	    "order_date" : "2019-08-01 오후1:44:30",
	    "total_sum" : 150000,
	    "access_YN" : "N",
	    "unmember_password" : "",
	    "member_no" : 1,
	  },
	  {
	    "order_no" : "20190804-121121",
	    "delivery_no" : 1,
	    "order_date" : "2019-08-02 오후5:13:50",
	    "total_sum" : 270000,
	    "access_YN" : "N",
	    "unmember_password" : "",
	    "member_no" : 1,
	  },
	  ...
	  ]
}

- 주문내역 갯수

Definition

GET /api/v1/orders/{id}/count

- Request Example

	curl -X 'GET' /api/v1/orders/isb9082/count
             -H 'content-type: application/json' \
             -H 'X-Api-Version: {version}'

- Response Example

{
    "data": {
             "count" : 15
            }
}

- 해당 주문내역 조회

Definition

GET /api/v1/orders/{id}/{order_id}

- Request Example

	curl -X 'GET' /api/v1/orders/isb9082/20190804-111111
             -H 'content-type: application/json' \
             -H 'X-Api-Version: {version}'

- Response Example

{
	"data": {
	    "delivery_no" : 1,
	    "order_date" : "2019-08-01 오후1:44:30",
	    "total_sum" : 150000,
	    "access_YN" : "N",
	    "unmember_password" : "",
	    "member_no" : 1,
	  }
}

- 주문 신청

Definition

POST /api/v1/orders/

- Request Example

	curl -X ' POST' /api/v1/orders/
             -H 'content-type: application/json' \
             -H 'X-Api-Version: {version}'
             -D { "order_no" : "20190804-121121",
	         "delivery_no" : 1,
	         "order_date" : "2019-08-02 오후5:13:50",
	         "total_sum" : 270000,
	         "access_YN" : "N",
	         "unmember_password" : "",
	         "member_no" : 1,
                }

- Response Example

 {
	"result" : "success",
        "message" : null,
        "data" : "success"
}