sayren Docs
컬렉션

컬렉션 목록

목록 순서(`sortOrder`) 순이다. `stateCounts`는 `q`·`type`·`productId`를 적용하고 `state`는 적용하기 전의 상태별 건수다. 상점당 최대 200개다

GET
/v1/collections

목록 순서(sortOrder) 순이다. stateCounts는 q·type·productId를 적용하고 state는 적용하기 전의 상태별 건수다. 상점당 최대 200개다

Authorization

accessToken
headerAuthorizationBearer <token>

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

Query Parameters

q?string

제목·주소 검색(포함, 대소문자 무시)

type?string

유형

Value in"MANUAL""AUTOMATIC"
state?string

노출 상태

Value in"ACTIVE""SCHEDULED""ENDED""HIDDEN"
productId?string

이 상품이 담긴 직접 선택 컬렉션만

page?string

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

size?string

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

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/collections' \  -H 'X-Store-Id: string'
{  "meta": {    "status": 200,    "code": "OK",    "message": "OK",    "isSuccess": true  },  "data": {    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0,    "contents": [      {        "collectionId": "string",        "type": "string",        "title": "string",        "slug": "string",        "description": "string",        "imageUrl": "string",        "productSort": "string",        "rules": [          {            "field": "createdWithinDays",            "value": 1          }        ],        "visible": true,        "startsAt": "string",        "endsAt": "string",        "sortOrder": 0,        "metaTitle": "string",        "metaDescription": "string",        "state": "ACTIVE",        "salesComputedAt": null,        "productCount": 0,        "revision": 0,        "createdAt": "string",        "updatedAt": "string"      }    ],    "stateCounts": {      "ALL": 0,      "ACTIVE": 0,      "SCHEDULED": 0,      "ENDED": 0,      "HIDDEN": 0    }  },  "error": null}