Přejít na obsah
ShopentlyLearn

Načíst — Vrácení, reklamace a výměny

Načtěte data z „Vrácení, reklamace a výměny“. Výsledek závisí na parametrech této operace.

GET/api/v1/requests/{request_id}

Ověřování
Bearer
Dostupné od tarifu
BASIC
Požadovaná oprávnění
returns.request:read

Příklady kódu

Příklad požadavku

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

Příklad odpovědi 200

JSON
{
  "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"
  }
}

Jak to funguje

  • Koncové body seznamu a podrobností poskytují číslo a typ požadavku, související objednávku, nahlášené položky, údaje zákazníka a informace o vrácení peněz.
  • Platné typy požadavků jsou return, exchange a complaint.
  • Identifikátory stavů načtěte z /api/v1/request-statuses.
  • Stav a částka vrácení peněz se upravují samostatnými zápisy s kontrolou verzí.
  • Změna evidované částky aktualizuje záznam požadavku; neprovede převod peněz.

Parametry

Parametry cesty

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

Omezení
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "example"

Tato operace nepřijímá tělo JSON.

Odpovědi

Odpověď 200

dataRequestDetailData Povinné

Obsah úspěšné odpovědi.

Pole · data
created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"
customerRequestCustomerData Povinné

Údaje zákazníka zaznamenané u tohoto zdroje.

Pole · customer
emailŘetězecPovinné

E-mailová adresa.

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

itemsPole <RequestItemData > Povinné

Položky zahrnuté ve zdroji.

Pole · items
numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

order_idŘetězecPovinné

Identifikátor související objednávky.

order_numberŘetězecPovinné

Číslo související objednávky.

products_valueMoneyData Povinné

Hodnota produktů v objednávce.

Pole · products_value
amountŘetězecPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

currencyŘetězecPovinné

Kód měny částky.

Omezení
pattern
"^[A-Z]{3}$"
minor_unitsCelé čísloPovinné

Počet desetinných míst používaných měnou.

minimum: 0maximum: 4
refundRefundData Povinné

Evidované informace o vrácení peněz.

Pole · refund
amountMoneyData nullPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

completed_atŘetězec nullPovinné

Čas dokončení.

Řetězec:format: "date-time"
statusŘetězecPovinné

Stav přijímaný touto konkrétní operací.

Omezení
enum
["pending", "completed"]
updated_atŘetězec nullPovinné

Čas poslední aktualizace.

Řetězec:format: "date-time"
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

resolution_stateŘetězecPovinné

Stav vyřízení zákaznického požadavku.

Omezení
enum
["unknown", "open", "completed", "rejected", "cancelled"]
statusRequestStatusData Povinné

Stav přijímaný touto konkrétní operací.

Pole · status
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

nameŘetězec nullPovinné

Název zdroje v příslušném kontextu.

typeRequestType Povinné

Typ zdroje.

updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metadata odpovědi.

Pole · meta

ContextPageMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

ContextMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100
Příklad odpovědi

Stav HTTP

200
Úspěšná odpověď Schéma
400
Neplatný požadavek
401
Vyžadováno ověření
403
Přístup odepřen
404
Zdroj nenalezen
409
Konflikt verzí
422
Chyba validace
429
Překročen limit požadavků
Další stavy HTTP (7)
405
Metoda není povolena
413
Příliš velký požadavek
415
Nepodporovaný formát
500
Chyba serveru
502
Chyba brány API
503
Služba nedostupná
504
Vypršel časový limit

Katalog chyb: ErrorResponse

Hlavičky

401

WWW-AuthenticateŘetězecVolitelné

Způsob ověření požadovaný serverem.

405

AllowŘetězecVolitelné

Metody HTTP podporované tímto zdrojem.

429, 503

Retry-AfterCelé čísloVolitelné

Minimální prodleva před opakováním v sekundách.

minimum: 0