Imweb
  • 소개
  • 시작하기
    • 준비사항
    • 주의 및 제한사항
    • 문서 정보
    • 액세스 토큰 발급받기
    • API 호출 예제
    • API 응답 코드
    • API 오류 코드
  • 상점
    • 상점 정보 조회
  • 상품
    • 상품 조회
    • 상품 등록/수정
    • 상품 삭제
    • 상품 옵션 조회
    • 상품 옵션 수정
    • 상품 상세 옵션 조회
    • 상품 상세 옵션 수정
    • 상품 카테고리 조회
    • 네이버 카테고리 조회
    • 상품 기획전 조회
  • 구매평
    • 상품 구매평 조회
    • 상품 구매평 수정
  • 문의
    • 상품 문의 조회
    • 상품 문의 답변
  • 주문
    • 주문 조회
    • 운송장 입력
    • 주문 처리
    • 취소 처리
    • 반품 처리
    • 교환 처리
    • 품목 주문 목록 조회
    • 여러 품목 주문 목록 조회
    • 품목 주문 처리
    • 품목 주문 운송장 입력
    • 품목 주문 운송장 조회
  • 회원
    • 회원 조회
    • 회원 등록
    • 회원 수정
  • 쿠폰
    • 쿠폰 조회
    • 쿠폰 발행 정보 조회
  • 부록
    • 지원 택배사
    • 상품정보제공고시
Powered by GitBook
On this page
  • 목록 요청 데이터
  • 응답 데이터
  • OrderDevice Data
  • OrderOrderer Data
  • OrderDelivery Data
  • OrderAddress Data
  • OrderPayment Data
  • OrderReceipt Data
  • OrderForm Data
  • 입력폼 항목 사용자 입력값 예시

Was this helpful?

  1. 주문

주문 조회

GET https://api.imweb.me/v2/shop/orders

GET https://api.imweb.me/v2/shop/orders/{주문번호}

목록 요청 데이터

주문서 목록 조회 시 검색 조건을 전달할 수 있습니다.

주문서 상태에 관련된 필터는 1개만 사용 가능합니다. (status, claim_type, claim_status)

주문관리 v2는 기간 정보를 입력하지 않으면 현재 날짜 기준 3달 전 데이터가 조회됩니다.

항목
타입
설명

type

String

주문 매체

  • normal: 아임웹 주문

  • npay: 네이버 주문

  • talkpay: 카카오톡 주문

order_date_from

Integer

주문일(시작일)

Timestamp

order_date_to

Integer

주문일(종료일)

Timestamp

status

String

주문서 상태

  • PAY_WAIT: 입금대기

  • PAY_COMPLETE: 결제완료

  • STANDBY: 배송준비중/배송대기

  • DELIVERING: 배송중

  • COMPLETE: 배송완료

  • CANCEL: 취소완료

  • RETURN: 반품완료

  • EXCHANGE: 교환완료

  • PURCHASE_CONFIRMATION: 구매확정 (주문관리 v2 전용)

claim_type

String

주문서 클레임 타입

  • CANCEL: 취소

  • RETURN: 반품

  • EXCHANGE: 교환

claim_status

String

주문서 클레임 상태

  • CANCEL_REQUEST: 취소요청

  • CANCELING: 취소요청중

  • CANCEL_FAILED: 취소 실패

  • RETURN_REQUEST: 반품요청

  • RETURN_COLLECTING: 반품수거중

  • RETURN_COLLECT_DONE: 반품수거완료

  • RETURN_REFUNDING: 반품환불진행중

  • RETURN_REFUND_FAILED: 반품환불실패

  • EXCHANGE_REQUEST: 교환요청

  • EXCHANGE_COLLECTING: 교환수거중

  • EXCHANGE_COLLECT_DONE: 교환수거완료

  • REDELIVERING: 교환재배송중

member

String

회원코드

orderer_call

String

주문자 전화번호

order_version

String

조회할 주문 버전

  • v1 (기존 주문)

  • v2 (신규 주문 시스템)

응답 데이터

항목
타입
설명

order_no

String

주문번호

is_gift

String

선물하기 주문 여부

  • Y : 선물하기 주문

  • N : 일반 주문

device

Array

주문기기 정보

order_time

Integer

주문 시각

Timestamp

complete_time

Integer

전체 상품 배송완료 시각

Timestamp

orderer

Array

주문자 정보

delivery

Array

배송지 정보

payment

Array

결제 정보

cash_receipt

Array

현금영수증 정보

form

Array

결제입력폼 정보

use_issue_coupon_codes

Array

주문에 사용된 발행쿠폰코드 목록

app

String

앱 정보

  • android: 안드로이드

  • ios: 아이폰

device_code

String

디바이스 코드

OrderDevice Data

항목
타입
설명

type

String

주문 기기 타입

  • pc: PC

  • mobile: Mobile

