목록 조회 — 상품
“상품”의 데이터를 조회합니다. 결과는 이 작업의 매개변수에 따라 달라집니다.
GET/api/v1/products
- 인증
Bearer- 최소 요금제
- STANDARD
- 필수 권한
catalog.product:read
코드 예제
요청 예제
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request GET \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--url "${SHOPENTLY_SHOP_URL%/}"'/api/v1/products?limit=20'
PHP
<?php
declare(strict_types=1);
$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
isset($origin['query']) || isset($origin['fragment'])) {
throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/products?limit=20');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 30,
CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
if (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
throw new RuntimeException('HTTP ' . $status . '; request_id=' .
($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;
Python
from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit
import requests # python -m pip install requests
base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
headers["Content-Type"] = "application/json"
with ExitStack() as stack:
session = stack.enter_context(requests.Session())
files = None
if False:
image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
if os.fstat(image.fileno()).st_size > 5242880:
raise ValueError("Image exceeds 5 MiB")
files = {"file": ("article.png", image, "image/png")}
response = session.request(
'GET', base_url + '/api/v1/products?limit=20', headers=headers,
data=body.encode("utf-8") if body is not None else None, files=files,
timeout=(5, 30), allow_redirects=False,
)
if not 200 <= response.status_code < 300:
raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
if False:
if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
raise ValueError("Unexpected image response")
with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
output.write(response.content)
else:
result = response.json() if response.content else None
print(json.dumps(result, ensure_ascii=False, indent=2))
응답 예제 200
{
"data": [
{
"availability": {
"available_from": null,
"available_until": null,
"is_available": true
},
"brand_id": null,
"condition": "new",
"created_at": "2026-01-01T12:00:00Z",
"id": "example",
"name": "Example",
"number": "example",
"price": {
"amount": "0.00",
"currency": "PLN",
"minor_units": 2,
"tax_included": true
},
"price_version": 1,
"primary_category_id": "example",
"primary_media_id": "example",
"published": false,
"sku": "example",
"slug": "example",
"tax_category_id": "example",
"updated_at": "2026-01-01T12:00:00Z",
"variants_enabled": false,
"version": 1
}
],
"meta": {
"locale": "en",
"market_code": "PL",
"market_id": "example",
"pagination": {
"has_more": false,
"limit": 20,
"next_cursor": null
},
"request_id": "example"
}
}
작동 방식
연동은 초안을 포함해 삭제되지 않은 모든 상품을 읽을 수 있지만 요금제 한도로 차단된 상품은 제외됩니다. 차단된 상품은 목록에 나타나지 않고 직접 접근하면 entitlements.resource_blocked 를 반환합니다. 따라서 API의 상품 가시성은 스토어 공개 상태와 다릅니다.
매개변수
쿼리 매개변수
limit정수선택 사항이 페이지의 최대 레코드 수입니다.
minimum:1maximum:100cursor문자열 null선택 사항이전 페이지가 반환한 불투명한 이어 보기 값입니다.
문자열:minLength:1maxLength:1024locale문자열 null선택 사항이 요청에서 선택한 언어입니다.
문자열:minLength:2maxLength:20market_id문자열 null선택 사항컨텍스트 엔드포인트가 반환한 시장 식별자입니다.
제약 조건 · 문자열 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_code문자열 null선택 사항컨텍스트 엔드포인트가 반환한 시장 코드입니다.
문자열:minLength:1maxLength:16sku문자열 null선택 사항재고 관리 단위 코드입니다.
문자열:minLength:1maxLength:100제약 조건 · 문자열 1
pattern"^\\S+$"
published불리언 null선택 사항리소스가 공개되어 있는지 나타냅니다.
brand_id문자열 null선택 사항브랜드 식별자입니다.
제약 조건 · 문자열 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
category_id문자열 null선택 사항카테고리 식별자입니다.
제약 조건 · 문자열 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
이 작업은 JSON 본문을 받지 않습니다.
응답
응답 200
전체 모델: ApiResponse_list_ProductSummaryData__
data배열 <ProductSummaryData> 필수성공 응답의 데이터입니다.
필드 ·
dataavailabilityAvailabilityData필수선택한 컨텍스트의 판매 가능 정보입니다.
brand_id문자열 null필수브랜드 식별자입니다.
condition문자열필수상품 상태입니다.
제약 조건
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_at문자열필수생성 시각입니다.
format:"date-time"id문자열필수리소스 식별자이며 반환된 값을 그대로 유지해야 합니다.
name문자열 null필수해당 컨텍스트의 리소스 이름입니다.
number문자열필수사용자에게 표시하는 주문 또는 요청 번호입니다.
pricePriceDatanull필수선택한 컨텍스트의 가격 정보입니다.
price_version정수필수동시성 제어를 위한 현재 가격 버전입니다.
primary_category_id문자열 null필수기본 카테고리 식별자입니다.
primary_media_id문자열 null필수기본 미디어 자산 식별자입니다.
published불리언필수리소스가 공개되어 있는지 나타냅니다.
sku문자열필수재고 관리 단위 코드입니다.
slug문자열 null필수선택한 언어의 URL 경로 조각입니다.
tax_category_id문자열필수세금 분류 식별자입니다.
updated_at문자열필수가장 최근 업데이트 시각입니다.
format:"date-time"variants_enabled불리언필수상품이 옵션 조합을 사용하는지 나타냅니다.
version정수필수동시성 제어에 사용하는 리소스 버전입니다.
metaContextPageMetaContextMetaPageMetaRequestMeta필수응답 메타데이터입니다.
필드 ·
metalocale문자열필수이 요청에서 선택한 언어입니다.
market_code문자열필수컨텍스트 엔드포인트가 반환한 시장 코드입니다.
market_id문자열필수컨텍스트 엔드포인트가 반환한 시장 식별자입니다.
paginationPagination필수커서 기반 페이지 나누기 메타데이터입니다.
request_id문자열필수고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.
minLength:1maxLength:100
locale문자열필수이 요청에서 선택한 언어입니다.
market_code문자열필수컨텍스트 엔드포인트가 반환한 시장 코드입니다.
market_id문자열필수컨텍스트 엔드포인트가 반환한 시장 식별자입니다.
request_id문자열필수고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.
minLength:1maxLength:100
paginationPagination필수커서 기반 페이지 나누기 메타데이터입니다.
request_id문자열필수고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.
minLength:1maxLength:100
request_id문자열필수고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.
minLength:1maxLength:100
HTTP 상태
200- 성공 응답 스키마
400- 잘못된 요청
401- 인증 필요
403- 권한 없음
404- 리소스를 찾을 수 없음
409- 버전 충돌
422- 유효성 검사 실패
429- 요청 한도 초과
기타 HTTP 상태 (7)
405- 허용되지 않은 메서드
413- 요청이 너무 큼
415- 지원하지 않는 형식
500- 서버 오류
502- API 게이트웨이 오류
503- 서비스 이용 불가
504- 시간 초과
오류 목록: ErrorResponse
헤더
401
WWW-Authenticate문자열선택 사항서버가 요구하는 인증 방식입니다.
405
Allow문자열선택 사항이 리소스가 지원하는 HTTP 메서드입니다.
429, 503
Retry-After정수선택 사항재시도 전에 기다려야 하는 최소 시간(초)입니다.
minimum:0