Skip to Content
API v1.7.0 Released - Settlement order number query + partial shipment support
API ReferenceOrdersCancel Orders

Cancel Orders

취소 처리된 품목 목록을 조회합니다.

Playground에서 테스트


Endpoint

POST /vendor-api/orders/cancel

Description

취소 처리된 주문 품목 목록을 날짜 범위로 조회합니다. 인증된 입점사에 해당하는 품목만 반환되며, 브라이트몰 자사제품은 자동으로 제외됩니다. 응답에는 주문 조회 API와 동일한 필드에 취소 관련 추가 필드가 포함됩니다.


Request

Headers

HeaderRequiredDescription
Content-TypeOapplication/json
X-Vendor-Api-KeyO발급받은 API Key
X-Vendor-IdO입점사 고유 ID

Body Parameters

FieldTypeRequiredDescription
start_datestringO조회 시작일 (YYYY-MM-DD)
end_datestringO조회 종료일 (YYYY-MM-DD)
pagenumber-페이지 번호 (기본값: 1)
limitnumber-페이지당 항목 수 (기본값: 100, 최대: 100)

Request Example

curl -X POST "https://staging-brightmall-backend.certi.life/vendor-api/orders/cancel" \ -H "Content-Type: application/json" \ -H "X-Vendor-Api-Key: bm_xOpGAqgHbJQBXxBBbUIZ_bAGZk4wK2FdLgF50277PU8" \ -H "X-Vendor-Id: 01KC51ST1WSTAET481SHPH3PSY" \ -d '{ "start_date": "2026-01-01", "end_date": "2026-01-31" }'

Response

Response Example

{ "request_id": "req_mkp3can_abc123", "timestamp": "2026-01-22T06:50:00.000Z", "cancel_list": [ { "ord_no": "202601220157_000020196", "ord_prd_no": "202601220157_000020196_[1]", "cancel_date": "2026-01-23", "cancel_reason": "고객 요청", "ord_date": "2026-01-22", "pay_date": "2026-01-22", "hope_deli_sdate": null, "item_status": "pending", "order_tel": "02-1234-5678", "order_hp": "010-1234-5678", "order_id": "customer@example.com", "ord_name": "홍길동", "recv_name": "김도희", "recv_zipcode": "06234", "recv_addr1": "서울특별시 강남구 테헤란로 123", "recv_addr2": "4층", "recv_tel": "02-1234-5678", "recv_hp": "010-1234-5678", "paymethod": "카드", "ord_memo": null, "ord_price": 150000, "in_price": 150000, "ship_fee": 3000, "afterdeli": false, "ord_company": "치과의원", "ord_company_num": "123-45-67890", "ord_taxorgnum": "1234567890", "partner_code": "SEIL", "user_hname": "김영수", "user_phone": "010-9876-5432", "real_customer_info": null, "prd_name": "델리킷 Impre Kicker", "prd_match": null, "prd_code": "SEIL-001", "uitem_code": "variant-123", "item_name": "델리킷 Impre Kicker / M사이즈", "item_cnt": 2, "item_price": 75000, "trade_num": null, "trade_date": null } ], "pagination": { "page": 1, "limit": 100, "total": 1, "has_more": false } }

Response Fields

주문 조회 API의 응답 필드에 아래 취소 관련 필드가 추가됩니다. 주문 기본 필드에 대한 설명은 List Orders를 참조하세요.

취소 추가 필드

FieldTypeDescription
cancel_datestring취소일 (YYYY-MM-DD)
cancel_reasonstring취소 사유

Pagination

FieldTypeDescription
pagenumber현재 페이지 번호
limitnumber페이지당 항목 수
totalnumber전체 항목 수
has_moreboolean다음 페이지 존재 여부

Notes

  • 응답의 목록 키는 cancel_list입니다 (주문 조회의 order_list와 다름).
  • 취소된 주문에 대한 거래명세서는 settlement_type: "cancellation"으로 조회할 수 있습니다.
  • 조회 결과가 없으면 빈 배열(cancel_list: [])이 반환됩니다.
Last updated on