주문 정보 조회

orderKey 또는 orderNumber를 통해 주문 정보를 조회할 수 있습니다.
이 중 최소 하나의 값은 반드시 입력해야 합니다.

GET /open-api/v1/orders

주문 조회

cURL

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

200

{
  "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 - */*

OK

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

recipient · object · required

받는분 정보

Show child attributes

payment · object · required

결제자 정보

Show child attributes

coupons · object[] · required

쿠폰 정보

Show child attributes

createdAt · string<date-time> · required

주문 생성일