API 호출 전 확인 사항
인증
인증을 확인하세요.
최소 요금제
스토어 요금제에 필요한 API 기능이 포함되어 있는지 확인하세요.
필수 권한
키 권한과 전송하는 필드의 조건을 확인하세요.
필요한 요금제
| 최소 요금제 | 설명 |
|---|---|
| BASIC | BASIC 에서는 주문과 고객 요청 조회, 해당 상태 변경, 주문 결제 상태 변경, 기록된 환불 금액 변경을 사용할 수 있습니다. |
| STANDARD | 카탈로그, CMS, 검색, 재고 작업은 STANDARD 이상이 필요합니다. |
기존 구독 스토어에도 해당 요금제에 포함된 API 기능이 제공됩니다.
작업별 권한
- 참조 문서에는 각 작업의 required_scopes 와 민감한 필드 또는 변경에 필요한 conditional_scopes 가 나와 있습니다.
- 리소스 읽기 권한만으로 생성, 편집, 삭제할 수는 없습니다.
- 리소스 권한이 명시되지 않아도 토큰 발급과 컨텍스트 조회에는 인증이 필요합니다.
목록 조회
GET/api/v1/products
- 인증
Bearer- 최소 요금제
- STANDARD
- 필수 권한
catalog.product:read
수정
PATCH/api/v1/products/{product_id}
- 인증
Bearer- 최소 요금제
- STANDARD
- 필수 권한
catalog.product:update
추가 권한이 필요한 경우
수정
PATCH/api/v1/products/{product_id}
- 인증
Bearer- 최소 요금제
- STANDARD
- 필수 권한
catalog.product:update- 특정 필드의 추가 권한
- variant_value_ids 필드를 포함하는 경우:
catalog.product_variant:create,catalog.product_variant:update,catalog.product_variant:delete - variants_enabled 필드를 포함하는 경우:
catalog.product_variant:update
- variant_value_ids 필드를 포함하는 경우:
요금제 변경 시 동작
요금제 하향으로 권한을 잃으면 API 키에서 해당 권한이 제거되고 관리자 패널의 선택 항목은 선택 해제 후 비활성화됩니다.