Skip to main content
GET
/
api
/
v1
/
orders
/
{orderIdOrCode}
주문 상세 조회
curl --request GET \
  --url https://api.steppay.kr/api/v1/orders/{orderIdOrCode} \
  --header 'Secret-Token: <api-key>'
import requests

url = "https://api.steppay.kr/api/v1/orders/{orderIdOrCode}"

headers = {"Secret-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'Secret-Token': '<api-key>'}};

fetch('https://api.steppay.kr/api/v1/orders/{orderIdOrCode}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.steppay.kr/api/v1/orders/{orderIdOrCode}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Secret-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.steppay.kr/api/v1/orders/{orderIdOrCode}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Secret-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.steppay.kr/api/v1/orders/{orderIdOrCode}")
  .header("Secret-Token", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.steppay.kr/api/v1/orders/{orderIdOrCode}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Secret-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": 1,
  "orderId": 1,
  "orderCode": "order_AbCdEfGhI",
  "type": "RECURRING_INITIAL",
  "paidAmount": 0,
  "leftAmount": 0,
  "returnedAmount": 0,
  "items": [
    {
      "id": 1,
      "code": "order_item_AbCdEfGhI",
      "paidAmount": 0,
      "currency": "KRW",
      "quantity": 0,
      "price": {
        "id": 1,
        "code": "price_AbCdEfGhI",
        "price": 10000,
        "unit": "개",
        "planName": "Basic Plan",
        "planDescription": "",
        "type": "FLAT",
        "enabledFirstSalePrice": false,
        "firstSalePrice": 0,
        "claimMethodType": "PRE",
        "whenToClaimType": "FIRST_PAYMENT",
        "billingDate": 0,
        "maximumPurchaseQuantity": 0,
        "membershipExpirationDate": 0,
        "membershipExpirationDateType": null,
        "setupOption": null,
        "options": [],
        "volumes": [],
        "additionalBilling": null,
        "recurring": {
          "id": 1,
          "intervalCount": 1,
          "aggregateUsageType": "SUM",
          "interval": "MONTH",
          "usageType": "LICENSED"
        },
        "createdAt": "9999-01-01T00:00:00",
        "modifiedAt": "9999-01-01T00:00:00",
        "plan": {
          "name": "Basic Plan",
          "description": "",
          "detailDescription": "",
          "isHiddenFromShop": false,
          "adminName": null
        },
        "firstSale": {
          "enabled": false,
          "price": 0
        },
        "claim": {
          "methodType": "PRE",
          "whenToClaimType": "FIRST_PAYMENT",
          "billingDate": 0,
          "provideStartDay": null
        },
        "basicServing": 0,
        "bundlePrices": [],
        "onetimeBundlePrice": 0,
        "order": 0
      },
      "product": {
        "id": 1,
        "code": "product_AbCdEfGhI",
        "type": "SOFTWARE",
        "status": "SALE",
        "name": "Basic Product",
        "subTitle": null,
        "featuredImageUrl": "",
        "imageUrls": [],
        "description": "",
        "summary": null,
        "reasonOfReject": null,
        "sku": null,
        "quantity": null,
        "combinedProducts": [],
        "optionGroups": [],
        "useCombination": true,
        "optionCombinations": [],
        "prices": [
          {
            "id": 1,
            "code": "price_AbCdEfGhI",
            "price": 10000,
            "unit": "개",
            "planName": "Basic Plan",
            "planDescription": "",
            "type": "FLAT",
            "enabledFirstSalePrice": false,
            "firstSalePrice": 0,
            "claimMethodType": "PRE",
            "whenToClaimType": "FIRST_PAYMENT",
            "billingDate": 0,
            "maximumPurchaseQuantity": 0,
            "membershipExpirationDate": 0,
            "membershipExpirationDateType": null,
            "setupOption": null,
            "options": [],
            "volumes": [],
            "additionalBilling": null,
            "recurring": {
              "id": 1,
              "intervalCount": 1,
              "aggregateUsageType": "SUM",
              "interval": "MONTH",
              "usageType": "LICENSED"
            },
            "createdAt": "9999-01-01T00:00:00",
            "modifiedAt": "9999-01-01T00:00:00",
            "plan": {
              "name": "Basic Plan",
              "description": "",
              "detailDescription": "",
              "isHiddenFromShop": false,
              "adminName": null
            },
            "firstSale": {
              "enabled": false,
              "price": 0
            },
            "claim": {
              "methodType": "PRE",
              "whenToClaimType": "FIRST_PAYMENT",
              "billingDate": 0,
              "provideStartDay": null
            },
            "basicServing": 0,
            "bundlePrices": [],
            "onetimeBundlePrice": 0,
            "order": 0
          }
        ],
        "createdAt": "9999-01-01T00:00:00",
        "modifiedAt": "9999-01-01T00:00:00",
        "enabledDemo": false,
        "demoPeriod": 7,
        "demoPeriodUnit": "DAY",
        "categories": [],
        "vendorUuid": "206992bb-6462-4b4f-9847-cf2f40d55b48",
        "productOrder": 0,
        "isOnetimePurchasable": false,
        "eventBadge": [],
        "notice": null,
        "useWidget": {
          "useDemo": false,
          "useEventBadge": false,
          "useOnetimePurchasable": false,
          "useNotice": false
        },
        "groupId": null,
        "countrySetting": null,
        "availableRegions": []
      },
      "type": "SKU",
      "status": "CREATED",
      "featuredImageUrl": "",
      "selectedProductOptionLabel": "",
      "selectedProductOptionIds": [],
      "createdAt": "9999-01-01T00:00:00",
      "canceledDateTime": null,
      "orderItemCode": "order_item_AbCdEfGhI",
      "modifiedAt": "9999-01-01T00:00:00",
      "orderedProductType": "SOFTWARE",
      "orderedProductName": "Basic Product",
      "orderedPlanName": "Basic Plan",
      "discountName": null,
      "relatedOrderItemId": null,
      "priceSetupType": null,
      "demoCycle": null,
      "usedCount": null,
      "usageFormula": null,
      "deliveryCode": null,
      "histories": null,
      "unitChangeHistory": null,
      "unitCount": null,
      "minimumQuantity": 1,
      "maximumQuantity": null,
      "parentOrderItemCode": null
    }
  ],
  "customer": {
    "id": 1,
    "uuid": "206992bb-6462-4b4f-9847-cf2f40d55b48",
    "status": "NORMAL",
    "name": "테스트 고객",
    "email": "test@gmail.com",
    "phone": "01012341234",
    "shipping": null,
    "username": null,
    "code": "customer_AbCdEfGhI",
    "marketingSms": false,
    "marketingEmail": false,
    "marketingKakao": false,
    "attributes": {},
    "createdAt": "9999-01-01T00:00:00"
  },
  "paymentDate": null,
  "purchaseDeadline": "9999-01-01T00:00:00",
  "shipping": null,
  "createdAt": "9999-01-01T00:00:00",
  "modifiedAt": "9999-01-01T00:00:00",
  "payment": {
    "paymentMethod": "CARD_BILL",
    "paymentDate": null,
    "amount": 10000,
    "discount": 0,
    "paymentReturn": null,
    "paymentReceiptUrl": null,
    "paymentGateway": "UNKNOWN",
    "cardNumber": null,
    "vbankDTO": null,
    "niceCmsDTO": null,
    "customerDTO": {
      "name": "테스트 고객",
      "email": "test@gmail.com",
      "phone": "01012341234"
    },
    "errorCode": null,
    "errorMessage": null
  },
  "orderLogs": [],
  "code": "order_AbCdEfGhI",
  "subscriptions": [],
  "parentSubscription": null,
  "invoiceId": null,
  "discountedAmount": 0,
  "productName": "Basic Product (Basic Plan)",
  "paymentDueDate": null,
  "idKey": "17042685431546CQ4BVZw22hzN1jn",
  "relatedOrders": [],
  "calculateStartDate": null,
  "calculateEndDate": null,
  "childOrders": [],
  "exchangeRate": 1,
  "region": {
    "code": "KR",
    "currency": "KRW",
    "country": "South Korea",
    "countryCode": "KR",
    "state": null,
    "language": "ko"
  },
  "currency": "KRW",
  "baseCurrency": "KRW"
}
{
  "errorCode": "<string>",
  "traceId": "<string>",
  "errorMessage": "<string>",
  "details": {}
}
{
  "errorCode": "<string>",
  "traceId": "<string>",
  "errorMessage": "<string>",
  "details": {}
}
{
  "id": 123,
  "orderId": 123,
  "orderCode": "<string>",
  "paidAmount": 123,
  "leftAmount": 123,
  "returnedAmount": 123,
  "orderLogs": [
    {
      "id": 123,
      "content": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "subscriptions": [
    {
      "id": 123,
      "items": [
        {
          "id": 123,
          "productName": "<string>",
          "isOnetimePurchasable": true,
          "featuredImageUrl": "<string>",
          "selectedProductOptionIds": [
            123
          ],
          "selectedProductOptionPrice": 123,
          "plan": {
            "name": "<string>",
            "description": "<string>",
            "isHiddenFromShop": true,
            "detailDescription": "<string>",
            "adminName": "<string>"
          },
          "price": 123,
          "quantity": 123,
          "isAdditional": true,
          "keepWhenRenew": true,
          "hasOptions": true,
          "selectedOptions": [
            123
          ],
          "code": "<string>",
          "selectedProductOptionLabel": "<string>",
          "maximumPurchaseQuantity": 123,
          "productCode": "<string>",
          "priceCode": "<string>",
          "parentSubscriptionItemCode": "<string>"
        }
      ],
      "price": {
        "id": 123,
        "code": "<string>",
        "price": 123,
        "enabledFirstSalePrice": true,
        "firstSalePrice": 123,
        "billingDate": 123,
        "maximumPurchaseQuantity": 123,
        "membershipExpirationDate": 123,
        "options": [
          {
            "id": 123,
            "price": 123,
            "name": "<string>",
            "productCode": "<string>",
            "priceCode": "<string>",
            "priceName": "<string>",
            "recurringDTO": {
              "id": 123,
              "intervalCount": 123
            }
          }
        ],
        "volumes": [
          {
            "id": 123,
            "min": 123,
            "max": 123,
            "price": 123
          }
        ],
        "basicServing": 123,
        "bundlePrices": [
          {
            "product": {
              "id": 123,
              "code": "<string>",
              "combinedProducts": [
                {
                  "code": "<string>",
                  "name": "<string>",
                  "description": "<string>",
                  "options": [
                    {
                      "id": 123,
                      "name": "<string>",
                      "options": [
                        {
                          "id": 123,
                          "name": "<string>",
                          "price": 123,
                          "quantity": 123,
                          "parent": 123
                        }
                      ],
                      "depth": 123
                    }
                  ],
                  "prices": "<array>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "modifiedAt": "2023-11-07T05:31:56Z"
                }
              ],
              "optionGroups": [
                {
                  "id": 123,
                  "name": "<string>",
                  "options": [
                    {
                      "id": 123,
                      "name": "<string>",
                      "price": 123,
                      "quantity": 123,
                      "parent": 123
                    }
                  ],
                  "depth": 123
                }
              ],
              "useCombination": true,
              "optionCombinations": [
                {
                  "id": [
                    123
                  ],
                  "quantity": 123,
                  "price": 123
                }
              ],
              "prices": "<array>",
              "createdAt": "2023-11-07T05:31:56Z",
              "enabledDemo": true,
              "demoPeriod": 123,
              "categories": [
                {
                  "categoryId": 123,
                  "name": "<string>"
                }
              ],
              "vendorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "productOrder": 123,
              "isOnetimePurchasable": true,
              "eventBadge": [
                {
                  "event": "<string>",
                  "startDateTime": "2023-11-07T05:31:56Z",
                  "endDateTime": "2023-11-07T05:31:56Z"
                }
              ],
              "name": "<string>",
              "subTitle": "<string>",
              "featuredImageUrl": "<string>",
              "imageUrls": [
                "<string>"
              ],
              "description": "<string>",
              "summary": "<string>",
              "reasonOfReject": "<string>",
              "sku": "<string>",
              "quantity": 123,
              "modifiedAt": "2023-11-07T05:31:56Z",
              "notice": "<string>",
              "useWidget": {
                "useDemo": true,
                "useEventBadge": true,
                "useOnetimePurchasable": true,
                "useNotice": true
              },
              "groupId": 123,
              "countrySetting": {
                "id": 123,
                "countryCode": "<string>",
                "timezoneName": "<string>",
                "currencyCode": "<string>",
                "isDefault": true,
                "taxRate": 123
              },
              "availableRegions": [
                {
                  "code": "<string>",
                  "currency": "<string>",
                  "country": "<string>",
                  "countryCode": "<string>",
                  "state": "<string>",
                  "language": "<string>"
                }
              ]
            },
            "price": "<unknown>"
          }
        ],
        "onetimeBundlePrice": 123,
        "order": 123,
        "currencyPrice": {},
        "unit": "<string>",
        "planName": "<string>",
        "planDescription": "<string>",
        "setupOption": {
          "name": "<string>",
          "id": 123,
          "price": 123,
          "currencyPrice": {}
        },
        "additionalBilling": {
          "id": 123,
          "ranges": [
            {
              "id": 123,
              "until": 123,
              "price": 123
            }
          ]
        },
        "recurring": {
          "id": 123,
          "intervalCount": 123
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z",
        "plan": {
          "name": "<string>",
          "description": "<string>",
          "isHiddenFromShop": true,
          "detailDescription": "<string>",
          "adminName": "<string>"
        },
        "firstSale": {
          "enabled": true,
          "price": 123,
          "currencyPrice": {}
        },
        "claim": {
          "billingDate": 123,
          "provideStartDay": 123
        }
      },
      "intervalCount": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "lastPaymentDate": "2023-11-07T05:31:56Z",
      "nextPaymentDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "trialEndDate": "2023-11-07T05:31:56Z"
    }
  ],
  "discountedAmount": 123,
  "productName": "<string>",
  "relatedOrders": [
    {
      "id": 123,
      "code": "<string>",
      "productName": "<string>",
      "paidAmount": 123,
      "items": [
        {
          "orderItemId": 123,
          "code": "<string>",
          "productName": "<string>",
          "plan": {
            "name": "<string>",
            "description": "<string>",
            "isHiddenFromShop": true,
            "detailDescription": "<string>",
            "adminName": "<string>"
          },
          "amount": 123,
          "parentOrderItemCode": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "exchangeRate": 123,
  "region": {
    "code": "<string>",
    "currency": "<string>",
    "country": "<string>",
    "countryCode": "<string>",
    "state": "<string>",
    "language": "<string>"
  },
  "currency": "<string>",
  "baseCurrency": "<string>",
  "items": [
    {
      "id": 123,
      "code": "<string>",
      "paidAmount": 123,
      "currency": "<string>",
      "quantity": 123,
      "selectedProductOptionIds": [
        123
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "orderItemCode": "<string>",
      "modifiedAt": "2023-11-07T05:31:56Z",
      "orderedProductName": "<string>",
      "orderedPlanName": "<string>",
      "minimumQuantity": 123,
      "price": {
        "id": 123,
        "code": "<string>",
        "price": 123,
        "enabledFirstSalePrice": true,
        "firstSalePrice": 123,
        "billingDate": 123,
        "maximumPurchaseQuantity": 123,
        "membershipExpirationDate": 123,
        "options": [
          {
            "id": 123,
            "price": 123,
            "name": "<string>",
            "productCode": "<string>",
            "priceCode": "<string>",
            "priceName": "<string>",
            "recurringDTO": {
              "id": 123,
              "intervalCount": 123
            }
          }
        ],
        "volumes": [
          {
            "id": 123,
            "min": 123,
            "max": 123,
            "price": 123
          }
        ],
        "basicServing": 123,
        "bundlePrices": [
          {
            "product": {
              "id": 123,
              "code": "<string>",
              "combinedProducts": [
                {
                  "code": "<string>",
                  "name": "<string>",
                  "description": "<string>",
                  "options": [
                    {
                      "id": 123,
                      "name": "<string>",
                      "options": [
                        {
                          "id": 123,
                          "name": "<string>",
                          "price": 123,
                          "quantity": 123,
                          "parent": 123
                        }
                      ],
                      "depth": 123
                    }
                  ],
                  "prices": "<array>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "modifiedAt": "2023-11-07T05:31:56Z"
                }
              ],
              "optionGroups": [
                {
                  "id": 123,
                  "name": "<string>",
                  "options": [
                    {
                      "id": 123,
                      "name": "<string>",
                      "price": 123,
                      "quantity": 123,
                      "parent": 123
                    }
                  ],
                  "depth": 123
                }
              ],
              "useCombination": true,
              "optionCombinations": [
                {
                  "id": [
                    123
                  ],
                  "quantity": 123,
                  "price": 123
                }
              ],
              "prices": "<array>",
              "createdAt": "2023-11-07T05:31:56Z",
              "enabledDemo": true,
              "demoPeriod": 123,
              "categories": [
                {
                  "categoryId": 123,
                  "name": "<string>"
                }
              ],
              "vendorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "productOrder": 123,
              "isOnetimePurchasable": true,
              "eventBadge": [
                {
                  "event": "<string>",
                  "startDateTime": "2023-11-07T05:31:56Z",
                  "endDateTime": "2023-11-07T05:31:56Z"
                }
              ],
              "name": "<string>",
              "subTitle": "<string>",
              "featuredImageUrl": "<string>",
              "imageUrls": [
                "<string>"
              ],
              "description": "<string>",
              "summary": "<string>",
              "reasonOfReject": "<string>",
              "sku": "<string>",
              "quantity": 123,
              "modifiedAt": "2023-11-07T05:31:56Z",
              "notice": "<string>",
              "useWidget": {
                "useDemo": true,
                "useEventBadge": true,
                "useOnetimePurchasable": true,
                "useNotice": true
              },
              "groupId": 123,
              "countrySetting": {
                "id": 123,
                "countryCode": "<string>",
                "timezoneName": "<string>",
                "currencyCode": "<string>",
                "isDefault": true,
                "taxRate": 123
              },
              "availableRegions": [
                {
                  "code": "<string>",
                  "currency": "<string>",
                  "country": "<string>",
                  "countryCode": "<string>",
                  "state": "<string>",
                  "language": "<string>"
                }
              ]
            },
            "price": "<unknown>"
          }
        ],
        "onetimeBundlePrice": 123,
        "order": 123,
        "currencyPrice": {},
        "unit": "<string>",
        "planName": "<string>",
        "planDescription": "<string>",
        "setupOption": {
          "name": "<string>",
          "id": 123,
          "price": 123,
          "currencyPrice": {}
        },
        "additionalBilling": {
          "id": 123,
          "ranges": [
            {
              "id": 123,
              "until": 123,
              "price": 123
            }
          ]
        },
        "recurring": {
          "id": 123,
          "intervalCount": 123
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z",
        "plan": {
          "name": "<string>",
          "description": "<string>",
          "isHiddenFromShop": true,
          "detailDescription": "<string>",
          "adminName": "<string>"
        },
        "firstSale": {
          "enabled": true,
          "price": 123,
          "currencyPrice": {}
        },
        "claim": {
          "billingDate": 123,
          "provideStartDay": 123
        }
      },
      "product": {
        "id": 123,
        "code": "<string>",
        "combinedProducts": [
          {
            "code": "<string>",
            "name": "<string>",
            "description": "<string>",
            "options": [
              {
                "id": 123,
                "name": "<string>",
                "options": [
                  {
                    "id": 123,
                    "name": "<string>",
                    "price": 123,
                    "quantity": 123,
                    "parent": 123
                  }
                ],
                "depth": 123
              }
            ],
            "prices": "<array>",
            "createdAt": "2023-11-07T05:31:56Z",
            "modifiedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "optionGroups": [
          {
            "id": 123,
            "name": "<string>",
            "options": [
              {
                "id": 123,
                "name": "<string>",
                "price": 123,
                "quantity": 123,
                "parent": 123
              }
            ],
            "depth": 123
          }
        ],
        "useCombination": true,
        "optionCombinations": [
          {
            "id": [
              123
            ],
            "quantity": 123,
            "price": 123
          }
        ],
        "prices": "<array>",
        "createdAt": "2023-11-07T05:31:56Z",
        "enabledDemo": true,
        "demoPeriod": 123,
        "categories": [
          {
            "categoryId": 123,
            "name": "<string>"
          }
        ],
        "vendorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "productOrder": 123,
        "isOnetimePurchasable": true,
        "eventBadge": [
          {
            "event": "<string>",
            "startDateTime": "2023-11-07T05:31:56Z",
            "endDateTime": "2023-11-07T05:31:56Z"
          }
        ],
        "name": "<string>",
        "subTitle": "<string>",
        "featuredImageUrl": "<string>",
        "imageUrls": [
          "<string>"
        ],
        "description": "<string>",
        "summary": "<string>",
        "reasonOfReject": "<string>",
        "sku": "<string>",
        "quantity": 123,
        "modifiedAt": "2023-11-07T05:31:56Z",
        "notice": "<string>",
        "useWidget": {
          "useDemo": true,
          "useEventBadge": true,
          "useOnetimePurchasable": true,
          "useNotice": true
        },
        "groupId": 123,
        "countrySetting": {
          "id": 123,
          "countryCode": "<string>",
          "timezoneName": "<string>",
          "currencyCode": "<string>",
          "isDefault": true,
          "taxRate": 123
        },
        "availableRegions": [
          {
            "code": "<string>",
            "currency": "<string>",
            "country": "<string>",
            "countryCode": "<string>",
            "state": "<string>",
            "language": "<string>"
          }
        ]
      },
      "featuredImageUrl": "<string>",
      "selectedProductOptionLabel": "<string>",
      "canceledDateTime": "2023-11-07T05:31:56Z",
      "discountName": "<string>",
      "relatedOrderItemId": 123,
      "demoCycle": {
        "num": 123
      },
      "usedCount": 123,
      "usageFormula": "<string>",
      "deliveryCode": "<string>",
      "histories": [
        {
          "status": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "reason": "<string>"
        }
      ],
      "unitChangeHistory": [
        {
          "changedCount": 123,
          "days": 123
        }
      ],
      "unitCount": 123,
      "maximumQuantity": 123,
      "parentOrderItemCode": "<string>",
      "relatedSubscriptionItemId": 123
    }
  ],
  "customer": {
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>"
  },
  "paymentDate": "2023-11-07T05:31:56Z",
  "purchaseDeadline": "2023-11-07T05:31:56Z",
  "shipping": {
    "name": "<string>",
    "phone": "<string>",
    "postcode": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "state": "<string>",
    "city": "<string>",
    "countryCode": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z",
  "payment": {
    "amount": 123,
    "discount": 123,
    "paymentDate": "2023-11-07T05:31:56Z",
    "paymentReturn": {},
    "paymentReceiptUrl": "<string>",
    "cardNumber": "<string>",
    "vbankDTO": {
      "bankName": "<string>",
      "accountNumber": "<string>",
      "accountName": "<string>",
      "bankDate": "2023-11-07T05:31:56Z",
      "bankCode": "<string>"
    },
    "niceCmsDTO": {
      "corporateManager": "<string>",
      "companyName": "<string>",
      "bankCode": "<string>",
      "bankAccount": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "companyRegistrationNumber": "<string>",
      "errorReturn": "<string>"
    },
    "customerDTO": {
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>"
    },
    "errorCode": "<string>",
    "errorMessage": "<string>"
  },
  "code": "<string>",
  "parentSubscription": {
    "id": 123,
    "items": [
      {
        "id": 123,
        "productName": "<string>",
        "isOnetimePurchasable": true,
        "featuredImageUrl": "<string>",
        "selectedProductOptionIds": [
          123
        ],
        "selectedProductOptionPrice": 123,
        "plan": {
          "name": "<string>",
          "description": "<string>",
          "isHiddenFromShop": true,
          "detailDescription": "<string>",
          "adminName": "<string>"
        },
        "price": 123,
        "quantity": 123,
        "isAdditional": true,
        "keepWhenRenew": true,
        "hasOptions": true,
        "selectedOptions": [
          123
        ],
        "code": "<string>",
        "selectedProductOptionLabel": "<string>",
        "maximumPurchaseQuantity": 123,
        "productCode": "<string>",
        "priceCode": "<string>",
        "parentSubscriptionItemCode": "<string>"
      }
    ],
    "price": {
      "id": 123,
      "code": "<string>",
      "price": 123,
      "enabledFirstSalePrice": true,
      "firstSalePrice": 123,
      "billingDate": 123,
      "maximumPurchaseQuantity": 123,
      "membershipExpirationDate": 123,
      "options": [
        {
          "id": 123,
          "price": 123,
          "name": "<string>",
          "productCode": "<string>",
          "priceCode": "<string>",
          "priceName": "<string>",
          "recurringDTO": {
            "id": 123,
            "intervalCount": 123
          }
        }
      ],
      "volumes": [
        {
          "id": 123,
          "min": 123,
          "max": 123,
          "price": 123
        }
      ],
      "basicServing": 123,
      "bundlePrices": [
        {
          "product": {
            "id": 123,
            "code": "<string>",
            "combinedProducts": [
              {
                "code": "<string>",
                "name": "<string>",
                "description": "<string>",
                "options": [
                  {
                    "id": 123,
                    "name": "<string>",
                    "options": [
                      {
                        "id": 123,
                        "name": "<string>",
                        "price": 123,
                        "quantity": 123,
                        "parent": 123
                      }
                    ],
                    "depth": 123
                  }
                ],
                "prices": "<array>",
                "createdAt": "2023-11-07T05:31:56Z",
                "modifiedAt": "2023-11-07T05:31:56Z"
              }
            ],
            "optionGroups": [
              {
                "id": 123,
                "name": "<string>",
                "options": [
                  {
                    "id": 123,
                    "name": "<string>",
                    "price": 123,
                    "quantity": 123,
                    "parent": 123
                  }
                ],
                "depth": 123
              }
            ],
            "useCombination": true,
            "optionCombinations": [
              {
                "id": [
                  123
                ],
                "quantity": 123,
                "price": 123
              }
            ],
            "prices": "<array>",
            "createdAt": "2023-11-07T05:31:56Z",
            "enabledDemo": true,
            "demoPeriod": 123,
            "categories": [
              {
                "categoryId": 123,
                "name": "<string>"
              }
            ],
            "vendorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "productOrder": 123,
            "isOnetimePurchasable": true,
            "eventBadge": [
              {
                "event": "<string>",
                "startDateTime": "2023-11-07T05:31:56Z",
                "endDateTime": "2023-11-07T05:31:56Z"
              }
            ],
            "name": "<string>",
            "subTitle": "<string>",
            "featuredImageUrl": "<string>",
            "imageUrls": [
              "<string>"
            ],
            "description": "<string>",
            "summary": "<string>",
            "reasonOfReject": "<string>",
            "sku": "<string>",
            "quantity": 123,
            "modifiedAt": "2023-11-07T05:31:56Z",
            "notice": "<string>",
            "useWidget": {
              "useDemo": true,
              "useEventBadge": true,
              "useOnetimePurchasable": true,
              "useNotice": true
            },
            "groupId": 123,
            "countrySetting": {
              "id": 123,
              "countryCode": "<string>",
              "timezoneName": "<string>",
              "currencyCode": "<string>",
              "isDefault": true,
              "taxRate": 123
            },
            "availableRegions": [
              {
                "code": "<string>",
                "currency": "<string>",
                "country": "<string>",
                "countryCode": "<string>",
                "state": "<string>",
                "language": "<string>"
              }
            ]
          },
          "price": "<unknown>"
        }
      ],
      "onetimeBundlePrice": 123,
      "order": 123,
      "currencyPrice": {},
      "unit": "<string>",
      "planName": "<string>",
      "planDescription": "<string>",
      "setupOption": {
        "name": "<string>",
        "id": 123,
        "price": 123,
        "currencyPrice": {}
      },
      "additionalBilling": {
        "id": 123,
        "ranges": [
          {
            "id": 123,
            "until": 123,
            "price": 123
          }
        ]
      },
      "recurring": {
        "id": 123,
        "intervalCount": 123
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "modifiedAt": "2023-11-07T05:31:56Z",
      "plan": {
        "name": "<string>",
        "description": "<string>",
        "isHiddenFromShop": true,
        "detailDescription": "<string>",
        "adminName": "<string>"
      },
      "firstSale": {
        "enabled": true,
        "price": 123,
        "currencyPrice": {}
      },
      "claim": {
        "billingDate": 123,
        "provideStartDay": 123
      }
    },
    "intervalCount": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "lastPaymentDate": "2023-11-07T05:31:56Z",
    "nextPaymentDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "trialEndDate": "2023-11-07T05:31:56Z"
  },
  "invoiceId": 123,
  "paymentDueDate": "2023-11-07T05:31:56Z",
  "idKey": "<string>",
  "calculateStartDate": "2023-11-07T05:31:56Z",
  "calculateEndDate": "2023-11-07T05:31:56Z",
  "childOrders": "<array>"
}

Authorizations

Secret-Token
string
header
required

Path Parameters

orderIdOrCode
string
required

주문 코드

Response

정상적으로 조회됨

관련 주문

id
integer<int64>
required

주문 번호

orderId
integer<int64>
required

주문 번호 (이전 버전 호환)

orderCode
string
required

주문 코드

type
enum<string>
required

주문 타입

Available options:
RECURRING,
ONE_TIME,
PAYMENT_METHOD,
RECURRING_INITIAL,
ADD_USAGE,
ADDITIONAL,
ADD_PAYMENT_METHOD
paidAmount
number
required

결제 금액

leftAmount
number
required

남은 금액

returnedAmount
number
required

환불 금액

orderLogs
주문 메모 정보 · object[]
required

주문 메모 목록

subscriptions
주문 관련 구독 정보 · object[]
required

관련 구독 목록

discountedAmount
number
required

할인 금액

productName
string
required

상품 이름

관련 주문

exchangeRate
number
required

주문에 적용된 환율

region
판매국가 정보 · object
required

판매 국가(주)

currency
string
required

승인 통화

baseCurrency
string
required

주문 생성 당시 기준 통화

items
주문 항목 정보 · object[]

주문 항목들

customer
object

결제자 정보

paymentDate
string<date-time>

결제 시점

purchaseDeadline
string<date-time>

청구서 사용시, 구매 기한

shipping
배송지 정보 · object

고객이 최근에 사용한 배송 정보 - 주소

createdAt
string<date-time>

생성된 시점

modifiedAt
string<date-time>

수정된 시점

payment
결제 상세 정보 · object

결제 정보

code
string
parentSubscription
주문 관련 구독 정보 · object

부모 구독 정보(갱신 결제일 경우)

invoiceId
integer<int64>

청구서 ID

paymentDueDate
string<date-time>

결제일 지정

idKey
string

결제 정보 조회용 idKey

calculateStartDate
string<date-time>

합산 시작 시점

calculateEndDate
string<date-time>

합산 끝 시점

childOrders
array

하위 벤더의 주문