Skip to content

주문 - 주문 조회

Methods

주문 단건 조회

PropertyValue
MethodGET
Path/api-public/openapi/v1/merchants/{merchantId}/order/orders/{orderId}
Response TypeOrder
Description매장의 주문 하나를 조회해요.

요청 파라미터

ParameterLocationTypeRequiredDefaultDescription
merchantIdPathLong-매장 ID
orderIdPathString-주문 ID

주문 복수건 조회

PropertyValue
MethodGET
Path/api-public/openapi/v1/merchants/{merchantId}/order/orders/by-ids
Response TypeOrder[]
DescriptionID를 통해 매장의 주문 여러 건을 조회해요. 최대 25건까지 조회 가능해요.

요청 파라미터

ParameterLocationTypeRequiredDefaultDescription
merchantIdPathLong-매장 ID
idsQueryString[]-주문 ID 목록

주문 키로 주문 단건 조회

PropertyValue
MethodGET
Path/api-public/openapi/v1/merchants/{merchantId}/order/orders/by-order-key/{orderKey}
Response TypeOrder
Description주어진 주문 키 값을 가지는 주문 하나를 조회해요.

요청 파라미터

ParameterLocationTypeRequiredDefaultDescription
merchantIdPathLong-매장 ID
orderKeyPathString-주문 키

주문 키로 주문 복수건 조회

PropertyValue
MethodGET
Path/api-public/openapi/v1/merchants/{merchantId}/order/orders/by-order-keys
Response TypeOrder[]
Description주어진 주문 키 값들을 가지는 주문 여러 건을 조회해요. 최대 25건까지 조회 가능해요.

요청 파라미터

ParameterLocationTypeRequiredDefaultDescription
merchantIdPathLong-매장 ID
orderKeysQueryString[]-주문 키 목록

주문 목록 조회

PropertyValue
MethodGET
Path/api-public/openapi/v1/merchants/{merchantId}/order/orders
Response TypeOrder[]
Description매장의 주문 목록을 주문의 결제 내역 변동 시각 순으로 조회해요.

요청 파라미터

ParameterLocationTypeRequiredDefaultDescription
merchantIdPathLong-매장 ID
fromQuerytimestamp-조회 범위 시작점으로, 이 시점 이후에 결제 내역이 변동된 주문만 조회해요.
toQuerytimestamp-조회 범위 끝점으로, 이 시점 이전에 결제 내역이 변동된 주문만 조회해요.
orderStatesQueryOrderState[]["COMPLETED", "CANCELLED"]주문 상태 필터로, 파라미터로 주어진 값의 상태를 가지는 주문만 조회해요.
sourcesQueryString[]-주문 채널 필터로, 파라미터로 주어진 값의 주문 채널을 가지는 주문만 조회해요.
pageQueryInt1조회할 페이지
sizeQueryInt100페이지 크기
sortOrderQuerySortOrder"DESC"정렬 순서 (주문 결제 내역 변동 시각 기준)