Appearance
주문 - 주문 조회
Methods
주문 단건 조회
| Property | Value |
|---|---|
| Method | GET |
| Path | /api-public/openapi/v1/merchants/{merchantId}/order/orders/{orderId} |
| Response Type | Order |
| Description | 매장의 주문 하나를 조회해요. |
요청 파라미터
| Parameter | Location | Type | Required | Default | Description |
|---|---|---|---|---|---|
merchantId | Path | Long | ✅ | - | 매장 ID |
orderId | Path | String | ✅ | - | 주문 ID |
주문 복수건 조회
| Property | Value |
|---|---|
| Method | GET |
| Path | /api-public/openapi/v1/merchants/{merchantId}/order/orders/by-ids |
| Response Type | Order[] |
| Description | ID를 통해 매장의 주문 여러 건을 조회해요. 최대 25건까지 조회 가능해요. |
요청 파라미터
| Parameter | Location | Type | Required | Default | Description |
|---|---|---|---|---|---|
merchantId | Path | Long | ✅ | - | 매장 ID |
ids | Query | String[] | ✅ | - | 주문 ID 목록 |
주문 목록 조회
| Property | Value |
|---|---|
| Method | GET |
| Path | /api-public/openapi/v1/merchants/{merchantId}/order/orders |
| Response Type | Order[] |
| Description | 매장의 주문 목록을 주문 생성 시각 순으로 조회해요. |
요청 파라미터
| Parameter | Location | Type | Required | Default | Description |
|---|---|---|---|---|---|
merchantId | Path | Long | ✅ | - | 매장 ID |
from | Query | timestamp | - | 조회 범위 시작점으로, 이 시점 이후에 생성된 주문만 조회해요. | |
to | Query | timestamp | - | 조회 범위 끝점으로, 이 시점 이전에 생성된 주문만 조회해요. | |
orderStates | Query | OrderState[] | ["COMPLETED", "CANCELLED"] | 주문 상태 필터로, 파라미터로 주어진 값의 상태를 가지는 주문만 조회해요. | |
sources | Query | String[] | - | 주문 채널 필터로, 파라미터로 주어진 값의 주문 채널을 가지는 주문만 조회해요. | |
page | Query | Int | 1 | 조회할 페이지 | |
size | Query | Int | 100 | 페이지 크기 | |
sortOrder | Query | SortOrder | "DESC" | 정렬 순서 (주문 생성 시각 기준) |