Search

주문 단건 조회

3 more properties
Search
Linkport
Linkport
IOrder 자료구조
IOrder 자료구조
배송타입
배송타입
주문/CS 상태
주문/CS 상태
주문 단건 접수
주문 단건 접수
주문 여러건 접수
주문 여러건 접수
주문 단건 조회
주문 단건 조회
주문 여러건 조회
주문 여러건 조회
주문 정보 단건 수정
주문 정보 단건 수정
주문 상태 단건 변경
주문 상태 단건 변경
주문 상태 여러건 변경
주문 상태 여러건 변경
주문 나누기
주문 나누기
주문 합치기
주문 합치기
배송추적 조회 V1
배송추적 조회 V1
배송추적 조회 V2
배송추적 조회 V2
수출신고 조회
수출신고 조회
배송추적 Push
배송추적 Push

API

/v1/orders/:order_id

/v1/orders

METHOD

GET\color{green}\colorbox{#d1ffbd}{\scriptsize\textsf{GET}}

REQUEST

header

인증

필수\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}

query

필드
필수
설명
_id
선택\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}
주문정보 _id 값 조회 다수의 번호를 조회하려면, , 으로 복수의 접수번호 요청
state
선택\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}
배송 요청 및 입고 상태별 조회
states
선택\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}
주문 상태 복수 조회 /v1/orders?states=requested,confirmed •all 로 지정하면 모든 상태의 주문 정보 조회
receipt_no
선택\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}
접수번호로 조회 다수의 번호로 조회하려면 , 로 복수의 접수번호 요청
waybill_no
선택\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}
운송장 번호로 조회 다수의 번호로 조회하려면 , 로 복수의 운송장 번호 요청
no_info1
선택\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}
셀러가 등록한 주문 정보의 no_info1 값으로 검색 다수의 번호로 조회하려면 , 로 복수의 주문 번호 요청

RESPONSE

