19.7. bmrmember-order/{bulkNumber}/order-number PATCH
주문번호[bulkNumber]에 해당하는 주문의 송장번호[orderNumber]를 수정
- 송장번호 변경 가능한 주문의 상태[statuses] 조건: 검품센터 도착[returned] 이전의 상태 AND 미회수[failed]가 아님
- 수정 가능: 주문 접수 완료[placed], 배차대기[wait], 배차완료[allocated], 배차취소[unallocate], 픽업 출발[ready], 픽업 완료[pickedup], 거점 도착[stopover]
- 수정 불가: 검품센터 도착[returned] 이후의 상태, 미회수[failed], 주문 취소[cancelled]
- 수정한 송장번호는 이후 배송 추적에 사용됩니다.
PATCH[DOMAIN]/api/bmrmember-order/{bulkNumber}/order-number/
- Headers:
Api-Key: {APIKEY}
요청 parameter (Body, JSON 또는 form-data)
| 파라미터 명 | 필수여부 | 데이터 타입 | 값 | 제한 사항 |
|---|---|---|---|---|
orderNumber | 필수 | String | 새로운 송장번호 | min length=1, max length=50. 앞뒤 공백은 제거 후 저장 |
호출 결과 코드
| status | err_code | 설명 |
|---|---|---|
SUCCESS | 성공. results: 19.1. bmrmember-order GET 참조 (수정 후 주문 정보) | |
NOT_FOUND | 해당 주문번호가 존재하지 않음 | |
FAIL | NO_ORDER_NUMBER | 송장번호[orderNumber]가 전달되지 않았거나 빈 값 |
FAIL | INVALID_ORDER_NUMBER | 송장번호[orderNumber]가 50자 초과 |
FAIL | UNABLE_STATUSES | 주문[Order]의 상태[statuses]가 송장번호 변경 불가 (검품센터 도착[returned] 이후, 미회수[failed], 주문 취소[cancelled]) |
호출 예시
{
"orderNumber": "123456789012"
}
호출 결과 예시
{
"status": "SUCCESS",
"message": "송장번호가 123456789012로 수정되었습니다.",
"results": {
"bulkNumber": "20230720000048",
"orderNumber": "123456789012",
"statuses": "placed",
...
}
}
{
"status": "FAIL",
"err_code": "UNABLE_STATUSES",
"errors": {
"message": "송장번호를 수정할 수 없는 주문 상태입니다. (검품센터 도착)"
}
}