19.8. bmrmember-order/{bulkNumber}/reference-info PATCH
주문번호[bulkNumber]에 해당하는 주문의 고객사 참조 정보를 수정 (BMR-845, BMR-740, BMR-865)
- 주문 단위:
customerReferenceKey(고객사 참조키) /originOrderCreatedAt(원 주문 접수일) /originOrderNumber(원 송장번호) - 반품 아이템 단위:
returnItems[].customerReferenceKey(아이템 고객사 참조키) - 리터니즈 물류 처리에 관여하지 않는 참조용 정보이므로 주문 상태[statuses]와 무관하게 수정 가능
- 수정하려는 필드만 전달하면 되며, 전달하지 않은 필드는 기존 값을 유지
PATCH[DOMAIN]/api/bmrmember-order/{bulkNumber}/reference-info/
- Headers:
Api-Key: {APIKEY}
요청 parameter (Body, JSON)
form-data 사용 시 returnItems는 JSON 문자열로 전달합니다.
| 파라미터 명 | 필수여부 | 데이터 타입 | 값 | 제한 사항 |
|---|---|---|---|---|
customerReferenceKey | 선택 | String | 주문 단위 고객사 참조키 | max length=100. 빈 값('') 전달 시 삭제 |
originOrderCreatedAt | 선택 | DateTime | 원 주문 접수일 | 예: 2026-09-09 또는 2026-09-09T13:05:00+09:00. null 또는 빈 값 전달 시 삭제 |
originOrderNumber | 선택 | String | 원 송장번호 | max length=50. 빈 값('') 전달 시 삭제 |
returnItems | 선택 | Array | 반품 아이템 단위 고객사 참조키 목록 | 목록에 포함된 아이템만 수정되며, 목록에 없는 아이템은 기존 값 유지 |
returnItems[].itemCode | 필수 | String | 반품 아이템코드 | 해당 주문에 속한 아이템이어야 함 |
returnItems[].customerReferenceKey | 필수 | String | 아이템 고객사 참조키 | max length=100. 빈 값('') 전달 시 삭제 |
호출 결과 코드
| status | err_code | 설명 |
|---|---|---|
SUCCESS | 성공. results: 19.1. bmrmember-order GET 참조 (수정 후 주문 정보, returnItems[].customerReferenceKey 포함) | |
NOT_FOUND | 해당 주문번호가 존재하지 않음 | |
FAIL | NO_PARAMETER | 수정할 필드가 하나도 전달되지 않음 |
FAIL | INVALID_CUSTOMER_REFERENCE_KEY | 고객사 참조키(주문 또는 아이템)가 100자 초과 |
FAIL | INVALID_DATE_FORMAT | 원 주문 접수일 형식 오류 |
FAIL | INVALID_ORIGIN_ORDER_NUMBER | 원 송장번호가 50자 초과 |
FAIL | INVALID_RETURN_ITEMS | returnItems 형식 오류 (목록이 아님, 항목의 itemCode 또는 customerReferenceKey 누락) |
FAIL | ITEM_NOT_FOUND | itemCode가 해당 주문에 존재하지 않음 (전체 요청 거부, 아무 것도 수정되지 않음) |
호출 예시
{
"customerReferenceKey": "ETN-2026-000123",
"originOrderCreatedAt": "2026-09-01T10:00:00+09:00",
"returnItems": [
{"itemCode": "ETN26258A001", "customerReferenceKey": "ETN-ITEM-0001"},
{"itemCode": "ETN26258A002", "customerReferenceKey": ""}
]
}