OrderOrderer Data

항목
타입
설명

member_code

String

회원 코드

name

String

주문자명

email

String

주문자 메일주소

call

String

주문자 연락처1

call2

String

주문자 연락처2

OrderDelivery Data

항목
타입
설명

country

String

배송국가

country_text

String

배송국가 한글명

address

Array

배송지 정보

memo

String

배송 메모

unipass_number

String

개인통관고유부호

OrderAddress Data

항목
타입
설명

name

String

수령인명

phone

String

수령인 연락처1

phone2

String

수령인 연락처2

postcode

String

우편번호

address

String

주소

address_detail

String

상세주소

address_street

String

영문주소 - 거리주소

address_building

String

영문주소 - 건물명

address_city

String

영문주소 - 도시명

address_state

String

영문주소 - 도시군

OrderPayment Data

항목
타입
설명

pay_type

String

결제 수단

  • free: 무료결제

  • card: 신용카드

  • iche: 실시간 계좌이체

  • virtual: 가상계좌

  • cash: 무통장입금

  • phone: 핸드폰 결제

  • payco: 페이코

  • kakaopay: 카카오페이

  • paypal: 페이팔

  • eximbay: 엑심베이

  • eb_atrpay: 알리페이

  • eb_molpay: 몰페이

  • eb_wechatpay: 위쳇페이

  • eb_econtext: 편의점결제

  • easy_payment_card: 신용카드 간편결제

  • easy_payment_virtual: 계좌 간편결제

  • easy_payment_phone: 휴대폰 간편결제

  • npay: 네이버페이

  • talkcheckout: 톡체크아웃

  • samsungpay: 삼성페이

  • toss: 토스페이

  • ssgpay: 신세계페이

  • lpay: L페이

  • kbpay: KB앱페이

  • chipay: 차이페이

  • tmoneypay: 티머니페이

  • pinpay: 핀페이

  • applepay: 애플페이

  • etc: 그 외 결제수단

pg_type

String

PG 타입

  • kcp: NHN KCP

  • inicis: KG 이니시스

  • nicepay: 나이스페이

  • paynuri: 페이누리

  • paypal: 페이팔

  • eximbay: 엑심베이

  • allatpay: 올앳페이

  • ags: 올더게이트

  • uplus: LG유플러스

  • ksnet: KSNet

deliv_type

String

배송방법

  • parcel: 택배

  • direct: 직접배송

  • quick: 퀵배송

  • visit: 방문수령

  • no_deliv: 배송없음

  • download: 디지털 컨텐츠

  • subscribe: 회원그룹 이용권

deliv_pay_type

String

배송비 결제방식

  • price: 선결제

  • deliv_price_after: 착불

price_currency

String

통화

total_price

Float

총 결제금액

price_tax_free

Float

면세 금액

price_sale

Float

상품 자체 할인 금액

deliv_price

Float

배송비

point

Float

사용 적립금

coupon

Float

쿠폰 할인액

membership_discount

Float

회원 그룹 할인액

period_discount

Float

즉시/기간 할인액

payment_amount

Float

실제 결제 금액

OrderReceipt Data

항목
타입
설명

request

String

현금영수증 신청 여부

  • AUTO: 자동 발행

  • Y: 신청

  • N: 미신청

type

String

현금영수증 종류

  • deducation: 소득공제용

  • proof: 지출증빙용

value

String

현금영수증 신청 정보

status

String

현금영수증 처리 상태

  • WAIT: 처리 대기

  • COMPLETE: 처리 완료

complete_date

String

현금영수증 발행일

Timestamp

OrderForm Data

항목
타입
설명

type

String

입력폼 타입

  • text: 한 줄 텍스트

  • textarea: 여러 줄 텍스트

  • radio: 단일선택

  • select: 목록선택

  • checkbox: 복수선택

  • date: 날짜형식

  • time: 시간형식

  • file: 파일 업로드

title

String

입력폼 항목 제목

desc

String

입력폼 항목 설명

value

String

입력폼 항목 사용자 입력값

입력폼 항목 사용자 입력값 예시

text, textarea, radio, select, date, time (string)

[value] => 홍길동

checkboxarray (string)

[value] => Array
(
	[0] => 농구
	[1] => 배구
)

file (array)

file 타입에서 URL은 주문서 조회 API를 호출한 IP에서만 접근 가능합니다.

[value] => Array
(
	[name] => 파일명
	[url] => /shop_form_file_download.cm?secret={secret}
	[size] => 파일용량
)
Previous상품 문의 답변Next운송장 입력

Last updated 7 months ago

Was this helpful?

참고

OrderDeviceData
OrderOrdererData
OrderDeliveryData
OrderPaymentData
OrderReceiptData
OrderFormData
OrderAddressData
입력폼 항목 사용자 입력값 예시