•
필수\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}} field 는 조회 시 반드시 존재합니다.
•
선택\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}} field 는 조회 시 존재하지 않을 수 있습니다.
Search
필드명
필수
타입
설명
_id
필수
BIGINT
시스템에서 관리하는 고유 ID 값
Open
no_info1
필수
VARCHAR (50)
주문번호 #1
Open
no_info2
선택
VARCHAR (50)
주문번호 #2
Open
state
필수
VARCHAR (20)
주문정보 처리 상태
Open
cs
선택
VARCHAR (20)
CS 상태
Open
receipt_no
선택
VARCHAR (50)
주문 접수 번호 (가송장 번호)
Open
waybill_no
선택
VARCHAR (50)
주문 송장 번호
Open
waybill_no1
선택
VARCHAR (50)
재배송 송장 번호1
Open
waybill_no2
선택
VARCHAR (50)
재배송 송장 번호2
Open
country
필수
VARCHAR (20)
배송국가코드
Open
type_code
필수
VARCHAR (20)
배송타입코드 (사전에 협의한 알파벳 코드 값)
Open
courier
필수
VARCHAR (100)
배송사/운송사 정보
Open
sender
JSON
발송인 정보
Open
name1
필수
string
발송인명 (영문으로 입력)
Open
name2
선택
string
발송인명 (현지 언어 등)
Open
phone
필수
string
전화번호
Open
mobile
선택
string
핸드폰번호 (전화번호가 있으면 옵션 항목)
Open
zipcode
선택
string
우편번호
Open
addr_state
선택
string
주소 (성 / STATE) 특정국가(CN) 제외 필수 입력
Open
addr_city
선택
string
주소 (시 / CITY) 특정국가(CN) 제외 필수 입력
Open
addr_gu
선택
string
주소 (구) 없는 경우 공백
Open
addr2
필수
string
전체 주소 반드시 영문으로 입력
Open
email
선택
string
이메일 주소
Open
purchaser
JSON
구매자 정보
Open
name1
선택
string
구매자명 (영문으로 입력)
Open
name2
선택
string
구매자명 (현지 언어 등)
Open
phone
선택
string
전화번호
Open
mobile
선택
string
핸드폰번호 (전화번호가 있으면 옵션 항목)
Open
zipcode
선택
string
우편번호
Open
addr_state
선택
string
주소 (성 / STATE)
Open
addr_city
선택
string
주소 (시 / CITY)
Open
addr_gu
선택
string
주소 (구)
Open
addr2
선택
string
전체 주소 반드시 영문으로 입력
Open
email
선택
string
이메일 주소
Open
recipient
JSON
수신자 정보
Open
id_no
선택
string
신분번호
Open
name1
필수
string
수취인명 (영문으로 입력)
Open
name2
선택
string
수취인명 (현지 언어 등)
Open
phone
필수
string
전화번호
Open
mobile
선택
string
핸드폰번호 (전화번호가 있으면 옵션 항목)
Open
zipcode
필수
string
우편번호
Open
addr_state
필수
string
주소 (성 / STATE) 특정국가(CN) 제외 필수 입력
Open
addr_city
필수
string
주소 (시 / CITY) 특정국가(CN) 제외 필수 입력
Open
addr_gu
선택
string
주소 (구) 없는 경우 공백
Open
addr2
필수
string
전체 주소 반드시 영문으로 입력
Open
email
선택
string
이메일 주소
Open
tax_no
선택
VARCHAR (30)
세금식별번호 (EU국가 : ioss번호 / GB : EORI 번호 / BR, ID : 세금식별번호 / 이외 국가 : TAX NUMBER)
Open
incoterms
선택
VARCHAR (10)
국제무역조건 ex) DAP, DDP
Open
export_no
선택
VARCHAR (15)
수출신고번호
Open
extra
JSON
사용자 데이터
Open
data1
선택
string
사용자 데이터1
Open
data2
선택
string
사용자 데이터2
Open
data3
선택
string
사용자 데이터3
Open
payment
JSON
구매자 결제 데이터
Open
delivery
선택
string
고객결제배송비
Open
purchaser
선택
string
구매자결제금액
Open
weight
선택
DECIMAL (20, 5)
합포장 상품(parcels)의 총 무게 합
Open
price
선택
DECIMAL (30, 5)
합포장 상품(parcels)의 총 가격
Open
count
필수
INTEGER
합포장 상품(parcels)의 갯수
Open
currency
선택
VARCHAR (20)
주문정보의 통화
Open
clone
선택
VARCHAR (20)
반품 또는 재배송의 경우 구분 값
Open
memo
선택
VARCHAR (1000)
배송 메모
Open
volume
JSON
주문 실제 무게, 부피 무게, 적용 무게 등 정보
Open
width
선택
float
넓이 (cm)
Open
height
선택
float
높이 (cm)
Open
length
선택
float
길이 (cm)
Open
weight
선택
float
실제 무게 (kg)
Open
volume
선택
float
부피 무게 (kg)
Open
chargeable
선택
float
시스템에 요청하는 적용 무게(kg)시스템에서 실제로 사용하는 값은 아님요청하는 값을 사용할지 여부는 시스템이 판단함시스템에서는 weights의 chargeable 값을 사용함
Open
weights
JSON
물류센터 입고완료 후 측정한 무게 관련 정보
Open
net
선택
float
순중량, 상품정보에 있는 무게 총합(kg)
Open
gross
선택
float
총중량, 물류센터에서 측정한 실제 무게(kg)
Open
volume
선택
float
부피무게, 물류센터에서 즉정한 주문 박스의 부피 무게(kg)
Open
chargeable
선택
float
적용무게, 실제무게와 부피무게 중에서 큰 값(kg)
Open
parcels
JSON array
주문의 상품 상세 정보
Open
_id
필수
BIGINT
시스템에서 관리하는 고유 ID 값
Open
name
필수
VARCHAR (200)
상품명
Open
quantity
필수
INTEGER
상품 수량
Open
box_count
선택
INTEGER
박스 갯수
Open
weight
필수
DECIMAL (20, 5)
상품 무게(kg)
Open
price
필수
DECIMAL (30, 5)
상품 단위 금액
Open
currency
필수
VARCHAR (20)
화폐단위
Open
sku
선택
VARCHAR (50)
SKU
Open
hscode
선택
VARCHAR (20)
HSCODE (수출신고 시 필수)
Open
brand
필수
VARCHAR (50)
브랜드명
Open
material
선택
VARCHAR (100)
상품재질
Open
customs_code
선택
VARCHAR (50)
세관등록 코드 (중국의 경우 무역법상 통관 이전 사전에 상품정보를 세관에 등록이 필요)
Open
url
선택
VARCHAR (100)
상품정보 URL
Open
is_freebie
선택
TINYINT(1)
사은품 여부 설정
Open
order_id
선택
BIGINT
주문정보 고유 _id
Open
created_at
선택
DATETIME
상품정보 생성 일시
Open
trackings
선택
JSON array
주문 배송 추적 정보
Open
changed_at
선택
DATETIME
OMS 현재 상태 변경 일시
Open

응답 규격

필드
필수
설명
code
필수\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}
API 논리적 응답 코드
message
필수\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}
human readable 응답 메시지 header의 Accept-Language 언어 설정별 메시지 출력 (’en’, ‘ko’ 만 지원)
result
필수\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}
API 응답의 실제 데이터
host
필수\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}
API 를 처리한 서버 정보
timestamp
필수\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}
API 응답 시간
tid
필수\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}
API 호출 추적용 고유 trace id UUID 값

공통 오류

오류 코드
유형
설명
4000
BAD_REQUEST
API 요청에 사용한 값 오류
4010
UNAUTHORIZED
아래 기재된 실패 사유 이외의 로그인 실패
4011
TOKEN_EXPIRED
Token 유효기간 만료
4012
ACCOUNT_LOCKED
비밀번호 입력을 여러번 실패하여 계정 잠김
4013
TOKEN_INVALID
유효하지 않은 Token 오류
4030
FORBIDDEN
권한이 없는 리소스 접근 시도 오류
4040
NOT_FOUND
존재하지 않는 리소스 접근 시도 오류
4090
CONFLICT
이미 존재하는 리소스 고유 번호로 중복 생성 시도

EXAMPLE

Cmd/Ctrl + Option/Alt + T : 전체 열기/닫기

Request

요청

Response

SUCCESS

결과

Fail

결과