주문 API
주문 유효성 검사
주문 API
주문 유효성 검사
주문 유효성 검사를 통해 주문 등록 가능 여부를 확인합니다.
POST
/
open-api
/
v1
/
orders
/
validators
curl --request POST \
--url https://gw-staging.delivered.co.kr/global-ship/open-api/v1/orders/validators \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"data": [
{
"warehouseId": 1,
"sender": {
"name": "홍길동",
"contact": "01012345678"
},
"recipient": {
"country": "US",
"name": "test kim",
"contact": "1235551234",
"email": "test@domain.co.kr",
"address": "Centum jungang-ro, Haeundae-gu",
"addressDetail": "20F, 90",
"city": "Busan",
"state": "Busan",
"zipCode": "48059",
"personalCustomsClearanceCode": "1234567890"
},
"orderInfo": {
"mallOrderNumber": "ORDER202501010001",
"carrier": "FEDEX",
"incoterms": "DAP",
"domesticShippingNumber": "65434235223",
"isExportDeclaration": true,
"exportPurpose": "SAMPLE"
},
"packageInfo": {
"width": 11.76,
"length": 11.76,
"height": 11.76,
"actualWeight": 3.26,
"quantity": 1,
"serviceType": "POD"
},
"items": [
{
"name": "test item",
"price": 10000,
"currency": "KRW",
"quantity": 1,
"actualWeight": 3.22,
"hscode": "1234567890",
"itemUrl": "https://www.delivered.co.kr/en",
"itemCode": "1234567890"
}
]
}
]
}'{
"isSuccess": false,
"requestCount": 2,
"successCount": 1,
"failureCount": 1,
"failures": [
{
"mallOrderNumber": "ORD202501010001",
"rowIndex": 1,
"failures": [
{
"errorMessage": "입고지 ID가 존재하지 않습니다.",
"errorField": "warehouseId"
}
]
}
]
}Authorizations
발급받은 시크릿 키
Body
application/json
주문 정보 리스트
주문 정보 리스트
입고지 ID
Example:
1
받는 분 정보
받는분 국가
Available options:
GH, GA, GY, GM, GT, GD, GR, GN, GW, NA, NR, NG, SS, ZA, NL, NP, NO, NZ, NU, NE, NI, DK, DO, DM, DE, TL, LA, LR, LV, RU, LB, LS, RO, LU, RW, LY, LT, LI, MG, MH, FM, MW, MY, ML, MX, MC, MA, MU, MR, MZ, ME, MD, MV, MT, MN, US, MM, VU, BH, BB, VA, BS, BD, BJ, VE, VN, BE, BY, BZ, BA, BW, BO, BI, BF, BT, MK, BG, BR, BN, WS, SA, CY, SM, ST, SN, RS, SC, LC, VC, KN, SO, SB, SD, SR, LK, SE, CH, ES, SK, SI, SY, SL, SG, AE, AM, AR, IS, HT, IE, AZ, AF, AD, AL, DZ, AO, AG, ER, SZ, EE, EC, ET, SV, GB, YE, OM, AT, HN, JO, UG, UY, UZ, UA, IQ, IR, IL, EG, IT, IN, ID, JP, JM, ZM, GQ, GE, CN, CF, DJ, ZW, TD, CZ, CL, CM, CV, KZ, QA, KH, CA, KE, KM, XK, CR, CI, CO, CG, CD, CU, KW, CK, HR, KG, KI, TJ, TZ, TH, TR, TG, TO, TM, TV, TN, TT, PA, PY, PK, PG, PW, PS, PE, PT, PL, FR, FJ, FI, PH, HU, AU, TW, GG, JE, GI, KV, AS, AI, AW, BM, KY, FK, FO, GF, GL, GP, GU, KP, MP, MQ, YT, MS, NC, PR, RE, SH, PF, VG, VI, HK, MO, TC, NF, BQ, CW, WF, MF, BL, SX Example:
"US"
이름
Maximum length:
50Example:
"test kim"
연락처
Maximum length:
50Example:
"1235551234"
주소
Maximum length:
300Example:
"Centum jungang-ro, Haeundae-gu"
상세 주소
Maximum length:
300Example:
"20F, 90"
도시
Maximum length:
100Example:
"Busan"
주
Maximum length:
100Example:
"Busan"
우편번호
Maximum length:
30Example:
"48059"
이메일
Maximum length:
100Example:
"test@domain.co.kr"
개인통관고유부호
Maximum length:
100Example:
"1234567890"
주문 정보
쇼핑몰 주문 번호
Maximum length:
100Example:
"ORDER202501010001"
운송사
Available options:
DHL, UPS, FEDEX, PARXL, YSL, ARAMEX, EMS, EMS_PREMIUM, KPACKET, ASAP, GTS, ALEM_TAT, EFS, NOMEX, H3, DELIVERED_STANDARD, LOTOS Example:
"FEDEX"
incoterms
Available options:
DAP, DDP 수출신고 유무
Example:
true
수출목적
Available options:
SAMPLE, COMMERCIAL 국내택배 운송장 번호
Maximum length:
50Example:
"65434235223"
화물 정보
실제 무게
Example:
3.26
박수 개수
Required range:
x <= 2147483647Example:
1
가로(너비)
Example:
11.76
세로(길이)
Example:
11.76
높이
Example:
11.76
서비스 타입(러시아에서 사용)
Available options:
POD 상품 정보
상품 정보
상품명
Maximum length:
500Example:
"test item"
상품 가격
Example:
10000
통화
Available options:
KRW, USD, JPY, RUB Example:
"KRW"
상품 개수
Required range:
x <= 2147483647Example:
1
실제 무게
Example:
3.22
hscode
Maximum length:
100Example:
"1234567890"
상품 URL
Maximum length:
3000Example:
"https://www.delivered.co.kr/en"
상품 코드
Maximum length:
50Example:
"1234567890"
Response
200 - */*
OK
성공 유무
Example:
false
요청 개수
Example:
2
성공 개수
Example:
1
실패 개수
Example:
1
실패 사유
실패 사유
주문번호
Example:
"ORD202501010001"
리스트 내에서 실패한 주문 항목의 순서 (0부터 시작)
Example:
1
curl --request POST \
--url https://gw-staging.delivered.co.kr/global-ship/open-api/v1/orders/validators \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"data": [
{
"warehouseId": 1,
"sender": {
"name": "홍길동",
"contact": "01012345678"
},
"recipient": {
"country": "US",
"name": "test kim",
"contact": "1235551234",
"email": "test@domain.co.kr",
"address": "Centum jungang-ro, Haeundae-gu",
"addressDetail": "20F, 90",
"city": "Busan",
"state": "Busan",
"zipCode": "48059",
"personalCustomsClearanceCode": "1234567890"
},
"orderInfo": {
"mallOrderNumber": "ORDER202501010001",
"carrier": "FEDEX",
"incoterms": "DAP",
"domesticShippingNumber": "65434235223",
"isExportDeclaration": true,
"exportPurpose": "SAMPLE"
},
"packageInfo": {
"width": 11.76,
"length": 11.76,
"height": 11.76,
"actualWeight": 3.26,
"quantity": 1,
"serviceType": "POD"
},
"items": [
{
"name": "test item",
"price": 10000,
"currency": "KRW",
"quantity": 1,
"actualWeight": 3.22,
"hscode": "1234567890",
"itemUrl": "https://www.delivered.co.kr/en",
"itemCode": "1234567890"
}
]
}
]
}'{
"isSuccess": false,
"requestCount": 2,
"successCount": 1,
"failureCount": 1,
"failures": [
{
"mallOrderNumber": "ORD202501010001",
"rowIndex": 1,
"failures": [
{
"errorMessage": "입고지 ID가 존재하지 않습니다.",
"errorField": "warehouseId"
}
]
}
]
}