sayren Docs
클레임

클레임 목록 조회

GET
/v1/claims

Authorization

accessToken
headerAuthorizationBearer <token>

Sayren 계정 토큰(로그인 토큰 또는 개인 액세스 토큰, RFC 9068 JWT)

Query Parameters

type?string

클레임 유형 필터

Value in"CANCEL""RETURN""EXCHANGE"
status?string

클레임 상태 필터. 쉼표로 여러 개를 줄 수 있다 (예: REQUESTED,HELD,COLLECTED)

orderItemId?string

주문상품 id 필터

requestedFrom?string

요청 시각 조회 시작 (ISO 8601, 포함)

requestedTo?string

요청 시각 조회 끝 (ISO 8601, 포함)

page?string

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

size?string

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

Header Parameters

X-Store-Id*string

대상 상점 id. 토큰의 상점 범위 밖이면 403 STORE_NOT_GRANTED, 없으면 400 STORE_ID_REQUIRED다

Response Body

성공

application/json
  1. response
meta*
data*
error*|null
curl -X GET 'https://api.sayren.io/v1/claims' \  -H 'X-Store-Id: string'
{  "meta": {    "status": 200,    "code": "OK",    "message": "OK",    "isSuccess": true  },  "data": {    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0,    "contents": [      {        "claimId": "string",        "claimNo": null,        "type": "CANCEL",        "status": "REQUESTED",        "orderId": "string",        "orderItemId": "string",        "productName": "string",        "quantity": 0,        "reason": "CHANGE_OF_MIND",        "reasonDetail": "string",        "responsibility": "BUYER",        "claimDeliveryFee": 0,        "expectedRefundAmount": 0,        "expectedDeliveryFeeRefundAmount": 0,        "expectedPointRefundAmount": 0,        "exchangeOption": {          "optionId": "string",          "optionName": "string"        },        "collect": {          "method": "SELLER_PICKUP",          "carrierCode": "string",          "trackingNumber": "string"        },        "fulfillmentType": "SHIPPING",        "requestedAt": "string",        "completedAt": "string",        "holdExpiresAt": "string",        "holdUsed": true,        "returnAddress": {          "name": "string",          "contactName": "string",          "phone": "string",          "zipCode": "string",          "address1": "string",          "address2": "string"        }      }    ]  },  "error": null}