Search

주문 정보 단건 수정

API
/v1/orders/:order_id
DESCRIPTION
주문접수 이후 수취인, 발송인, 상품 정보 등 주문 정보 수정
METHOD
PUT
Search
Linkport
Linkport
IOrder 자료구조
IOrder 자료구조
배송타입
배송타입
주문/CS 상태
주문/CS 상태
주문 단건 접수
주문 단건 접수
주문 여러건 접수
주문 여러건 접수
주문 단건 조회
주문 단건 조회
주문 여러건 조회
주문 여러건 조회
주문 정보 단건 수정
주문 정보 단건 수정
주문 상태 단건 변경
주문 상태 단건 변경
주문 상태 여러건 변경
주문 상태 여러건 변경
주문 나누기
주문 나누기
주문 합치기
주문 합치기
배송추적 조회 V1
배송추적 조회 V1
배송추적 조회 V2
배송추적 조회 V2
수출신고 조회
수출신고 조회
배송추적 Push
배송추적 Push
•
inbound (물류센터 입고완료) 이전까지만 가능합니다.
•
수정할 field 만 있으면 됩니다.

API

/v1/orders/:order_id

/v1/orders?receipt_no=IC000000

/v1/orders?no_info1=ICSORDER202400000

METHOD

PUT\color{#4281DB}\colorbox{#DFE7F3}{\scriptsize\textsf{PUT}}

REQUEST

header

인증

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

parameter

아래 3개 필드 중 하나는 필수로 제공해야 합니다.
필드
필수
설명
order_id
필수\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}
• 주문 API의 고유 _id
receipt_no
필수\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}
• 주문시 시스템이 반환한 접수번호
no_info1
필수\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}
• 주문시 제공한 주문번호1

body

Search
필드명
타입
설명
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)
세금식별번호 (수출신고 시 필수)
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
memo
VARCHAR (1000)
배송 메모
Open
parcels
JSON array
주문의 상품 상세 정보
Open
name
VARCHAR (200)
상품명
Open
customs_code
VARCHAR (50)
세관등록 코드 (중국의 경우 무역법상 통관 이전 사전에 상품정보를 세관에 등록이 필요)
Open

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 응답의 실제 데이터
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

요청 /v1/orders/66

Response

SUCCESS

결과

Fail

결과