주문 유효성 검사

주문 유효성 검사

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",
        "address": "Centum jungang-ro, Haeundae-gu",
        "addressDetail": "20F, 90",
        "city": "Busan",
        "state": "Busan",
        "zipCode": "48059",
        "email": "[email protected]",
        "personalCustomsClearanceCode": "1234567890"
      },
      "orderInfo": {
        "mallOrderNumber": "ORDER202501010001",
        "carrier": "FEDEX",
        "incoterms": "DAP",
        "isExportDeclaration": true,
        "exportPurpose": "SAMPLE",
        "domesticShippingNumber": "65434235223"
      },
      "packageInfo": {
        "actualWeight": 3.26,
        "quantity": 1,
        "width": 11.76,
        "length": 11.76,
        "height": 11.76,
        "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"
        }
      ]
    }
  ]
}

POST

open-api

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",
        "address": "Centum jungang-ro, Haeundae-gu",
        "addressDetail": "20F, 90",
        "city": "Busan",
        "state": "Busan",
        "zipCode": "48059",
        "email": "[email protected]",
        "personalCustomsClearanceCode": "1234567890"
      },
      "orderInfo": {
        "mallOrderNumber": "ORDER202501010001",
        "carrier": "FEDEX",
        "incoterms": "DAP",
        "isExportDeclaration": true,
        "exportPurpose": "SAMPLE",
        "domesticShippingNumber": "65434235223"
      },
      "packageInfo": {
        "actualWeight": 3.26,
        "quantity": 1,
        "width": 11.76,
        "length": 11.76,
        "height": 11.76,
        "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

Authorization

string

header

required

발급받은 시크릿 키

Body

application/json

data

object[]

required

주문 정보 리스트

Required array length: 1 - 2147483647 elements

Show child attributes

data.warehouseId

integer<int64>

required

입고지 ID

Example:

1

data.sender

object

required

보내는 분 정보

Show child attributes

data.sender.name

string

required

이름

Maximum string length: 50

Example:

"홍길동"

data.sender.contact

string

required

연락처

Maximum string length: 50

Example:

"01012345678"

data.recipient

object

required

받는 분 정보

Show child attributes

data.recipient.country

enum<string>

required

받는분 국가

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"

data.recipient.name

string

required

이름

Maximum string length: 50

Example:

"test kim"

data.recipient.contact

string

required

연락처

Maximum string length: 50

Example:

"1235551234"

data.recipient.address

string

required

주소

Maximum string length: 300

Example:

"Centum jungang-ro, Haeundae-gu"

data.recipient.addressDetail

string

required

상세 주소

Maximum string length: 300

Example:

"20F, 90"

data.recipient.city

string

required

도시

Maximum string length: 100

Example:

"Busan"

data.recipient.state

string

required

주

Maximum string length: 100

Example:

"Busan"

data.recipient.zipCode

string

required

우편번호

Maximum string length: 30

Example:

"48059"

data.recipient.email

string

이메일

Maximum string length: 100

Example:

"[email protected]"

data.recipient.personalCustomsClearanceCode

string

개인통관고유부호

Maximum string length: 100

Example:

"1234567890"

data.orderInfo

object

required

주문 정보

Show child attributes

data.orderInfo.mallOrderNumber

string

required

쇼핑몰 주문 번호

Maximum string length: 100

Example:

"ORDER202501010001"

data.orderInfo.carrier

enum<string>

required

운송사

Available options:

DHL,

UPS,

FEDEX,

PARXL,

YSL,

ARAMEX,

EMS,

EMS_PREMIUM,

KPACKET,

ASAP,

GTS,

ALEM_TAT,

EFS,

NOMEX,

H3,

DELIVERED_STANDARD,

LOTOS

Example:

"FEDEX"

data.orderInfo.incoterms

enum<string>

required

incoterms

Available options:

DAP,

DDP

data.orderInfo.isExportDeclaration

boolean

required

수출신고 유무

Example:

true

data.orderInfo.exportPurpose

enum<string>

required

수출목적

Available options:

SAMPLE,

COMMERCIAL

data.orderInfo.domesticShippingNumber

string

국내택배 운송장 번호

Maximum string length: 50

Example:

"65434235223"

data.packageInfo

object

required

화물 정보

Show child attributes

data.packageInfo.actualWeight

number

required

실제 무게

Example:

3.26

data.packageInfo.quantity

integer<int32>

required

박수 개수

Required range: x <= 2147483647

Example:

1

data.packageInfo.width

number

가로(너비)

Example:

11.76

data.packageInfo.length

number

세로(길이)

Example:

11.76

data.packageInfo.height

number

높이

Example:

11.76

data.packageInfo.serviceType

enum<string>

서비스 타입(러시아에서 사용)

Available options:

POD

data.items

object[]

required

상품 정보

Required array length: 1 - 2147483647 elements

Show child attributes

data.items.name

string

required

상품명

Maximum string length: 500

Example:

"test item"

data.items.price

number

required

상품 가격

Example:

10000

data.items.currency

enum<string>

required

통화

Available options:

KRW,

USD,

JPY,

RUB

Example:

"KRW"

data.items.quantity

integer<int32>

required

상품 개수

Required range: x <= 2147483647

Example:

1

data.items.actualWeight

number

required

실제 무게

Example:

3.22

data.items.hscode

string

hscode

Maximum string length: 100

Example:

"1234567890"

data.items.itemUrl

string

상품 URL

Maximum string length: 3000

Example:

"https://www.delivered.co.kr/en"

data.items.itemCode

string

상품 코드

Maximum string length: 50

Example:

"1234567890"

Response

200 - */*

isSuccess

boolean

required

성공 유무

Example:

false

requestCount

integer<int32>

required

요청 개수

Example:

2

successCount

integer<int32>

required

성공 개수

Example:

1

failureCount

integer<int32>

required

실패 개수

Example:

1

failures

object[]

required

실패 사유

Show child attributes

failures.mallOrderNumber

string

required

주문번호

Example:

"ORD202501010001"

failures.rowIndex

integer<int32>

required

리스트 내에서 실패한 주문 항목의 순서 (0부터 시작)

Example:

1

failures.failures

object[]

required

실패 사유

Show child attributes

failures.failures.errorMessage

string

required

에러 메시지

Example:

"입고지 ID가 존재하지 않습니다."

failures.failures.errorField

string

required

실패 필드

Example:

"warehouseId"

주문 정보 조회 주문 등록

⌘I

업데이트 내역

OPEN API 이용 안내

글로벌 오더

글로벌 쉽

Authorizations

Body

Response