주문 단건 접수

3 more properties

API

/v1/orders

METHOD

$\color{red}\colorbox{oldlace}{\scriptsize\textsf{POST}}$

REQUEST

header

인증

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

body

body

Search

필드명

필수

타입

설명

no_info1

필수

VARCHAR (50)

주문번호 #1

no_info2

선택

VARCHAR (50)

주문번호 #2

country

필수

VARCHAR (20)

배송국가코드

type_code

필수

VARCHAR (20)

배송타입코드 (사전에 협의한 알파벳 코드 값)

currency

필수

VARCHAR (20)

주문정보의 통화

sender

JSON

발송인 정보

name1

필수

string

발송인명 (현지언어 또는 영문 입력,운송사별로 상이)

name2

선택

string

발송인명 (영문, 현지언어)

phone

필수

string

mobile

선택

string

핸드폰번호 (전화번호가 있으면 옵션 항목)

zipcode

필수

string

addr_state

선택

string

주소 (성 / STATE) 특정국가(CN) 제외 필수 입력

addr_city

선택

string

주소 (시 / CITY) 특정국가(CN) 제외 필수 입력

addr_gu

선택

string

주소 (구) 없는 경우 공백

addr2

필수

string

전체 주소 반드시 영문으로 입력

email

선택

string

이메일 주소

purchaser

JSON

구매자 정보

name1

선택

string

구매자명 (영문으로 입력)

name2

선택

string

구매자명 (현지 언어 등)

phone

선택

string

mobile

선택

string

핸드폰번호 (전화번호가 있으면 옵션 항목)

zipcode

선택

string

addr_state

선택

string

주소 (성 / STATE)

addr_city

선택

string

주소 (시 / CITY)

addr_gu

선택

string

addr2

선택

string

전체 주소 반드시 영문으로 입력

email

선택

string

이메일 주소

recipient

JSON

수신자 정보

id_no

선택

string

name1

필수

string

수취인명 (현지언어 또는 영문 입력, 운송사별로 상이)

name2

선택

string

수취인명 (영문, 현지 언어)

phone

필수

string

mobile

선택

string

핸드폰번호 (전화번호가 있으면 옵션 항목)

zipcode

필수

string

country

필수

string

addr_state

필수

string

주소 (성 / STATE) 중국(CN) 제외 필수 입력 , 미국(US) 캐나다(CA)는 약어 2자리 입력 (ex. Newyork → NY)

addr_city

필수

string

주소 (시 / CITY) 중국(CN) 제외 필수 입력

addr_gu

선택

string

주소 (구) 없는 경우 공백

addr2

필수

string

전체 주소 일본(JP),중국(CN) 제외 영문 필수 입력 일본(JP),중국(CN) 중 EMS 이용 시 영문 필수 입력

email

선택

string

이메일 주소

tax_no

선택

VARCHAR (30)

세금식별번호 (수출신고 시 필수)

incoterms

선택

VARCHAR (10)

DDU, DAP : 수취인이 세금 납부 / DDP : 발송인이 세금 납부 FEDEX - DAP or DDP / UPS - DDU or DDP

export_no

선택

VARCHAR (15)

수출신고번호

payment

JSON

구매자 결제 데이터

delivery

선택

string

고객결제배송비

purchaser

선택

string

구매자결제금액

extra

JSON

사용자 데이터

data1

선택

string

사용자 데이터1

data2

선택

string

사용자 데이터2

data3

선택

string

사용자 데이터3

memo

선택

VARCHAR (1000)

parcels

JSON array

주문의 상품 상세 정보

name

필수

VARCHAR (200)

상품명 (영문)

quantity

필수

INTEGER

box_count

선택

INTEGER

weight

필수

DECIMAL (20, 5)

상품 무게(kg) 상품무게 정보가 없을 경우, 0.1 고정값 입력

price

필수

DECIMAL (30, 5)

상품 단위 금액

currency

필수

VARCHAR (20)

sku

선택

VARCHAR (50)

hscode

선택

VARCHAR (20)

HSCODE (수출신고 시 필수)

brand

필수

VARCHAR (50)

material

선택

VARCHAR (100)

customs_code

선택

VARCHAR (50)

세관등록 코드 (중국의 경우 무역법상 통관 이전 사전에 상품정보를 세관에 등록이 필요)

url

선택

VARCHAR (100)

상품정보 URL

goods_type

선택

VARCHAR (50)

상품 타입 (NORMAL, RANDOM, SET)

origin_goods_code

선택

VARCHAR (50)

BOM 상위 goodsCode

is_freebie

선택

TINYINT(1)

사은품 여부 설정

RESPONSE

응답 규격

필드	필수	설명
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 응답의 실제 데이터
order	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	생성한 주문 정보
detail	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	오류 관련 상세 내용
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 값
AddressError	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	배송국가 JP의 주소 오류 시 받는 응답

공통 오류

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

EXAMPLE

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

Request

요청

Response

SUCCESS

결과

Fail

필수 항목이 없는 경우