19.9. bmrmember-order/bulk-order-number POST
여러 주문의 송장번호[orderNumber]를 주문번호[bulkNumber] 기준으로 한 번에 수정
- 한 번에 최대 1,000건까지 요청할 수 있습니다.
- 건별로 처리합니다. 일부 건이 실패해도 나머지 건은 수정되며, 실패 건은
results.failed에 사유와 함께 회신됩니다. 응답의status가SUCCESS여도failed_count를 확인해 주세요. - 수정 가능한 주문 상태와 송장번호 형식은 19.7. 송장번호 수정과 같습니다.
POST[DOMAIN]/api/bmrmember-order/bulk-order-number/
- Headers:
Api-Key: {APIKEY},Content-Type: application/json
요청 parameter (Body, JSON)
| 파라미터 명 | 필수여부 | 데이터 타입 | 값 | 제한 사항 |
|---|---|---|---|---|
items | 필수 | Array | 수정할 주문 목록 | 1건 이상 1,000건 이하 |
items[].bulkNumber | 필수 | String | 주문번호 | 요청 내 중복 불가 |
items[].orderNumber | 필수 | String | 새로운 송장번호 | min length=1, max length=50. 앞뒤 공백은 제거 후 저장 |
호출 결과 코드
요청 전체에 대한 결과입니다.
| status | err_code | 설명 |
|---|---|---|
SUCCESS | 요청 처리 완료. 건별 결과는 results 참조 | |
FAIL | NO_ITEMS | items 가 전달되지 않았거나 빈 목록 |
FAIL | TOO_MANY_ITEMS | items 가 1,000건 초과 |
results
| 필드 명 | 데이터 타입 | 설명 |
|---|---|---|
total_count | Integer | 요청 건수 |
updated_count | Integer | 수정 성공 건수 |
failed_count | Integer | 수정 실패 건수 |
updated[].bulkNumber | String | 주문번호 |
updated[].orderNumber | String | 수정된 송장번호 |
failed[].bulkNumber | String | 요청한 주문번호 |
failed[].orderNumber | String | 요청한 송장번호 (앞뒤 공백 제거) |
failed[].err_code | String | 실패 사유 코드 |
failed[].message | String | 실패 사유 설명 |
실패 사유 (failed[].err_code)
| err_code | 설명 |
|---|---|
NO_BULK_NUMBER | 주문번호[bulkNumber]가 전달되지 않았거나 빈 값 |
DUPLICATED_BULK_NUMBER | 같은 주문번호가 요청에 2번 이상 포함됨. 해당 주문번호의 모든 항목이 실패 처리됨 |
NOT_FOUND | 해당 주문번호가 존재하지 않음 |
NO_ORDER_NUMBER | 송장번호[orderNumber]가 전달되지 않았거나 빈 값 |
INVALID_ORDER_NUMBER | 송장번호[orderNumber]가 50자 초과 |
UNABLE_STATUSES | 주문[Order]의 상태[statuses]가 송장번호 변경 불가 (검품센터 도착[returned] 이후, 미회수[failed], 주문 취소[cancelled]) |
UPDATE_FAILED | 저장 중 오류 발생. 다시 요청해 주세요 |
호출 예시
{
"items": [
{"bulkNumber": "20230720000048", "orderNumber": "123456789012"},
{"bulkNumber": "20230720000049", "orderNumber": "123456789013"}
]
}
호출 결과 예시
{
"status": "SUCCESS",
"results": {
"total_count": 2,
"updated_count": 1,
"failed_count": 1,
"updated": [
{"bulkNumber": "20230720000048", "orderNumber": "123456789012"}
],
"failed": [
{
"bulkNumber": "20230720000049",
"orderNumber": "123456789013",
"err_code": "UNABLE_STATUSES",
"message": "송장번호를 수정할 수 없는 주문 상태입니다. (검품센터 도착)"
}
]
},
"message": "송장번호 일괄 수정이 완료되었습니다."
}
{
"status": "FAIL",
"err_code": "TOO_MANY_ITEMS",
"errors": {
"message": "한 번에 최대 1000건까지 수정할 수 있습니다."
}
}