목록 조회 — 주문
“주문”의 데이터를 조회합니다. 결과는 이 작업의 매개변수에 따라 달라집니다.
GET/api/v1/orders
- 인증
Bearer- 최소 요금제
- BASIC
- 필수 권한
orders.order: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/orders?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/orders?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/orders?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": [
{
"created_at": "2026-10-19T10:00:00Z",
"customer": {
"email": "customer@example.invalid",
"first_name": "Example",
"last_name": "Example",
"phone": null
},
"delivery": {
"amount": {
"amount": "0.00",
"currency": "PLN",
"minor_units": 2
},
"dates": {
"dispatch_timezone": "Europe/Warsaw",
"estimated_delivery_from": "2026-10-20",
"estimated_delivery_to": "2026-10-21",
"planned_dispatch_on": "2026-10-19"
},
"method_code": "shipping-old",
"method_name": "Historic carrier",
"pickup_point": null,
"recipient_mode": "full_address"
},
"discount_amount": {
"amount": "24.60",
"currency": "PLN",
"minor_units": 2
},
"id": "order-0000",
"lifecycle_state": "placed",
"locale": "pl",
"market_id": "market-pl",
"number": "0001",
"payment": {
"amount": {
"amount": "329.40",
"currency": "PLN",
"minor_units": 2
},
"environment": "live",
"method_code": "payment-old",
"method_name": "Historic method",
"paid_at": null,
"status": "unpaid",
"updated_at": "2026-10-19T10:00:00Z",
"version": 0
},
"prices_include_tax": true,
"shipping_discount_amount": {
"amount": "24.60",
"currency": "PLN",
"minor_units": 2
},
"status": {
"id": "status-0",
"name": "Status 0",
"updated_at": "2026-10-19T10:00:00Z",
"version": 1
},
"subtotal": {
"amount": "329.40",
"currency": "PLN",
"minor_units": 2
},
"tax": {
"amount": "49.40",
"currency": "PLN",
"minor_units": 2
},
"tax_country_code": "PL",
"total": {
"amount": "329.40",
"currency": "PLN",
"minor_units": 2
}
}
],
"meta": {
"pagination": {
"has_more": false,
"limit": 20,
"next_cursor": null
},
"request_id": "example"
}
}
작동 방식
- 컬렉션은 주문 요약과 번호, 상태, 결제 상태, 생성 시간 필터를 제공합니다.
- 주문 목록과 상세 정보에는 delivery.dates가 포함됩니다. YYYY-MM-DD 날짜는 예정이며 실제 발송을 확인하지 않습니다. 현재 날짜가 우선하며 이전 주문은 저장된 예상치를 사용합니다. 삭제되거나 알 수 없는 값은 null입니다. 상세 정보에는 모든 주문 항목과 상품 이미지도 포함됩니다.
- 유효한 상태 식별자는 /api/v1/order-statuses 에서 가져오세요.
- 주문 상태와 결제 상태는 별도의 PATCH 엔드포인트와 권한을 사용합니다.
- 기록된 결제 상태를 변경해도 카드 결제나 결제 서비스 제공자를 통한 환불은 실행되지 않습니다.
주문 · 합계
금액과 세율은 항목 수정 사항을 포함한 저장된 주문에서 가져옵니다. 과거 데이터가 없으면 null이며 현재 카탈로그 세율로 채우지 않습니다. 금액은 십진수 문자열로 유지합니다.
목록은 요약을 반환합니다. 각 결과에 대해 GET /api/v1/orders/{order_id}를 조회하여 전체 금액 명세를 내보내세요. GET 재시도는 제한되며 Retry-After를 따릅니다. 생성일 기준 내보내기는 이후 수정 사항을 동기화하지 않습니다.
매개변수
쿼리 매개변수
limit정수선택 사항이 페이지의 최대 레코드 수입니다.
minimum:1maximum:100cursor문자열 null선택 사항이전 페이지가 반환한 불투명한 이어 보기 값입니다.
문자열:minLength:1maxLength:1024number문자열 null선택 사항사용자에게 표시하는 주문 또는 요청 번호입니다.
문자열:minLength:1maxLength:48status_id문자열 null선택 사항해당 상태 사전에서 얻은 식별자입니다.
제약 조건 · 문자열 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
payment_status문자열 null선택 사항기록된 결제 상태입니다.
제약 조건 · 문자열 1
enum["unpaid", "paid", "failed", "refunded"]
created_from문자열 null선택 사항생성 시각 필터의 시작입니다.
문자열:format:"date-time"created_to문자열 null선택 사항생성 시각 필터의 종료입니다.
문자열:format:"date-time"
이 작업은 JSON 본문을 받지 않습니다.
응답
응답 200
전체 모델: ApiResponse_list_OrderSummaryData__
data배열 <OrderSummaryData> 필수성공 응답의 데이터입니다.
필드 ·
datacreated_at문자열필수생성 시각입니다.
format:"date-time"customerCustomerData필수이 리소스에 기록된 고객 정보입니다.
deliveryShippingData필수배송 방법과 관련 정보입니다.
discount_amountMoneyData필수JSON 문자열로 인코딩한 십진수 금액입니다. null 은 허용된 경우에만 사용합니다.
id문자열필수리소스 식별자이며 반환된 값을 그대로 유지해야 합니다.
lifecycle_stateOrderLifecycleState필수업무 수명 주기 상태입니다.
locale문자열필수이 요청에서 선택한 언어입니다.
market_id문자열필수컨텍스트 엔드포인트가 반환한 시장 식별자입니다.
number문자열필수사용자에게 표시하는 주문 또는 요청 번호입니다.
paymentPaymentData필수주문에 기록된 결제 상세 정보입니다.
prices_include_tax불리언필수표시 가격에 세금이 포함되는지 나타냅니다.
shipping_discount_amountMoneyData필수JSON 문자열로 인코딩한 십진수 금액입니다. null 은 허용된 경우에만 사용합니다.
statusOrderStatusData필수이 작업에서 허용하는 상태입니다.
subtotalMoneyData필수응답에 표시된 추가 구성 요소를 반영하기 전 금액입니다.
taxMoneyData필수세금 정보입니다.
tax_country_code문자열 null필수과세 국가 · 저장된 주문 데이터 · ISO 3166-1 alpha-2; null.
totalMoneyData필수총금액입니다.
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