19.4. bmrmember-order/cancel PATCH
주문번호[bulkNumber]에 해당하는 주문을 취소 요청
- 취소 가능 조건: [주문의 상태(statuses)가 주문 접수 완료[placed], 배차대기[wait] 또는 배차완료[allocated]] AND 주문 취소 가능(isCancellable=true)
- 취소 불가 조건: [주문의 상태[statuses]가 픽업 출발[ready] 이후의 상태] OR 주문 취소 불가[isCancellable=false]
- 취소 완료 시 결 과: 주문[Order]의 상태[statuses]가 취소[cancelled]로 변경됨
PATCH[DOMAIN]/api/bmrmember-order/{bulkNumber}/cancel/
- Headers:
Api-Key: {APIKEY} - 별도 파라미터 필요 없음
호출 결과 코드
| status | err_code | 설명 |
|---|---|---|
SUCCESS | 성공 | |
NOT_FOUND | 해당 주문번호가 존재하지 않음 | |
FAIL | UNABLE_STATUSES | 주문 취소 불가능한 주문 상태[statuses] |
FAIL | NOT_CANCELLABLE | 주문 취소 불가 |
FAIL | ALREADY_CANCELLED | 이미 취소된 주문 |
호출 결과 예시
{
"status": "SUCCESS",
"message": "주문이 취소되었습니다.",
"results": {
"bulkNumber": "20230720000048",
"orderNumber": "0001",
"pickupName": "홍길동",
"pickupAddress": "서울특별시 ...",
"pickupAddressDetail": "",
"pickupContact": "010-0000-0000",
"ecommerce": {
"ecommerceId": "AAA",
"name": "브랜드 1",
"url": null,
"isInspection": false,
"returnAddress": [],
"owner_account": null,
"createdAt": "2023-07-20T09:49:40+09:00",
"updatedAt": "2023-07-20T09:49:40+09:00",
"deletedAt": null
},
"courierName": "",
"courierPhoneNumber": "",
"requestInspect": "",
"pickupMemo": "",
"dropoffMemo": "",
"statuses": "cancelled",
"createdAt": "2023-07-20T20:35:19+09:00",
"cancelledAt": "2023-07-20T21:02:11+09:00",
"completedAt": null,
"isCompleted": false,
"isCancellable": true,
"boxType": "A",
"externalServiceExchangeReturn": "return"
}
}