배송 조회 API

REST 배송 상세 조회 API입니다.

  • deliveryId를 query parameter로 전달합니다.
  • 본인 계정으로 접수한 배송만 조회할 수 있습니다.
  • 물품 정보는 deliveryItems 배열로 반환합니다.

API Endpoint

GET/v1/rest/delivery
Cookie Auth RequiredResponse: */*

API 한눈에 보기

구현 전에 확인할 요청/응답 규모와 코드값 힌트입니다.

Samples included

Request Fields

1

Required Fields

1

Response Fields

64

Available Code Samples

cURL / fetch / Response

• 국가 코드는 ISO 3166-1 alpha-2 형식입니다. 예: KR, JP, US

• 요금 조회 options[].transportType을 배송 접수 deliveryGlobal.transportType으로 전달합니다.

• volumeInputType=1은 치수로 CBM 계산, 2는 cbm 직접 입력입니다.

• 인증 후 Cookie: accessToken=발급받은_토큰값 헤더가 필요합니다.

구현 체크리스트 (Implementation Checklist)

✓요청 헤더에 Cookie: accessToken=발급받은_토큰값을 포함합니다.

✓Content-Type과 lang 헤더를 실제 운영 환경에서도 동일하게 전달합니다.

✓조회 결과의 상태값, 주소, 해외 운송 옵션은 연계사 시스템의 접수 상태 동기화 기준으로 사용합니다.

✓클라이언트 타임아웃 후 중복 접수 방지를 위해 먼저 조회 API로 접수 결과를 확인합니다.

운영 확인 항목

!요청 시각, path, HTTP status, errorCode를 로그에 보관합니다.

!개인정보 필드는 로그와 실패 알림에서 완벽히 마스킹 처리합니다.

!4xx 에러는 요청 데이터 자가 보정, 5xx 에러는 임시 지수 백오프 적용 대상으로 삼습니다.

Query Parameters

1 fields1 required

deliveryId

required
number

int64

배송 ID(인덱스)

example1

Response

4 fields1 nested

success

boolean

API 성공 여부

exampletrue

message

string

전달 메세지

exampleAPI가 정상 처리되었습니다

errorCode

number

int32

에러 코드

example0

data

OBJECT하위 17개

REST 배송 상세 조회 Response Data. REST 접수에서 전달한 값과 백엔드 생성 식별/상태 값만 반환합니다.

example{}

이 필드는 객체 구조입니다. 하위 필드는 섹션에서 확인합니다.

Response

/

data

data 하위 필드

17 fields

REST 배송 상세 조회 Response Data. REST 접수에서 전달한 값과 백엔드 생성 식별/상태 값만 반환합니다.

OBJECT

deliveryId

number

int64

배송 ID(인덱스)

example1

deliveryType

number

int32

배송 타입. 1: 해외 배송, 2: 국내 배송

example1

deliveryNo

string

배송 접수 번호

exampleKR0001JP

deliveryStatus

number

int32

배송 상태

example1

paymentStatus

number

int32

결제 상태

example1

etd

nullable
string

date-time

픽업 요청 일시

example2026-05-27T00:00:00+09:00

eta

nullable
string

date-time

도착 희망 일시

example2026-05-27T00:00:00+09:00

memo

nullable
string

배송 관련 메모

example샘플 배송 메모

name

string

접수자 이름

example홍길동

email

string

접수자 이메일

exampleasap@asapx.ai

phoneNum

string

접수자 연락처

example01000000000

division

nullable
string

접수자 계정 구분

example샘플 지점

createdTime

string

date-time

접수일시

example2026-05-27T00:00:00+09:00

deliveryItems

ARRAY하위 19개

물품 정보 리스트

example[]

이 필드는 배열 구조입니다. 하위 필드는 섹션에서 확인합니다.

departureDeliveryAddress

OBJECT하위 11개

REST 배송 상세 조회 주소 Response Data

example{}

이 필드는 객체 구조입니다. 하위 필드는 섹션에서 확인합니다.

arrivalDeliveryAddress

OBJECT하위 11개

REST 배송 상세 조회 주소 Response Data

example{}

이 필드는 객체 구조입니다. 하위 필드는 섹션에서 확인합니다.

deliveryGlobal

nullable
OBJECT하위 2개

REST 배송 상세 조회 해외 운송 Response Data

example{}

이 필드는 객체 구조입니다. 하위 필드는 섹션에서 확인합니다.

Response

/

data.deliveryItems[]

deliveryItems[] 하위 필드

19 fields

물품 정보 리스트

ARRAY

deliveryItemId

number

int64

배송 물품 ID(인덱스)

example1

info

string

대표 품목명

example사과

detailInfo

nullable
string

품목 상세 설명

example청송 사과 10kg

packageType

string

포장 형태명

example박스

count

number

int32

물품 수량

example1

volumeInputType

nullable
number

int32

부피 입력 방식. 저장된 치수/CBM 값 기준으로 반환합니다. 1: 치수 입력, 2: CBM 직접 입력

example1

weight

number

물품 실중량(kg)

example10

width

nullable
number

가로(cm)

example30

depth

nullable
number

세로(cm)

example40

height

nullable
number

높이(cm)

example25

cbm

nullable
number

CBM

example0.03

coldChainFlag

number

int32

콜드체인 필요 여부. 1: 필요, 2: 불필요

example2

minTemperature

nullable
number

허용 최저온도(섭씨)

example-15.5

maxTemperature

nullable
number

허용 최고온도(섭씨)

example8

hazardousFlag

number

int32

위험물 포함 여부. 1: 포함, 2: 미포함

example2

incoterms

nullable
string

인코텀즈

exampleFOB

customsSupport

nullable
number

int32

통관 및 관세 지원 서비스 신청 여부. 1: 신청, 2: 미신청

example1

insuranceSupport

nullable
number

int32

보험 서비스 신청 여부. 1: 신청, 2: 미신청

example1

hsCode

nullable
string

HS Code

example080810

Response

/

data.departureDeliveryAddress

departureDeliveryAddress 하위 필드

11 fields

REST 배송 상세 조회 주소 Response Data

OBJECT

name

string

주소지 담당자 또는 수취/발송인 이름

example홍길동

phoneNum

string

주소지 담당자 연락처

example01000000000

email

string

주소지 담당자 이메일

exampleasap@asapx.ai

postalCode

nullable
string

우편 번호

example00000

countryCode

string

ISO 3166-1 alpha-2 국가 코드

exampleKR

stateOrProvince

string

시/도 또는 주

example서울

city

string

시/군/구 또는 도시명

example강남구

streetAddress

string

도로명 주소 또는 해외 street address

example샘플로 1

detailAddress

nullable
string

상세 주소

example101호

longitude

nullable
number

경도

example126.978

latitude

nullable
number

위도

example37.5665

Response

/

data.arrivalDeliveryAddress

arrivalDeliveryAddress 하위 필드

11 fields

REST 배송 상세 조회 주소 Response Data

OBJECT

name

string

주소지 담당자 또는 수취/발송인 이름

example홍길동

phoneNum

string

주소지 담당자 연락처

example01000000000

email

string

주소지 담당자 이메일

exampleasap@asapx.ai

postalCode

nullable
string

우편 번호

example00000

countryCode

string

ISO 3166-1 alpha-2 국가 코드

exampleKR

stateOrProvince

string

시/도 또는 주

example서울

city

string

시/군/구 또는 도시명

example강남구

streetAddress

string

도로명 주소 또는 해외 street address

example샘플로 1

detailAddress

nullable
string

상세 주소

example101호

longitude

nullable
number

경도

example126.978

latitude

nullable
number

위도

example37.5665

Response

/

data.deliveryGlobal

deliveryGlobal 하위 필드

2 fields

REST 배송 상세 조회 해외 운송 Response Data

OBJECT

transportType

number

int32

요금 조회에서 선택한 options[].transportType 값

example7

amount

number

요금 조회에서 선택한 options[].estimatedAmount 값

example25200

예시 코드 및 샘플

같은 요청을 cURL, JavaScript fetch, JSON 샘플로 확인할 수 있습니다.

curl -X GET "$BASE_URL/v1/rest/delivery?deliveryId=1" \
  -H "lang: ko" \
  -H "Cookie: accessToken=발급받은_토큰값"
const response = await fetch(`${BASE_URL}/v1/rest/delivery`, {
  "method": "GET",
  "headers": {
    "lang": "ko",
    "Cookie": "accessToken=발급받은_토큰값"
  }
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(`ASAP API error: ${response.status} ${error.message ?? ''}`);
}

const data = await response.json();
{
  "success": true,
  "message": "API가 정상 처리되었습니다",
  "errorCode": 0,
  "data": {
    "deliveryId": 1,
    "deliveryType": 1,
    "deliveryNo": "KR0001JP",
    "deliveryStatus": 1,
    "paymentStatus": 1,
    "etd": "2026-05-27T00:00:00+09:00",
    "eta": "2026-05-27T00:00:00+09:00",
    "memo": "샘플 배송 메모",
    "name": "홍길동",
    "email": "asap@asapx.ai",
    "phoneNum": "01000000000",
    "division": "샘플 지점",
    "createdTime": "2026-05-27T00:00:00+09:00",
    "deliveryItems": [
      {
        "deliveryItemId": 1,
        "info": "사과",
        "detailInfo": "청송 사과 10kg",
        "packageType": "박스",
        "count": 1,
        "volumeInputType": 1,
        "weight": 10,
        "width": 30,
        "depth": 40,
        "height": 25,
        "cbm": 0.03,
        "coldChainFlag": 2,
        "minTemperature": -15.5,
        "maxTemperature": 8,
        "hazardousFlag": 2,
        "incoterms": "FOB",
        "customsSupport": 1,
        "insuranceSupport": 1,
        "hsCode": "080810"
      }
    ],
    "departureDeliveryAddress": {
      "name": "홍길동",
      "phoneNum": "01000000000",
      "email": "asap@asapx.ai",
      "postalCode": "00000",
      "countryCode": "KR",
      "stateOrProvince": "서울",
      "city": "강남구",
      "streetAddress": "샘플로 1",
      "detailAddress": "101호",
      "longitude": 126.978,
      "latitude": 37.5665
    },
    "arrivalDeliveryAddress": {
      "name": "홍길동",
      "phoneNum": "01000000000",
      "email": "asap@asapx.ai",
      "postalCode": "00000",
      "countryCode": "KR",
      "stateOrProvince": "서울",
      "city": "강남구",
      "streetAddress": "샘플로 1",
      "detailAddress": "101호",
      "longitude": 126.978,
      "latitude": 37.5665
    },
    "deliveryGlobal": {
      "transportType": 7,
      "amount": 25200
    }
  }
}