19.1. bmrmember-order GET
주문[Order] 목록을 조회
권한이 부여된 브랜드[ecommerce]의 주문만 조회 가능
GET[DOMAIN]/api/bmrmember-order/?page={PAGE}
PAGE: 조회할 페이지 번호- Headers:
Api-Key: {APIKEY}
조회 조건 파라미터 (Query String)
모두 선택값이며, 여러 개 지정 시 AND 조건으로 결합됩니다.
| 파라미터 | 설명 |
|---|---|
page_size | 페이지 당 주문 수 (기본 30, 최대 100) |
ordering | 정렬 기준 필드. createdAt, receivedAt, inspectedAt, completedAt, bulkNumber, pickupName 중 선택, 내림차순은 - 접두 (예: ordering=-createdAt). 기본값 -createdAt |
bulkNumber_exact / bulkNumber | 주문번호 (일치 / 부분일치) |
orderNumber_exact / orderNumber | 송장번호 또는 주문번호 일치 / 송장번호 부분일치 |
customerNumber_exact / customerNumber | 고객주문번호 (일치 / 부분일치) |
customerReferenceKey_exact / customerReferenceKey | 고객사 참조키 (일치 / 부분일치) |
itemCustomerReferenceKey_exact / itemCustomerReferenceKey | 반품 아이템 단위 고객사 참조키 (일치 / 부분일치, 해당 아이템을 1개 이상 포함한 주문) |
originOrderNumber_exact / originOrderNumber | 원 송장번호 (일치 / 부분일치) |
ecommerceId | 브랜드 ID (쉼표로 여러 개 지정 가능, 예: ecommerceId=AAA,BBB) |
statuses | 주문 상태 (쉼표로 여러 개 지정 가능, 예: statuses=placed,pickedup) |
itemCode / productCode / productName | 반품 아이템의 아이템코드 / 제품코드 / 제품명 부분일치 (해당 아이템을 포함한 주문) |
confirm | 반품 아이템 상태값[confirm] (해당 상태의 아이템을 포함한 주문) |
pickupName | 픽업지 고객명 부분일치 |
entryChannelName | 주문 접수 경로명(판매 플랫폼) 부분일치 |
| 기간 필터 | 값 형식 YYYY-MM-DD, 시작일/종료일 각각 단독 사용 가능: created_start_date / created_end_date (주문 접수일), received_start_date / received_end_date (검품센터 입고일), inspected_start_date / inspected_end_date (검품 완료일), completed_start_date / completed_end_date (고객사 입고 완료일), originOrderCreated_start_date / originOrderCreated_end_date (원 주문 접수일) |
search | 통합 검색 (2자 이상. 주문번호, 송장번호, 고객주문번호, 아이템코드 등 식별값 일치 우선, 없으면 부분일치) |
호출 예시:
[DOMAIN]/api/bmrmember-order/?customerReferenceKey_exact=REF-2026-001&statuses=placed,pickedup&created_start_date=2026-09-01&page_size=50
호출 결과 코드
| status | 설명 |
|---|---|
SUCCESS | 성공 |
FAIL | 실패 |
반환값
| 필드 | 설명 |
|---|---|
count | 전체 조회건수 |
next | 다음 페이지, 없을 경우 null |
previous | 이전 페이지, 없을 경우 null |
lastPage | 마지막 페이지 번호 |
current | 현재 조회 페이지의 조회건수 |
countItemsOnPage | 페이지 당 주문 수 |
currentPage | 현재 페이지 번호 |
results | 주문 목록 (아래 표) |
results (주문)
| 파라미터 명 | 필수 | 데이터 타입 | 값 | 비고 |
|---|---|---|---|---|
bulkNumber | 필수 | String | 주문 번호 | 영문 대문자·숫자 혼합 12자리. 채번 규칙 YY3650000000 — YY: 연도 뒷 두자리, 365: 365일 중 순서, 0000000: 일련번호 7자리 |
customerNumber | 필수 | String | 브랜드 주문번호 | |
orderNumber | 필수 | String | 송장번호 | max length=20 |
pickupName | 필수 | String | 픽업지 고객명 | max length=50 |
pickupAddress | 필수 | String | 픽업지 주소 | max length=100 |
pickupAddressDetail | String | 픽업지 상세주소 | max length=100, default='' | |
pickupContact | 필수 | String | 픽업지 연락처 | max length=50, default='' |
ecommerce | 필수 | Object | 반품 브랜드 | ecommerceId, name, url, isInspection, isUsePickupService, returnAddress, owner_account, parentEcommerceId 등 (1. 브랜드 참조) |
ecommerceName | 필수 | String | 반품 업체명 | max length=50 |
courierName | String | 배송기사 | 1~30글자 | |
courierPhoneNumber | String | 배송기사 연락처 | 전화번호 | |
returnItems | Array | 반품 아이템 목록 | 반품 아이템 (returnItem) 참조 | |
requestInspect | String | 검품 요청사항 | ||
pickupMemo | String | 픽업 메모 | 수거 운송장 배송메시지. max length=100 | |
dropoffMemo | String | 반품지 메모 | max length=100 | |
statuses | String | 주문 상태 | 주문 상태 코드 참조 | |
statusesHistory | Array | 주문 상태 변경 이력 | 각 항목: statuses (이전 주문 상태), createdAt (변경 일시) | |
createdAt | DateTime | 주문 접수 시각 | 자동 생성 | |
cancelledAt | DateTime | 주문 취소 시각 | null 가능 | |
completedAt | DateTime | 배송 완료 시각 | null 가능 | |
receivedAt | DateTime | 검품센터 입고 시각 | null 가능 | |
isCompleted | Boolean | 주문 완료 여부 | default=false | |
isCancellable | Boolean | 취소가능여부 | default=false | |
boxType | String | 박스 타입 | 박스 타입 코드 참조. 가로세로높이의 합, 무게 조건 중 더 높은 등급 | |
boxTypeC | String | 고객입력 박스타입 | 접수 시 전달한 값 | |
boxQuantity | Integer | 박스 수량 | ||
boxWidth / boxDepth / boxHeight | Float | 박스 가로 / 세로 / 높이 | ||
isOneStop | Boolean | 원스톱배송 여부 | true면 검품센터를 거치지 않고 목적지(drop*)로 직송. 접수 시 결정된 목적지가 dropName/dropAddress/dropAddressDetail/dropZipcode/dropPhoneNumber로 회신됨 (BMR-869) | |
picturesInspect | Array | 검품 사진 | 리터니즈 검품원이 입력. 검품 사진 URL | |
reasonNorefund | String | 환불불가사유 | ||
inspectorNote | String | 검품원 의견 | 상품 훼손 / 상품이 다름 / 기타 사유 | |
dropRejectReason | String | 미집하사유 | ||
entryChannelName | String | 주문 접수 경로명 | 판매 플랫폼 | |
externalServiceExchangeReturn | String | 외부 서비스 교환/반품 | exchange: 교환 / return: 반품 / '': 미입력. 연동 쇼핑몰(CAFE24, 메이크샵 등) 주문은 접수 시 쇼핑몰 주문 상태(CAFE24 R__=반품/E__=교환 등)로 자동 채워짐. API 접수(POST) 시 직접 전달한 값이 있으면 그대로 반환 | |
originOrderNumber | String | 원 송장번호 | 최초 상품 출고에 사용된 원 주문의 송장번호. 주문 접수(POST) 또는 참조정보 수정(PATCH reference-info)으로 기록. 미기록 시 '' (BMR-740) | |
originOrderCreatedAt | DateTime | 원 주문 접수일 | 최초 상품 출고에 사용된 원 주문의 접수일. 미기록 시 null (BMR-845) | |
customerReferenceKey | String | 고객사 참조키 | 고객사(브랜드 BO)가 기록한 임의의 참조 코드. max length=100. 주문 접수(POST) 또는 참조정보 수정(PATCH reference-info)으로 기록 (BMR-845). 반품 아이템 단위 참조키는 returnItems[].customerReferenceKey 참조 (BMR-865) | |
outBox | Object | 출고 박스 | 출고 박스 (outBox) 참조 |
호출 결과 예시
{
"status": "SUCCESS",
"next": "https://ytrack.kr:7981/api/bmrmember-order?page=2",
"previous": null,
"lastPage": 3,
"countItemsOnPage": 10,
"currentPage": 1,
"results": [
{
"bulkNumber": "20231117000010",
"orderNumber": "0001",
"customerNumber": "123123261514",
"customerReferenceKey": "ETN-2026-000123",
"originOrderNumber": "",
"originOrderCreatedAt": null,
"pickupName": "TEST7",
"pickupAddress": "부산광역시 성북구 대사관로8길 12132(성북동)",
"pickupAddressDetail": "",
"pickupContact": "",
"ecommerce": {
"ecommerceId": "AAA",
"name": "브랜드 A",
"url": null,
"isInspection": false,
"isUsePickupService": true,
"parentEcommerceId": null,
"returnAddress": [
{
"id": 1,
"location": "hq",
"address": "대구광역시",
"addressDetail": "",
"postalCode": "",
"createdAt": "2023-10-24T20:36:43+09:00",
"updatedAt": "2023-10-24T20:36:43+09:00",
"deletedAt": null
}
],
"owner_account": {
"id": 1,
"accountType": "warehouse",
"companyName": "주식회사 테스트 업체",
"bizNo": "123-45-67890"
},
"createdAt": "2023-10-24T20:36:17+09:00",
"updatedAt": "2023-10-24T20:36:17+09:00",
"deletedAt": null
},
"courierName": "",
"courierPhoneNumber": "",
"dropRejectReason": "",
"requestInspect": "",
"pickupMemo": "",
"dropoffMemo": "",
"statuses": "placed",
"statusesHistory": [
{"statuses": "placed", "createdAt": "2023-11-17T18:14:30.607566+09:00"}
],
"createdAt": "2023-11-17T18:14:30.607566+09:00",
"cancelledAt": null,
"completedAt": null,
"isCompleted": false,
"isCancellable": false,
"boxType": "",
"boxTypeC": "",
"boxQuantity": 1,
"resultRequest": "",
"inspectorNote": "",
"receivedAt": null,
"isOneStop": false,
"entryChannelName": "",
"externalServiceExchangeReturn": "return",
"returnItems": [
{
"bulkNumber": "20240923000336",
"itemCode": "AAA24267A110",
"isBundle": false,
"productName": "테스트 물품",
"option": "L",
"requestMemo": "",
"quantityOrder": 1,
"productPrice": 0,
"customerReferenceKey": "ETN-ITEM-0001",
"inspectorNote": "",
"gifts": [
{"id": 101, "name": "쇼핑백", "productCode": "", "returned": true},
{"id": 102, "name": "샘플파우치", "productCode": "G-01", "returned": false}
],
"giftReturned": true,
"statusInspect": "not_completed",
"reasonItemDamaged": [],
"inspectPackage": "",
"inspectProduct": "",
"inspectContents": "",
"statusInspectRequest": "",
"product": null,
"outBox": null,
"inspectImages": [],
"lastInspectAt": null,
"confirm": "wait",
"outAt": null,
"shippingAllowedAt": null,
"categories": [],
"inspectionGuideCategory": ""
}
],
"outBox": {
"boxCode": "RTN-C-240712000004",
"boxType": "D",
"trackingNumber": "888811114765",
"outAt": "2023-10-26T15:36:17+09:00",
"dropName": "구매자1",
"dropAddress": "구매자 주소1",
"dropAddressDetail": "구매자 상세주소1",
"dropZipcode": "77232",
"dropPhoneNumber": "010-2323-2232"
}
}
]
}