Перейти до вмісту
ShopentlyLearn

Отримати список — Повернення, рекламації та обміни

Отримайте дані з «Повернення, рекламації та обміни». Результат залежить від параметрів цієї операції.

GET/api/v1/requests

Автентифікація
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?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/requests?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/requests?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

JSON
{
  "data": [
    {
      "created_at": "2026-01-01T12:00:00Z",
      "customer": {
        "email": "customer@example.invalid",
        "name": "Example"
      },
      "id": "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": {
    "pagination": {
      "has_more": false,
      "limit": 20,
      "next_cursor": null
    },
    "request_id": "example"
  }
}

Як це працює

  • Використовуйте кінцеві точки списку й деталей для отримання номера й типу звернення, пов’язаного замовлення, заявлених товарів, даних клієнта та повернення коштів.
  • Допустимі типи звернень: return, exchange та complaint.
  • Отримуйте ідентифікатори статусів через /api/v1/request-statuses.
  • Зміна статусу й суми повернення — окремі операції запису з перевіркою версій.
  • Зміна записаної суми повернення оновлює звернення, але не виконує переказ коштів.

Параметри

Параметри запиту

limitЦіле числоНеобов’язкове

Максимальна кількість записів на цій сторінці.

minimum: 1maximum: 100
За замовчуванням: 50Приклад: 20
cursorРядок nullНеобов’язкове

Непрозоре значення для продовження, повернуте попередньою сторінкою.

Рядок:minLength: 1maxLength: 1024
numberРядок nullНеобов’язкове

Зрозумілий користувачу номер замовлення або звернення.

Рядок:minLength: 1maxLength: 48
typeRequestType nullНеобов’язкове

Тип ресурсу.

status_idРядок nullНеобов’язкове

Ідентифікатор із відповідного довідника статусів.

Обмеження · Рядок 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
order_idРядок nullНеобов’язкове

Ідентифікатор пов’язаного замовлення.

Обмеження · Рядок 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
order_numberРядок nullНеобов’язкове

Номер пов’язаного замовлення.

Рядок:minLength: 1maxLength: 48
created_fromРядок nullНеобов’язкове

Початок фільтра за часом створення.

Рядок:format: "date-time"
created_toРядок nullНеобов’язкове

Кінець фільтра за часом створення.

Рядок:format: "date-time"

Ця операція не приймає тіло JSON.

Відповіді

Відповідь 200

dataМасив <RequestSummaryData > Обов’язкове

Дані успішної відповіді.

Поля · data

RequestSummaryData

created_atРядокОбов’язкове

Час створення.

format: "date-time"
customerRequestCustomerData Обов’язкове

Відомості про клієнта, записані для цього ресурсу.

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

numberРядокОбов’язкове

Зрозумілий користувачу номер замовлення або звернення.

order_idРядокОбов’язкове

Ідентифікатор пов’язаного замовлення.

order_numberРядокОбов’язкове

Номер пов’язаного замовлення.

products_valueMoneyData Обов’язкове

Вартість товарів у замовленні.

refundRefundData Обов’язкове

Записані відомості про повернення коштів.

resolution_stateРядокОбов’язкове

Стан вирішення звернення клієнта.

Обмеження
enum
["unknown", "open", "completed", "rejected", "cancelled"]
statusRequestStatusData Обов’язкове

Статус, допустимий для цієї конкретної операції.

typeRequestType Обов’язкове

Тип ресурсу.

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"
versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

metaContextPageMeta ContextMeta PageMeta RequestMeta Обов’язкове

Метадані відповіді.

Поля · meta

ContextPageMeta

localeРядокОбов’язкове

Мова, вибрана для цього запиту.

market_codeРядокОбов’язкове

Код ринку, повернутий кінцевою точкою контексту.

market_idРядокОбов’язкове

Ідентифікатор ринку, повернутий кінцевою точкою контексту.

paginationPagination Обов’язкове

Метадані пагінації за курсором.

request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

minLength: 1maxLength: 100

ContextMeta

localeРядокОбов’язкове

Мова, вибрана для цього запиту.

market_codeРядокОбов’язкове

Код ринку, повернутий кінцевою точкою контексту.

market_idРядокОбов’язкове

Ідентифікатор ринку, повернутий кінцевою точкою контексту.

request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Обов’язкове

Метадані пагінації за курсором.

request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

minLength: 1maxLength: 100

RequestMeta

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