Отримати — Повернення, рекламації та обміни
Отримайте дані з «Повернення, рекламації та обміни». Результат залежить від параметрів цієї операції.
GET/api/v1/requests/{request_id}
- Автентифікація
Bearer- Доступно починаючи з
- BASIC
- Потрібні дозволи
returns.request: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/requests/example
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/requests/example');
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/requests/example', 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-01-01T12:00:00Z",
"customer": {
"email": "customer@example.invalid",
"name": "Example"
},
"id": "example",
"items": [
{
"id": "example",
"name": "Example",
"order_line_id": "example",
"product_id": "example",
"quantity": 1,
"returned_quantity": 1,
"sku": "example",
"total": {
"amount": "0.00",
"currency": "PLN",
"minor_units": 2
},
"unit_price": {
"amount": "0.00",
"currency": "PLN",
"minor_units": 2
},
"variant_id": "example",
"variant_options": [
{
"name": "Example",
"value": "example"
}
]
}
],
"number": "example",
"order_id": "example",
"order_number": "example",
"products_value": {
"amount": "0.00",
"currency": "PLN",
"minor_units": 2
},
"refund": {
"amount": {
"amount": "0.00",
"currency": "PLN",
"minor_units": 2
},
"completed_at": null,
"status": "pending",
"updated_at": "2026-01-01T12:00:00Z",
"version": 1
},
"resolution_state": "unknown",
"status": {
"id": "example",
"locale": "en",
"name": "Example"
},
"type": "return",
"updated_at": "2026-01-01T12:00:00Z",
"version": 1
},
"meta": {
"request_id": "example"
}
}
Як це працює
- Використовуйте кінцеві точки списку й деталей для отримання номера й типу звернення, пов’язаного замовлення, заявлених товарів, даних клієнта та повернення коштів.
- Допустимі типи звернень: return, exchange та complaint.
- Отримуйте ідентифікатори статусів через /api/v1/request-statuses.
- Зміна статусу й суми повернення — окремі операції запису з перевіркою версій.
- Зміна записаної суми повернення оновлює звернення, але не виконує переказ коштів.
Параметри
Параметри шляху
request_idРядокОбов’язковеІдентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.
Обмеження
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Ця операція не приймає тіло JSON.
Відповіді
Відповідь 200
Повна модель: ApiResponse_RequestDetailData_
dataRequestDetailDataОбов’язковеДані успішної відповіді.
Поля ·
dataПовна модель:
RequestDetailDatacreated_atРядокОбов’язковеЧас створення.
format:"date-time"customerRequestCustomerDataОбов’язковеВідомості про клієнта, записані для цього ресурсу.
Поля ·
customerПовна модель:
RequestCustomerDataemailРядокОбов’язковеАдреса електронної пошти.
nameРядокОбов’язковеНазва ресурсу у відповідному контексті.
idРядокОбов’язковеІдентифікатор ресурсу; зберігайте його в отриманому вигляді.
itemsМасив <RequestItemData> Обов’язковеПозиції, включені до ресурсу.
Поля ·
itemsnumberРядокОбов’язковеЗрозумілий користувачу номер замовлення або звернення.
order_idРядокОбов’язковеІдентифікатор пов’язаного замовлення.
order_numberРядокОбов’язковеНомер пов’язаного замовлення.
products_valueMoneyDataОбов’язковеВартість товарів у замовленні.
Поля ·
products_valueamountРядокОбов’язковеДесяткова сума у вигляді рядка JSON; null лише там, де це дозволено.
currencyРядокОбов’язковеКод валюти суми.
Обмеження
pattern"^[A-Z]{3}$"
minor_unitsЦіле числоОбов’язковеКількість десяткових знаків валюти.
minimum:0maximum:4
refundRefundDataОбов’язковеЗаписані відомості про повернення коштів.
Поля ·
refundamountMoneyDatanullОбов’язковеДесяткова сума у вигляді рядка JSON; null лише там, де це дозволено.
completed_atРядок nullОбов’язковеЧас завершення.
Рядок:format:"date-time"statusРядокОбов’язковеСтатус, допустимий для цієї конкретної операції.
Обмеження
enum["pending", "completed"]
updated_atРядок nullОбов’язковеЧас останнього оновлення.
Рядок:format:"date-time"versionЦіле числоОбов’язковеВерсія ресурсу для контролю одночасних змін.
resolution_stateРядокОбов’язковеСтан вирішення звернення клієнта.
Обмеження
enum["unknown", "open", "completed", "rejected", "cancelled"]
statusRequestStatusDataОбов’язковеСтатус, допустимий для цієї конкретної операції.
Поля ·
statusПовна модель:
RequestStatusDataidРядокОбов’язковеІдентифікатор ресурсу; зберігайте його в отриманому вигляді.
localeРядокОбов’язковеМова, вибрана для цього запиту.
nameРядок nullОбов’язковеНазва ресурсу у відповідному контексті.
typeRequestTypeОбов’язковеТип ресурсу.
updated_atРядокОбов’язковеЧас останнього оновлення.
format:"date-time"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