주문 - 주문 상태 변경
개요
주문의 상태를 변경하는 API예요.
WARNING
주문 상태 변경 API는 추후 공지가 있을 때까지 승인을 받은 앱에서만 사용할 수 있어요. 문의사항이 있으신 경우 개발자센터 지원 이메일로 문의해주세요.
Methods
주문 수락
| Property | Value |
|---|---|
| Method | POST |
| Path | /api-public/openapi/v1/merchants/{merchantId}/order/orders/{orderId}/accept |
| Response Type | Order |
| Description | 주문을 수락해요. 주문의 상태가 REQUESTED가 아닌 경우 요청이 거부돼요.주문 생성 API를 통해 생성한 주문만 수락 처리할 수 있어요. |
요청 파라미터
| Parameter | Location | Type | Required | Default | Description |
|---|---|---|---|---|---|
merchantId | Path | Long | ✅ | - | 매장 ID |
orderId | Path | String | ✅ | - | 주문 ID |
printOrderSheet | Query | Boolean | false | 주문서 출력 여부 주문 수락과 함께 토스 POS와 연결된 프린터에서 주문서를 출력해요. |
요청 Body
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
acceptedAt | timestamp | 주문 수락 시각 | "2025-09-01T00:00:00" | |
estimatedReadyAt | timestamp | 예상 준비 완료 시각 매장 기준에서의 준비 완료 시각을 의미해요. (예: 20분 뒤 픽업 가능) | "2025-09-01T00:20:00" |
요청 Body 예시
json
{
"acceptedAt": "2025-09-01T00:00:00",
"estimatedReadyAt": "2025-09-01T00:20:00"
}주문 거절
| Property | Value |
|---|---|
| Method | POST |
| Path | /api-public/openapi/v1/merchants/{merchantId}/order/orders/{orderId}/decline |
| Response Type | Order |
| Description | 주문을 거절해요. 주문의 상태가 REQUESTED가 아닌 경우 요청이 거부돼요.주문 생성 API를 통해 생성한 주문만 거절 처리할 수 있어요. |
요청 파라미터
| Parameter | Location | Type | Required | Default | Description |
|---|---|---|---|---|---|
merchantId | Path | Long | ✅ | - | 매장 ID |
orderId | Path | String | ✅ | - | 주문 ID |
요청 Body
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
declinedAt | timestamp | 주문 거절 시각 | "2025-09-01T00:00:00" | |
declinedReason | String | ALPHA 주문 거절 사유 | "메뉴 품절" | |
declinedCode | String | ALPHA 주문 거절 사유 코드예시: - 고객 요청 ( "CUSTOMER_REQUEST")- 메뉴 품절 ( "MENU_SOLD_OUT")- 주문 밀림 ( "COOKING_DELAY")- 요청사항 불가 ( "REQUEST_UNAVAILABLE") | "MENU_SOLD_OUT" |
요청 Body 예시
json
{
"declinedAt": "2025-09-01T00:00:00",
"declinedReason": "메뉴 품절",
"declinedCode": "MENU_SOLD_OUT"
}주문 취소
| Property | Value |
|---|---|
| Method | POST |
| Path | /api-public/openapi/v1/merchants/{merchantId}/order/orders/{orderId}/cancel |
| Response Type | Order |
| Description | 주문을 취소하고 주문 상태를 CANCELLED로 변경해요. 주문에 포함된 결제 내역은 이 API로 취소되지 않아요.주문 생성 API를 통해 생성한 주문만 취소 처리할 수 있어요. |
요청 파라미터
| Parameter | Location | Type | Required | Default | Description |
|---|---|---|---|---|---|
merchantId | Path | Long | ✅ | - | 매장 ID |
orderId | Path | String | ✅ | - | 주문 ID |
printOrderSheet | Query | Boolean | false | 주문서 출력 여부 주문 취소와 함께 토스 POS와 연결된 프린터에서 취소 주문서를 출력해요. |
요청 Body
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
cancelledReason | String | ALPHA 주문 취소 사유 | "고객 요청으로 인한 취소" |
요청 Body 예시
json
{
"cancelledReason": "고객 요청으로 인한 취소"
}