Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions src/docs/asciidoc/_customer_order.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
== 소비자 주문 (Customer Order) API

=== 1. 주문 상태 조회 API
`GET /orders/customer/order-detail/{orderDetailId}/delivery-status`

경로 변수:
include::{snippets}/customer-order-detail-status-get/path-parameters.adoc[]

응답 본문:
include::{snippets}/customer-order-detail-status-get/response-fields.adoc[]

응답:
include::{snippets}/customer-order-detail-status-get/http-response.adoc[]


=== 2. 주문 상세 조회 API
`GET /orders/customer/{orderId}`

경로 변수:
include::{snippets}/customer-order-detail-get/path-parameters.adoc[]

응답 본문:
include::{snippets}/customer-order-detail-get/response-fields.adoc[]

응답:
include::{snippets}/customer-order-detail-get/http-response.adoc[]

=== 3. 주문 목록 조회 API
`GET /orders/customer`

쿼리 파라미터:
include::{snippets}/customer-order-list-get/query-parameters.adoc[]

응답 본문:
include::{snippets}/customer-order-list-get/response-fields.adoc[]

응답:
include::{snippets}/customer-order-list-get/http-response.adoc[]

=== 4. 주문 생성 API
`POST /orders/customer`

요청 본문:
include::{snippets}/customer-order-create/request-fields.adoc[]

응답 본문:
include::{snippets}/customer-order-create/response-fields.adoc[]

응답:
include::{snippets}/customer-order-create/http-response.adoc[]
77 changes: 77 additions & 0 deletions src/docs/asciidoc/_owner_order.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
== 상점주 주문 (Owner Order) API

=== 1. [상점] 배송 준비 중 목록 조회 API
`GET /orders/owner/{storeId}/preparing`

경로 변수:
include::{snippets}/owner-order-preparing-get/path-parameters.adoc[]

요청 파라미터:
include::{snippets}/owner-order-preparing-get/query-parameters.adoc[]

응답 본문:
include::{snippets}/owner-order-preparing-get/response-fields.adoc[]

응답:
include::{snippets}/owner-order-preparing-get/http-response.adoc[]

=== 2. [상점] 부분 배송 중 목록 조회 API
`GET /orders/owner/{storeId}/partially-shipped`

경로 변수:
include::{snippets}/owner-order-partially-shipped-get/path-parameters.adoc[]

요청 파라미터:
include::{snippets}/owner-order-partially-shipped-get/query-parameters.adoc[]

응답 본문:
include::{snippets}/owner-order-partially-shipped-get/response-fields.adoc[]

응답:
include::{snippets}/owner-order-partially-shipped-get/http-response.adoc[]

=== 3. [상점] 부분 배송 완료 목록 조회 API
`GET /orders/owner/{storeId}/partially-delivered`

경로 변수:
include::{snippets}/owner-order-partially-delivered-get/path-parameters.adoc[]

요청 파라미터:
include::{snippets}/owner-order-partially-delivered-get/query-parameters.adoc[]

응답 본문:
include::{snippets}/owner-order-partially-delivered-get/response-fields.adoc[]

응답:
include::{snippets}/owner-order-partially-delivered-get/http-response.adoc[]

=== 4. [상점] 주문 상태 변경 (배송준비중) API
`PATCH /orders/owner/order-details/{orderDetailId}/preparing`

경로 변수:
include::{snippets}/owner-order-status-to-preparing-update/path-parameters.adoc[]

응답:
include::{snippets}/owner-order-status-to-preparing-update/http-response.adoc[]


=== 5. [상점] 주문 상태 변경 (배송중) API
`PATCH /orders/owner/order-details/{orderDetailId}/shipped`

경로 변수:
include::{snippets}/owner-order-status-to-shipped-update/path-parameters.adoc[]

요청 본문:
include::{snippets}/owner-order-status-to-shipped-update/request-fields.adoc[]

응답:
include::{snippets}/owner-order-status-to-shipped-update/http-response.adoc[]

=== 6.[상점] 주문 상태 변경 (배송완료) API
`PATCH /orders/owner/order-details/{orderDetailId}/delivered`

경로 변수:
include::{snippets}/owner-order-status-to-delivered-update/path-parameters.adoc[]

응답:
include::{snippets}/owner-order-status-to-delivered-update/http-response.adoc[]
4 changes: 3 additions & 1 deletion src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ include::_store.adoc[]
include::_auth.adoc[]
include::_delivery_address.adoc[]
include::_discount.adoc[]

include::_deliverypolicy.adoc[]
include::_customer_order.adoc[]
include::_owner_order.adoc[]

// include::_product.adoc[]

Loading