Skip to main content
POST
/
api
/
v1
/
orders
주문 생성
curl --request POST \
  --url https://api.steppay.kr/api/v1/orders \
  --header 'Content-Type: application/json' \
  --header 'Secret-Token: <api-key>' \
  --data '
{
  "customerId": 0,
  "items": [
    {
      "minimumQuantity": 1,
      "productCode": "product_AbCdEfGhI",
      "priceCode": "price_AbCdEfGhI"
    }
  ]
}
'
{
  "orderId": 1,
  "orderCode": "order_AbCdEfGhI",
  "type": "RECURRING_INITIAL",
  "paidAmount": 0,
  "returnedAmount": 0,
  "leftAmount": 0,
  "discountedAmount": 0,
  "productName": "Basic Product (Basic Plan)",
  "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.000000",
      "canceledDateTime": null,
      "orderItemCode": "order_item_AbCdEfGhI",
      "modifiedAt": "9999-01-01T00:00:00.000000",
      "orderedProductType": "SOFTWARE",
      "orderedProductName": "Basic Product",
      "orderedPlanName": "Basic Plan",
      "discountName": null,
      "relatedOrderItemId": null,
      "priceSetupType": null,
      "demoCycle": null,
      "usedCount": null,
      "usageFormula": null,
      "deliveryCode": null,
      "histories": null,
      "minimumQuantity": 1,
      "maximumQuantity": null,
      "parentOrderItemCode": null,
      "unitChangeHistory": null,
      "unitCount": null
    }
  ],
  "customer": {
    "id": 1,
    "uuid": "206992bb-6462-4b4f-9847-cf2f40d55b48",
    "status": "NORMAL",
    "username": "test@gmail.com",
    "name": "고객 수정",
    "email": "test@gmail.com",
    "phone": "01012341234",
    "shipping": null,
    "code": "customer_AbCdEfGhI",
    "marketingSms": false,
    "marketingEmail": false,
    "marketingKakao": false,
    "attributes": {},
    "createdAt": "9999-01-01T00:00:00"
  },
  "paymentDate": null,
  "paymentDueDate": null,
  "purchaseDeadline": "9999-01-01T00:00:00",
  "shipping": null,
  "createdAt": "9999-01-01T00:00:00.000000",
  "modifiedAt": "9999-01-01T00:00:00.000000",
  "payment": null,
  "orderLogs": [],
  "code": "order_AbCdEfGhI",
  "idKey": "17042685431546CQ4BVZw22hzN1jn",
  "subscriptions": [],
  "parentSubscription": null,
  "relatedOrders": [],
  "calculateStartDate": null,
  "calculateEndDate": null,
  "childOrders": [],
  "paymentMethod": null,
  "currency": "KRW",
  "exchangeRate": 1,
  "region": {
    "name": "KR",
    "currencies": [
      "KRW"
    ],
    "country": "South Korea",
    "countryCode": "KR",
    "state": null,
    "language": "ko"
  },
  "baseCurrency": "KRW"
}

Authorizations

​
Secret-Token
string
header
required

Body

application/json

주문 생성 데이터

​
customerId
integer<int64>
required

고객 번호

Required range: x >= 0
​
customerCode
string
required

고객 코드

​
customerUuid
string<uuid>
required

고객 uuid

​
items
주문 항목 생성 데이터 · object[]
required

주문 항목 생성 데이터 목록

​
purchaseDeadline
string<date-time>

결제 링크 유효 기간을 나타냅니다. ISO 8601 형식

​
paymentGateway
enum<string>

결제 화면에서 결제 할 수 있는 PG사를 고정합니다. (기본값: UNKNOWN)

Available options:
NAVER,
DANAL,
KAKAO,
KG,
KCP,
NICE,
JT,
GOOGLE,
BANKPAY,
BLUEWALNUT,
KSNET,
TOSS,
EXIMBAY,
SETTLE,
DAOUDATA,
WELCOME,
NICE_V2,
STRIPE,
PAYPLE,
PAYPLE_GLOBAL,
KICC,
EMPTY,
STEPPAY,
UNKNOWN
​
region
enum<string>

주문의 판매 국가(주) 코드, 정의되지 않은 값 보낼 시 Exception 발생 (기본값: KR)

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
US_ALABAMA,
US_ALASKA,
US_ARIZONA,
US_ARKANSAS,
US_CALIFORNIA,
US_COLORADO,
US_CONNECTICUT,
US_DELAWARE,
US_FLORIDA,
US_GEORGIA,
US_HAWAII,
US_IDAHO,
US_ILLINOIS,
US_INDIANA,
US_IOWA,
US_KANSAS,
US_KENTUCKY,
US_LOUISIANA,
US_MAINE,
US_MARYLAND,
US_MASSACHUSETTS,
US_MICHIGAN,
US_MINNESOTA,
US_MISSISSIPPI,
US_MISSOURI,
US_MONTANA,
US_NEBRASKA,
US_NEVADA,
US_NEW_HAMPSHIRE,
US_NEW_JERSEY,
US_NEW_MEXICO,
US_NEW_YORK,
US_NORTH_CAROLINA,
US_NORTH_DAKOTA,
US_OHIO,
US_OKLAHOMA,
US_OREGON,
US_PENNSYLVANIA,
US_RHODE_ISLAND,
US_SOUTH_CAROLINA,
US_SOUTH_DAKOTA,
US_TENNESSEE,
US_TEXAS,
US_UTAH,
US_VERMONT,
US_VIRGINIA,
US_WASHINGTON,
US_WEST_VIRGINIA,
US_WISCONSIN,
US_WYOMING,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW
​
currency
string

결제 통화 (기본값: KRW)

Response

정상적으로 생성됨

청구서 주문 정보

​
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

주문 금액

​
returnedAmount
number
required

환불된 금액

​
leftAmount
number
required

남은 금액

​
discountedAmount
number
required

할인 금액

​
productName
string
required

상품 이름

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

주문 메모 목록

​
code
string
required

주문 코드

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

관련 구독 목록

​
relatedOrders
object[]
required

관련 주문

​
currency
string
required

결제 통화

​
exchangeRate
number
required

환율(금액에 곱할 값)

​
region
판매국가 정보 · object
required

지역

​
baseCurrency
string
required

주문 생성 당시 기준 통화

​
items
주문 항목 정보 · object[]

주문 항목들

​
customer
주문 고객 정보 · object

주문한 고객 정보

​
paymentDate
string<date-time>

결제 시점

​
paymentDueDate
string<date-time>

결제일 지정

​
purchaseDeadline
string<date-time>

청구서 사용시, 구매 기한 시점

​
shipping
배송지 정보 · object

고객이 최근에 사용한 배송지

​
createdAt
string<date-time>

생성된 시점

​
modifiedAt
string<date-time>

수정된 시점

​
payment
결제 상세 정보 · object

결제 상세 정보

​
idKey
string

결제 정보 조회용 idKey

​
parentSubscription
주문 관련 구독 정보 · object

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

​
calculateStartDate
string<date-time>

합산 시작 시점

​
calculateEndDate
string<date-time>

합산 끝 시점

​
childOrders
array

하위 벤더의 주문

​
paymentMethod
enum<string>

결제 수단

Available options:
CARD,
VBANK,
BANK,
BANK_TRANSFER,
CELLPHONE,
SIMPLE_PAY,
CMS,
CARD_BILL,
CELLPHONE_BILL,
CMS_BILL,
PAYPAL
​
totalDisplayAmount
number

표시 통화 가격