curl --request GET \
--url https://api.steppay.kr/api/v1/orders/{orderIdOrCode} \
--header 'Secret-Token: <api-key>'{
"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"
}주문 상세정보를 반환합니다.
curl --request GET \
--url https://api.steppay.kr/api/v1/orders/{orderIdOrCode} \
--header 'Secret-Token: <api-key>'{
"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"
}주문 코드
정상적으로 조회됨
관련 주문
주문 번호
주문 번호 (이전 버전 호환)
주문 코드
주문 타입
RECURRING, ONE_TIME, PAYMENT_METHOD, RECURRING_INITIAL, ADD_USAGE, ADDITIONAL, ADD_PAYMENT_METHOD 결제 금액
남은 금액
환불 금액
주문 메모 목록
Show child attributes
관련 구독 목록
Show child attributes
할인 금액
상품 이름
관련 주문
Show child attributes
주문에 적용된 환율
판매 국가(주)
Show child attributes
승인 통화
주문 생성 당시 기준 통화
주문 항목들
Show child attributes
결제자 정보
Show child attributes
결제 시점
청구서 사용시, 구매 기한
고객이 최근에 사용한 배송 정보 - 주소
Show child attributes
생성된 시점
수정된 시점
결제 정보
Show child attributes
부모 구독 정보(갱신 결제일 경우)
Show child attributes
청구서 ID
결제일 지정
결제 정보 조회용 idKey
합산 시작 시점
합산 끝 시점
하위 벤더의 주문