GuideReference

주문 이해하기

본 문서의 Open API는 아임웹 주문관리시스템 v2에 대해 제공됩니다.

한층 유연하고 편리해진 주문관리시스템Copied!

오프라인에서 발생하는 여러 전자상거래 상황을 온라인에서도 대응할 수 있는 경험에 집중했습니다.
더욱 안전하고 확장성 있는 주문관리시스템을 지원합니다.
아임웹 Open API도 변경된 주문 구조에 최적화된 주문 API를 제공합니다.

주문 구조Copied!

신규 주문관리시스템은 주문 - 품목의 구조 중간에 ‘주문섹션’이 추가되어 아래와 같은 3 depth 구조로 구성됩니다.

1. 주문

주문 체계의 최상위 단위입니다. 주문의 결제 상태 및 데이터가 관리됩니다.

2. 주문 섹션

주문 체계의 두번째 단위입니다. 섹션아이템의 배송상태를 그룹화하는 개념입니다.
주문섹션을 통해 배송 상태 조회 및 처리가 가능합니다.

3. 주문 섹션아이템

주문 체계의 마지막 단위입니다. 섹션아이템은 별도의 상태를 갖고 있지 않습니다.

섹션 알아보기Copied!

아임웹 주문관리시스템의 핵심은 섹션의 유동성입니다.
하나의 주문은 여러 개의 섹션을 가질 수 있고, 이 섹션들은 각각 여러 개의 섹션아이템을 가질 수 있습니다.
기존 시스템에서는 처리할 수 없었던 다양한 경우의 수를 신규 주문시스템의 섹션을 활용하여 처리할 수 있습니다.

섹션이 왜 필요하나요?Copied!

예시 주문입니다.
상품A 2개, 상품B 4개의 주문에 대해 [상품A 1개 + 상품B 2개] 각각 패키징하여 송장 입력을 하고자 합니다.

기존 구조에서는 아래와 같이 상품(품목)별로 송장번호를 입력해야하기에 이런 작업을 적절하게 처리할 수 없습니다.
상품A 2개 중 1개를 반품 또는 교환해야하는 경우에도, 시스템 상에서는 상품A 2개를 전부 반품 또는 교환하는 것밖에 지원되지 않았습니다.


아임웹에서는 이런 다양한 커머스 상황들을 유연하게 대응하기 위해 ‘주문섹션’ (이하 섹션) 개념을 도입하였습니다.
동일한 주문상태와 송장번호가 입력되어야하는 상품의 그룹을 섹션으로 그룹핑하여 처리할 수 있습니다.
이 중 하나의 상품을 반품 또는 교환해야하는 경우에도 섹션이 유동적으로 변경되며 새로운 상태를 관리할 수 있습니다.

섹션의 상태 변경은 어떻게 요청하나요?Copied!

부분 출고 또는 부분 취소/ 교환/ 반품이 필요한 상황에서 섹션을 활용할 수 있습니다.

배송처리

이 작업은 주문/ 주문섹션/ 주문섹션아이템 단위의 배송처리 API를 사용할 수 있습니다.
모든 배송 상태는 섹션의 상태를 다루는 parameter인 orderSectionStatus를 사용하여 요청해주세요.
배송 대기, 배송중, 배송완료 상태를 적용할 수 있습니다.

예시) 주문 배송처리 API

주문 섹션아이템 배송처리

부분 출고를 처리하고자 하는 경우, 주문 섹션아이템 배송 처리 API를 사용해서
부분 출고 하고자 하는 섹션아이템 정보를 포함하여 상태 변경 요청을 할 수 있습니다.

요청한 섹션아이템을 포함한 새로운 섹션이 생성되며 해당 섹션의 상태을 유동적으로 관리할 수 있습니다.

주문 취소 / 반품 접수

전체 상품 또는 일부 상품만 취소/ 반품 접수 하고자 하는 경우 주문/ 섹션 단위로 요청할 수 있습니다.
경우에 따라 별도의 섹션이 생기거나, 기존 섹션의 상태가 변경될 수 있습니다.

주문 정보 조회하기Copied!

주문번호를 기준으로 주문 목록 조회 요청 시 하위 구성 정보인 주문 섹션, 주문 섹션아이템의 정보도 함께 응답됩니다.

보다 상세한 기준으로 조회하고 싶을 경우, 주문섹션 목록조회, 주문 섹션아이템 목록조회를 사용할 수 있습니다.

주문 조회 단위별 응답 구성

요청 단위

응답

주문

order
orderSection

orderSectionItem

주문 섹션

orderSection

orderSectionItem

주문 섹션아이템

orderSectionItem

데이터 구성 빠르게 파악하기Copied!

대략적인 구성을 빠르게 파악하실 수 있도록 대표적인 응답값 구성을 안내드립니다.

주문 응답 파라미터 구성

구분

항목

주문 자체에 대한 정보

  • 주문번호 orderNo

  • 회원 주문 여부 isMember

  • 주문 상태 코드 orderStatus

  • 그 외 문서 참고

결제 금액에 대한 정보

  • 쿠폰 할인 금액 itemCouponDiscount

  • 포인트 사용액 itemPointAmount

  • 배송비 deliveryPrice

  • 총 실결제 금액 totalRefundPrice

  • 그 외 문서 참고

결제 정보 payments

  • 결제 PG사 pgName

  • 결제 수단 method

  • 결제 상태 paymentStatus

  • 결제 금액 paidPrice

  • 그 외 문서 참고

Form 정보 FormData

  • 입력폼 정보로 구성

섹션 정보 sections

  • 하단 표 참고

주문 섹션 응답 파라미터 구성 sections

구분

항목

주문 섹션에 대한 정보

  • 섹션코드 orderSectionCode

  • 섹션 상태 orderSectionStatus

  • 배송 타입 deliveryType

  • 발송 처리 일시 deliverySendTime

  • 그 외 문서 참고

배송 정보 delivery

  • 수령자명 receiverName

  • 수령자 전화번호 receiverCall

  • 주소 addr1

  • 메모 memo

  • 그 외 문서 참고

운송장 정보 invoice

  • 송장번호 invoiceNo

  • 택배사 번호 parcelCompanyIdx

  • 송장 추적 여부 isTracking

  • 그 외 문서 참고

(취소 시) 취소 정보 cancelInfo

  • 취소 사유 cancelReason

  • 환불 가격 타입 refundPriceType

  • 그 외 문서 참고

(반품 시) 반품 정보 refundInfo

  • 송장번호 invoiceNo

  • 택배사 번호 parcelCompanyIdx

  • 수거타입 retrieveType

  • 수거완료 여부 isRetrieved

  • 그 외 문서 참고

섹션아이템 정보 orderSectionItems

  • 하단 표 참고

주문 섹션아이템 응답 파라미터 구성 orderSectionItem

주문 섹션아이템에 대한 정보

  • 섹션아이템 번호 orderSectionItemNo

  • 수량 qty

  • 쿠폰 할인 금액 itemCouponDiscount

  • 그 외 문서 참고

상품 정보 productInfo

  • 상품 번호 prodNo

  • 상품 명 prodName

  • 단가 (할인 전) baseItemPrice

  • 단가 (할인 후) itemPrice

  • 그 외 문서 참고

Copied!