Skip to content

주문 - 개념 상세 ​

Types ​

주문 (Order) ​

주문은 매장에서 소비자가 상품을 구매하고 결제하는 것을 표현하는 개념이에요. 주문은 구매한 상품 목록, 결제 내역, 결제 금액 등 이 과정에서 기록되는 정보를 모두 포함하고 있어요.

FieldTypeRequiredDescriptionExample
idString✅주문 ID"620000000000000000"
merchantIdLong✅매장 ID42
sourceString✅주문 채널

주문이 인입된 경로를 말해요. 예를 들어, 토스 POS로부터 인입된 주문은 "POS", 토스 키오스크로부터 인입된 주문은 "KIOSK" 등이에요.
주문 생성 API를 통해 생성한 주문의 경우 "PLUGIN_{appId.toUpperCase()}" 값을 가져요. (예: my-awesome-app 앱에서 생성한 주문의 source는 "PLUGIN_MY-AWESOME-APP")
"POS"
orderStateOrderState✅주문 상태"OPENED"
orderKeyString✅주문 키

주문을 식별하는 용도로 사용하는 문자열이에요. 주문 채널에 따라 고유의 값 체계를 사용할 수 있어요.
"EXT-20260512-0001"
orderNumberString주문 번호

매장을 운영하거나 이용하는 사람이 주문을 확인하는 데 사용하는 주문번호예요. ("042번 주문" 과 같은 형태) 토스 POS 결제내역, 주문 현황, 주문서, 영수증 등에 표시되는 값이에요.
"A-001"
createdAttimestamp✅생성 시각"2025-09-01T00:00:00"
updatedAttimestamp✅변경 시각"2025-09-01T00:00:00"
openedAttimestamp주문 수락 시각"2025-09-01T00:00:00"
completedAttimestamp주문 완료 시각"2025-09-01T00:00:00"
cancelledAttimestamp주문 취소 시각"2025-09-01T00:00:00"
lineItemsOrderLineItem[]✅주문 내역
requestedInfoOrderRequestedInfo주문 요청 정보

픽업 주문과 같이, 매장에서 수락 또는 거절할 수 있는 주문의 경우 주문 요청 정보를 포함하고 있어요.
memoString주문 메모

소비자 또는 매장 운영자가 주문에 대해 추가로 작성한 메모예요.
"얼음 적게"
cancelledReasonStringALPHA 주문 취소 사유"고객 요청으로 인한 취소"
paymentsPayment[]✅결제 내역
discountsDiscount[]✅할인 내역
accrualsOrderAccrual[]ALPHA 적립 내역
redemptionsOrderRedemption[]ALPHA 혜택 사용 내역
chargePriceOrderChargePrice✅청구 금액
ordererOrderOrdererALPHA 주문자 정보

ALPHA 주문자 정보 (OrderOrderer) ​

주문 생성 시 입력한 주문자 정보예요. 주문 생성 - 주문자 정보를 참고하세요.

FieldTypeRequiredDescriptionExample
memberIdString주문자 회원 식별자"0123"

주문 상태 (OrderState) ​

ValueDescription
"REQUESTED"주문 수락 전 (픽업 주문 등의 경우)
"OPENED"시작됨
"COMPLETED"완료됨 (결제까지 완료된 상태)
"CANCELLED"취소됨
"UNDEFINED"

주문 내역 (OrderLineItem) ​

주문에 포함된 개별 상품 주문 건이에요.

FieldTypeRequiredDescriptionExample
diningOptionOrderDiningOption✅식사 옵션"HERE"
itemOrderItem✅상품
itemPriceOrderItemPrice✅상품 가격
optionChoicesOrderItemOptionChoice[]✅선택한 옵션
appliedDiscountsDiscount[]✅항목별 적용 할인 내역
quantityLong✅수량1
memoString주문 내역 메모

주문자 또는 매장 운영자가 이 주문 내역에 대해 추가로 작성한 메모예요.
"얼음 적게"

주문 식사 옵션 (OrderDiningOption) ​

ValueDescription
"HERE"매장 식사
"TOGO"포장
"DELIVERY"배달
"PICKUP"포장 (픽업)
"UNDEFINED"

상품 (OrderItem) ​

FieldTypeRequiredDescriptionExample
titleString✅상품명"아메리카노"
codeString상품 코드""
categoryOrderItemCategory✅상품이 속한 카테고리

상품 가격 (OrderItemPrice) ​

NameTypeRequiredDescriptionExample
titleString✅가격명"기본"
priceTypeOrderItemPriceType✅가격 종류"FIXED"
priceUnitLong✅가격 단위1
priceValueLong✅가격3000
isTaxFreeBoolean✅면세 여부false
taxPercentageInt세율10
taxInclusiveBoolean✅부가세 포함 여부true

상품 가격 종류 (OrderItemPriceType) ​

ValueDescription
"FIXED"정가
"VARIABLE"시가
"UNIT"단위가격
"UNDEFINED"

카테고리 (OrderItemCategory) ​

FieldTypeRequiredDescriptionExample
titleString✅카테고리명"커피"
codeString카테고리 코드""

옵션 (OrderItemOption) ​

FieldTypeRequiredDescriptionExample
titleString✅옵션명"온도"

옵션 선택지 (OrderItemOptionChoice) ​

FieldTypeRequiredDescriptionExample
titleString✅선택지명"ICE"
codeString선택지 코드"ICE"
priceValueLong✅가격500
quantityLong✅수량1
optionOrderItemOption선택지가 속한 옵션

주문 요청 정보 (OrderRequestedInfo) ​

배달 또는 픽업 주문과 같이, 매장에서 수락 또는 거절할 수 있는 주문의 경우 주문 요청 정보를 포함하고 있어요.

