주문 정보 조회

주문 조회

curl --request GET \
  --url https://gw-staging.delivered.co.kr/global-checkout/open-api/v1/orders \
  --header 'Authorization: <api-key>'

{
  "orderNumber": "<string>",
  "orderKey": "<string>",
  "orderStatus": "CREATED",
  "deliveryType": "BASIC",
  "carrierType": "STANDARD",
  "items": [
    {
      "orderItemKey": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellerProductId": "<string>"
    }
  ],
  "recipient": {
    "email": "<string>",
    "phoneCode": "<string>",
    "phoneNumber": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "address": {
      "addressLine1": "<string>",
      "city": "<string>",
      "countryCode": "<string>",
      "zipCode": "<string>",
      "addressLine2": "<string>",
      "state": "<string>"
    }
  },
  "payment": {
    "totalPriceKrw": 123,
    "totalPriceUsd": 123,
    "carrierTotalPriceKrw": 123,
    "carrierTotalPriceUsd": 123,
    "productTotalPriceKrw": 123,
    "productTotalPriceUsd": 123,
    "handlingFeeKrw": 123,
    "handlingFeeUsd": 123,
    "creditCardDiscountAmountKrw": 123,
    "creditCardDiscountAmountUsd": 123,
    "productCouponDiscountAmountKrw": 123,
    "productCouponDiscountAmountUsd": 123,
    "shippingCouponDiscountAmountKrw": 123,
    "shippingCouponDiscountAmountUsd": 123,
    "totalDutyVatAmountKrw": 123,
    "totalDutyVatAmountUsd": 123,
    "currency": "KRW",
    "billingPhoneCode": "<string>",
    "billingPhoneNumber": "<string>",
    "billingEmail": "<string>",
    "billingFirstName": "<string>",
    "billingLastName": "<string>",
    "billingAddress": {
      "addressLine1": "<string>",
      "city": "<string>",
      "countryCode": "<string>",
      "zipCode": "<string>",
      "addressLine2": "<string>",
      "state": "<string>"
    },
    "taxId": "<string>",
    "paymentMethod": "CARD",
    "paidAt": "<string>"
  },
  "coupons": [
    {
      "couponCode": "<string>",
      "discountTarget": "PRODUCT"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

GET

open-api

orders

주문 조회

curl --request GET \
  --url https://gw-staging.delivered.co.kr/global-checkout/open-api/v1/orders \
  --header 'Authorization: <api-key>'

{
  "orderNumber": "<string>",
  "orderKey": "<string>",
  "orderStatus": "CREATED",
  "deliveryType": "BASIC",
  "carrierType": "STANDARD",
  "items": [
    {
      "orderItemKey": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellerProductId": "<string>"
    }
  ],
  "recipient": {
    "email": "<string>",
    "phoneCode": "<string>",
    "phoneNumber": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "address": {
      "addressLine1": "<string>",
      "city": "<string>",
      "countryCode": "<string>",
      "zipCode": "<string>",
      "addressLine2": "<string>",
      "state": "<string>"
    }
  },
  "payment": {
    "totalPriceKrw": 123,
    "totalPriceUsd": 123,
    "carrierTotalPriceKrw": 123,
    "carrierTotalPriceUsd": 123,
    "productTotalPriceKrw": 123,
    "productTotalPriceUsd": 123,
    "handlingFeeKrw": 123,
    "handlingFeeUsd": 123,
    "creditCardDiscountAmountKrw": 123,
    "creditCardDiscountAmountUsd": 123,
    "productCouponDiscountAmountKrw": 123,
    "productCouponDiscountAmountUsd": 123,
    "shippingCouponDiscountAmountKrw": 123,
    "shippingCouponDiscountAmountUsd": 123,
    "totalDutyVatAmountKrw": 123,
    "totalDutyVatAmountUsd": 123,
    "currency": "KRW",
    "billingPhoneCode": "<string>",
    "billingPhoneNumber": "<string>",
    "billingEmail": "<string>",
    "billingFirstName": "<string>",
    "billingLastName": "<string>",
    "billingAddress": {
      "addressLine1": "<string>",
      "city": "<string>",
      "countryCode": "<string>",
      "zipCode": "<string>",
      "addressLine2": "<string>",
      "state": "<string>"
    },
    "taxId": "<string>",
    "paymentMethod": "CARD",
    "paidAt": "<string>"
  },
  "coupons": [
    {
      "couponCode": "<string>",
      "discountTarget": "PRODUCT"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

발급받은 시크릿 키

Query Parameters

orderKey

string

orderNumber

string

Response

200 - */*

orderNumber

string

required

주문 번호

orderKey

string

required

주문 고유 Key

orderStatus

enum<string>

required

주문 상태

Available options:

CREATED,

PAID,

FAILED,

PARTIAL_CANCELLED,

CANCELLED,

ORDER_PROCESSING,

SHIPPED,

DELIVERED,

PARTIAL_DELIVERED

deliveryType

enum<string>

required

배송 타입

Available options:

BASIC,

MY_KOREA_SUITE

carrierType

enum<string>

required

운송사 타입

Available options:

STANDARD,

EXPRESS,

MY_KOREA_SUITE

items

object[]

required

상품 정보

Show child attributes

items.orderItemKey

string

required

상품 고유 Key

items.productTitle

string

required

상품명

items.quantity

integer<int32>

required

상품 수량

items.sellerProductId

string

고객사 상품 고유 ID

recipient

object

required

받는분 정보

Show child attributes

recipient.email

string

required

주문자 email

recipient.phoneCode

string

required

주문자 전화번호 국가코드

recipient.phoneNumber

string

required

주문자 전화번호

recipient.firstName

string

required

주문자 이름(firstName)

recipient.lastName

string

required

주문자 이름(lastName)

recipient.address

object

required

결제자 주소

Show child attributes

recipient.address.addressLine1

string

required

주소

recipient.address.city

string

required

도시

recipient.address.countryCode

string

required

국가 코드

recipient.address.zipCode

string

required

우편번호

recipient.address.addressLine2

string

상세 주소

recipient.address.state

string

주

payment

object

required

결제자 정보

Show child attributes

payment.totalPriceKrw

number

required

결제 금액 (원화)

payment.totalPriceUsd

number

required

결제 금액 (달러)

payment.carrierTotalPriceKrw

number

required

총 배송비 가격 (원화)

payment.carrierTotalPriceUsd

number

required

총 배송비 가격 (달러)

payment.productTotalPriceKrw

number

required

총 상품 가격 (원화)

payment.productTotalPriceUsd

number

required

총 상품 가격 (달러)

payment.handlingFeeKrw

number

required

핸들링 피 (원화)

payment.handlingFeeUsd

number

required

핸들링 피 (달러)

payment.creditCardDiscountAmountKrw

number

required

카드 할인 금액 (원화)

payment.creditCardDiscountAmountUsd

number

required

카드 할인 금액 (달러)

payment.productCouponDiscountAmountKrw

number

required

상품 쿠폰 할인 금액 (원화)

payment.productCouponDiscountAmountUsd

number

required

상품 쿠폰 할인 금액 (달러)

payment.shippingCouponDiscountAmountKrw

number

required

배송비 쿠폰 할인 금액 (원화)

payment.shippingCouponDiscountAmountUsd

number

required

배송비 쿠폰 할인 금액 (달러)

payment.totalDutyVatAmountKrw

number

required

관부관세 합계 금액 (달러)

payment.totalDutyVatAmountUsd

number

required

관부관세 합계 금액 (달러)

payment.currency

enum<string>

required

통화

Available options:

KRW,

USD,

AED,

AFN,

AMD,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KPW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XPF,

YER,

ZAR,

ZMW,

ZWL

payment.billingPhoneCode

string

결제자 전화번호 국가코드

payment.billingPhoneNumber

string

결제자 전화번호

payment.billingEmail

string

결제자 email

payment.billingFirstName

string

결제자 이름(firstName)

payment.billingLastName

string

결제자 이름(lastName)

payment.billingAddress

object

결제자 주소

Show child attributes

payment.billingAddress.addressLine1

string

required

주소

payment.billingAddress.city

string

required

도시

payment.billingAddress.countryCode

string

required

국가 코드

payment.billingAddress.zipCode

string

required

우편번호

payment.billingAddress.addressLine2

string

상세 주소

payment.billingAddress.state

string

주

payment.taxId

string

Tax ID

payment.paymentMethod

enum<string>

결제 방법

Available options:

CARD,

PAYPAL,

ALIPAY,

ALIPAYHK,

BILLEASE,

BOOST,

BPI,

DANA,

GCASH,

RABBIT_LINE_PAY,

TOUCHNGO,

TRUEMONEY

payment.paidAt

string

결제일

coupons

object[]

required

쿠폰 정보

Show child attributes

coupons.couponCode

string

required

쿠폰 코드

coupons.discountTarget

enum<string>

required

쿠폰 타겟

Available options:

PRODUCT,

DELIVERY

createdAt

string<date-time>

required

주문 생성일

환율 정보 조회 주문 유효성 검사

⌘I

업데이트 내역

OPEN API 이용 안내

글로벌 오더

글로벌 쉽

Authorizations

Query Parameters

Response