Treci la conținut
ShopentlyLearn

Listează — Retururi, reclamații și schimburi

Citiți datele din „Retururi, reclamații și schimburi”. Rezultatul depinde de parametrii acestei operațiuni.

GET/api/v1/requests

Autentificare
Bearer
Disponibil începând cu
BASIC
Permisiuni necesare
returns.request:read

Exemple de cod

Exemplu de cerere

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))

Exemplu de răspuns 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"
  }
}

Cum funcționează

  • Folosiți endpointurile de colecție și de detalii pentru numărul și tipul solicitării, comanda asociată, articolele incluse, datele clientului și informațiile despre rambursare.
  • Tipurile valide sunt return, exchange și complaint.
  • Obțineți identificatorii stărilor din /api/v1/request-statuses.
  • Starea și suma rambursării se modifică prin scrieri separate, cu verificarea versiunilor.
  • Modificarea sumei de rambursare înregistrate actualizează solicitarea; nu execută un transfer de bani.

Parametri

Parametri de interogare

limitNumăr întregOpțional

Numărul maxim de înregistrări pe această pagină.

minimum: 1maximum: 100
Valoare implicită: 50Exemplu: 20
cursorȘir de caractere nullOpțional

Valoare opacă de continuare returnată de pagina anterioară.

Șir de caractere:minLength: 1maxLength: 1024
numberȘir de caractere nullOpțional

Numărul comenzii sau al solicitării, destinat utilizatorilor.

Șir de caractere:minLength: 1maxLength: 48
typeRequestType nullOpțional

Tipul resursei.

status_idȘir de caractere nullOpțional

Identificator obținut din dicționarul de stări corespunzător.

Restricții · Șir de caractere 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
order_idȘir de caractere nullOpțional

Identificatorul comenzii asociate.

Restricții · Șir de caractere 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
order_numberȘir de caractere nullOpțional

Numărul comenzii asociate.

Șir de caractere:minLength: 1maxLength: 48
created_fromȘir de caractere nullOpțional

Începutul intervalului de filtrare după momentul creării.

Șir de caractere:format: "date-time"
created_toȘir de caractere nullOpțional

Sfârșitul intervalului de filtrare după momentul creării.

Șir de caractere:format: "date-time"

Această operație nu acceptă un corp JSON.

Răspunsuri

Răspuns 200

dataTablou <RequestSummaryData > Obligatoriu

Datele unui răspuns reușit.

Câmpuri · data

RequestSummaryData

created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"
customerRequestCustomerData Obligatoriu

Datele clientului înregistrate pentru această resursă.

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

numberȘir de caractereObligatoriu

Numărul comenzii sau al solicitării, destinat utilizatorilor.

order_idȘir de caractereObligatoriu

Identificatorul comenzii asociate.

order_numberȘir de caractereObligatoriu

Numărul comenzii asociate.

products_valueMoneyData Obligatoriu

Valoarea produselor din comandă.

refundRefundData Obligatoriu

Informațiile de rambursare înregistrate.

resolution_stateȘir de caractereObligatoriu

Starea de soluționare a unei solicitări a clientului.

Restricții
enum
["unknown", "open", "completed", "rejected", "cancelled"]
statusRequestStatusData Obligatoriu

Starea acceptată de această operație specifică.

typeRequestType Obligatoriu

Tipul resursei.

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriu

Metadatele răspunsului.

Câmpuri · meta

ContextPageMeta

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

market_codeȘir de caractereObligatoriu

Codul pieței returnat de endpointul de context.

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

paginationPagination Obligatoriu

Metadatele paginării prin cursor.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

ContextMeta

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

market_codeȘir de caractereObligatoriu

Codul pieței returnat de endpointul de context.

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatoriu

Metadatele paginării prin cursor.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100
Exemplu de răspuns

Stare HTTP

200
Răspuns reușit Schemă
400
Cerere nevalidă
401
Autentificare necesară
403
Acces refuzat
404
Resursa nu a fost găsită
409
Conflict de versiune
422
Validare eșuată
429
Limită de cereri depășită
Alte stări HTTP (7)
405
Metodă nepermisă
413
Cerere prea mare
415
Format neacceptat
500
Eroare de server
502
Eroare de gateway API
503
Serviciu indisponibil
504
Timp de așteptare depășit

Catalog de erori: ErrorResponse

Antete

401

WWW-AuthenticateȘir de caractereOpțional

Schema de autentificare cerută de server.

405

AllowȘir de caractereOpțional

Metodele HTTP acceptate de această resursă.

429, 503

Retry-AfterNumăr întregOpțional

Întârzierea minimă înainte de reîncercare, în secunde.

minimum: 0