상품 목록 조회
등록된 상품들의 목록을 조회하는 API입니다.
상품 관리 화면, 사용자 쇼핑 화면, 외부 시스템 연동 등 다양한 상황에서 사용되며, 필터링 및 페이징을 통해 원하는 조건의 상품만 효율적으로 가져올 수 있습니다.
GET
https://api.bootapi.com/v1/products
상품 유형 구분
상품은 type 필드로 유형을 구분합니다:
- 0: 기본상품 - 배송이 필요 없는 디지털 상품, 서비스 등
- 1: 배송상품 - 실물 배송이 필요한 상품
- 구독상품 - use_subscription 필드로 구분
1
Server
SDK 설치
서버에서 API를 호출하기 위해 Backend SDK를 설치합니다.
SDK 설치 및 설정 방법은 토큰 발급 가이드를 참고하세요.
2
Server
상품 목록 조회 요청
필터 조건을 담아 API를 호출합니다.
요청 파라미터
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
type | number | 상품 유형 (0: 기본상품, 1: 배송상품) | |
period_type | string | 검색일 유형 (c_at: 생성일, u_at: 수정일) | |
s_at | string | 검색 시작일 (YYYY-MM-DD) | |
e_at | string | 검색 종료일 (YYYY-MM-DD) | |
use_subscription | boolean | 구독 상품만 조회할지 여부 | |
category_code | string | 카테고리 코드 | |
keyword | string | 검색 키워드 (product_id, 상품명, sku, barcode) | |
page | integer | 페이지 번호 (기본값: 1) | |
limit | integer | 페이지당 데이터 수 (기본값: 20) |
3
Server
응답 처리
상품 목록 데이터가 반환됩니다.
응답 데이터
| 파라미터 | 타입 | 설명 |
|---|---|---|
count | number | 조회된 데이터의 총 개수 |
list | Array<Product> | Product 모델 배열 |