FieldTypeRequiredDescriptionExample
requestedAttimestamp주문 요청 시각"2025-09-01T00:00:00"
expiredAttimestamp주문 요청 만료 시각"2025-09-01T00:00:00"
expectedReadyAttimestamp주문의 예상 완료 시각
손님 기준에서의 예상 완료 시각을 의미해요. (예: 손님이 15분 뒤 픽업 예정)
"2025-09-01T00:00:00"
estimatedReadyAttimestamp주문의 예상 준비 완료 시각
매장 기준에서의 예상 완료 시각을 의미해요. (예: 20분 뒤 픽업 가능)
"2025-09-01T00:00:00"
allowedEstimatedReadyDurationsDuration[]ALPHA 주문 수락 시 선택 가능한 예상 준비 완료 시간 목록 (예: 토스 POS에서 예상 준비 시간을 10분, 20분 중 하나로 선택 가능)["PT10M", "PT20M"]
acceptedAttimestamp주문 수락 시각"2025-09-01T00:00:00"
declinedAttimestamp주문 거절 시각"2025-09-01T00:00:00"
declinedReasonStringALPHA 주문 거절 사유"메뉴 품절"
declinedCodeStringALPHA 주문 거절 사유 코드
예시:
- 고객 요청 ("CUSTOMER_REQUEST")
- 메뉴 품절 ("MENU_SOLD_OUT")
- 주문 밀림 ("COOKING_DELAY")
- 요청사항 불가 ("REQUEST_UNAVAILABLE")
"MENU_SOLD_OUT"

주문 청구 금액 (OrderChargePrice) ​

NameTypeRequiredDescriptionExample
listPriceLong✅원금액3500
discountAmountLong✅할인금액-300
tipAmountLong✅팁0
serviceChargeAmountLong✅봉사료0
taxAmountLong✅세액291
supplyAmountLong✅공급가액2909
taxExemptAmountLong✅면세금액0
totalAmountLong✅최종금액3200

할인 내역 (Discount) ​

할인 정책이 주문에 적용된 결과예요. 주문 조회 시 할인 관련 필드를 통해 적용 결과를 함께 확인할 수 있어요.

NameTypeRequiredDescriptionExample
titleString✅할인명"PROMOTION"
typeString할인 종류 (예: "FIXED_AMOUNT", "FIXED_PERCENTAGE")"FIXED_AMOUNT"
codeString할인 코드"PROMOTION_00"
amountLong✅할인 적용 금액1000
percentageDouble✅정률할인 비율 (정률할인이 아닌 경우 0.0)0.0
fixedAmountLong✅정액할인 금액 (정액할인이 아닌 경우 0)1000
precedenceInt할인 적용 우선순위 (값이 작을수록 높은 우선순위)1
couponDetailsDiscountCouponDetailsALPHA 할인 쿠폰 상세 정보

ALPHA 할인 쿠폰 상세 정보 (DiscountCouponDetails) ​

NameTypeRequiredDescriptionExample
providerString✅쿠폰 제공자"토스플레이스"
couponNumberString쿠폰 번호"123456"
balanceLong쿠폰 잔액1000

ALPHA 적립 내역 (OrderAccrual) ​

NameTypeRequiredDescriptionExample
nameString✅적립명"토스플레이스 적립"
referenceTypeString✅원천 구분자. 멱등성 보장에 사용해요."TOSSPOINT"
referenceIdString✅구분 내 식별자. 멱등성 보장에 사용해요."TP-001"
occurredAttimestamp✅적립 발생 시각"2026-01-01T00:00:00+09:00"
pointDetailsOrderAccrualPointDetails포인트 적립 세부 내역
stampDetailsOrderAccrualStampDetails스탬프 적립 세부 내역

ALPHA 포인트 적립 상세 (OrderAccrualPointDetails) ​

NameTypeRequiredDescriptionExample
providerString✅적립 제공처"TOSSPLACE"
amountInt✅적립 포인트. 적립이면 양수, 회수면 음수.100
balanceInt적립 후 누적 잔액1000

ALPHA 스탬프 적립 상세 (OrderAccrualStampDetails) ​

NameTypeRequiredDescriptionExample
providerString✅적립 제공처"TOSSPLACE"
countInt✅적립 스탬프 수. 적립이면 양수, 회수면 음수.1
balanceInt적립 후 누적 스탬프 수5

ALPHA 혜택 사용 내역 (OrderRedemption) ​

NameTypeRequiredDescriptionExample
nameString✅혜택 사용명"포인트 사용"
referenceTypeString✅원천 구분자. 멱등성 보장에 사용해요."TOSSPOINT_REDEMPTION"
referenceIdString✅구분 내 식별자. 멱등성 보장에 사용해요."TP-001"
occurredAttimestamp✅혜택 사용 발생 시각"2026-01-01T00:00:00+09:00"
pointDetailsOrderRedemptionPointDetails포인트 사용 세부 내역
couponDetailsOrderRedemptionCouponDetails쿠폰 사용 세부 내역

ALPHA 포인트 사용 상세 (OrderRedemptionPointDetails) ​

NameTypeRequiredDescriptionExample
providerString✅혜택 제공처"TOSSPLACE"
amountInt✅사용 포인트. 사용이면 양수, 취소면 음수.500
balanceInt사용 후 잔액500

ALPHA 쿠폰 사용 상세 (OrderRedemptionCouponDetails) ​

NameTypeRequiredDescriptionExample
providerString✅혜택 제공처"TOSSPLACE"
couponNumberString쿠폰 번호"CPN-123456"
countInt✅사용 쿠폰 수. 사용이면 양수, 취소면 음수.1