sayren Docs
Orders

주문 목록 조회

주문 시각 범위(최대 31일)로 주문 요약을 최신순으로 조회한다. 스코프 `order:r`. - `status`는 그 상태의 주문상품이 하나라도 있는 주문을 고른다. - `representativeStatus`는 첫 주문상품의 상태다. - 테스트 결제(샌드박스 결제) 주문은 `testPayment: true`다. 실제로 돈이 오가지 않았으므로 상품을 발송하지 않도록 주의한다. `testPayment` 쿼리로 테스트 결제만(`true`)·실결제만(`false`) 볼 수 있다. - method는 호환용이며 간편결제를 CARD로 표시한다. 실제 수단은 approvedMethod를 본다(`payment.approvedMethod` — 매출 리포트·스토어프론트·환불 원장과 같은 값).

GET
/v1/orders

주문 시각 범위(최대 31일)로 주문 요약을 최신순으로 조회한다. 스코프 order:r.

  • status는 그 상태의 주문상품이 하나라도 있는 주문을 고른다.
  • representativeStatus는 첫 주문상품의 상태다.
  • 테스트 결제(샌드박스 결제) 주문은 testPayment: true다. 실제로 돈이 오가지 않았으므로 상품을 발송하지 않도록 주의한다. testPayment 쿼리로 테스트 결제만(true)·실결제만(false) 볼 수 있다.
  • method는 호환용이며 간편결제를 CARD로 표시한다. 실제 수단은 approvedMethod를 본다(payment.approvedMethod — 매출 리포트·스토어프론트·환불 원장과 같은 값).

Authorization

bearer
AuthorizationBearer <token>

userToken(계정 스코프) 또는 storeToken(스토어 스코프)

In: header

Query Parameters

orderedFrom*string

조회 시작 시각 (ISO 8601 날짜 또는 일시, 포함). 필수

orderedTo?string

조회 끝 시각 (ISO 8601, 포함). 생략하면 orderedFrom부터 31일. 기간은 최대 31일

status?string

주문상품 상태 필터 — 이 상태의 주문상품이 하나라도 있는 주문

Value in

  • "PAYMENT_WAITING"
  • "PAID"
  • "CONFIRMED"
  • "DISPATCHED"
  • "DELIVERING"
  • "DELIVERED"
  • "PURCHASE_DECIDED"
  • "CANCELED"
keyword?string

주문번호(일치)·주문자명·수령인명(포함) 검색

page?string

페이지 번호 (1부터, 기본 1)

size?string

페이지 크기 (기본 20, 최대 100)

testPayment?string

테스트 결제(샌드박스 결제) 필터. true면 테스트 결제만, false면 실결제만, 생략하면 전부예요

Value in

  • "true"
  • "false"

Response Body

application/json

curl -X GET "https://example.com/v1/orders?orderedFrom=string"
{  "meta": {    "status": 0,    "code": "OK",    "message": "string",    "isSuccess": true  },  "data": {    "page": -9007199254740991,    "size": -9007199254740991,    "totalElements": -9007199254740991,    "totalPages": -9007199254740991,    "contents": [      {        "orderId": "string",        "ordererName": "string",        "itemCount": -9007199254740991,        "totalAmount": -9007199254740991,        "representativeStatus": "PAYMENT_WAITING",        "orderedAt": "string",        "testPayment": true      }    ]  },  "error": null}

Get delivery GET

Previous Page

주문 상세 조회 GET

주문자·배송지·결제 금액과 주문상품 전체를 조회한다. 스코프 `order:r`. 테스트 결제(샌드박스 결제) 주문은 `testPayment: true`다. 실제로 돈이 오가지 않았으므로 상품을 발송하지 않도록 주의한다. `testPayment` 쿼리로 테스트 결제만(`true`)·실결제만(`false`) 볼 수 있다. method는 호환용이며 간편결제를 CARD로 표시한다. 실제 수단은 approvedMethod를 본다(`payment.approvedMethod` — 매출 리포트·스토어프론트·환불 원장과 같은 값).