Przejdź do treści
ShopentlyLearn

Pobierz zgłoszenie klienta

Pobierz zgłoszenie klienta przez Shopently API. Identyfikator request_id. Przykłady cURL, PHP i Python.

GET/api/v1/requests/{request_id}

Uwierzytelnianie
Bearer
Dostępne od planu
BASIC
Wymagane uprawnienia
returns.request:read

Przykłady kodu

Przykład żądania

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

Przykład odpowiedzi 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 działa

  • Endpointy listy i szczegółów udostępniają numer i typ zgłoszenia, powiązane zamówienie, zgłoszone pozycje, dane klienta i informacje o zwrocie.
  • Typy zgłoszeń to return, exchange i complaint.
  • Identyfikatory statusów pobierz z /api/v1/request-statuses.
  • Status i kwota zwrotu są oddzielnymi zapisami z kontrolą wersji.
  • Zmiana zapisanej kwoty zwrotu aktualizuje zgłoszenie; nie wykonuje przelewu środków.

Parametry

Parametry ścieżki

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

Ograniczenia
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Przykład: "example"

Ta operacja nie przyjmuje treści JSON.

Odpowiedzi

Odpowiedź 200

dataRequestDetailData Wymagane

Dane poprawnej odpowiedzi.

Pola · data
created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"
customerRequestCustomerData Wymagane

Dane klienta zapisane dla tego zasobu.

Pola · customer
emailTekstWymagane

Adres e-mail.

nameTekstWymagane

Nazwa zasobu we właściwym kontekście.

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API.

itemsTablica <RequestItemData > Wymagane

Pozycje zawarte w zasobie.

Pola · items
numberTekstWymagane

Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

order_idTekstWymagane

Identyfikator powiązanego zamówienia.

order_numberTekstWymagane

Numer powiązanego zamówienia.

products_valueMoneyData Wymagane

Wartość produktów w zamówieniu.

Pola · products_value
amountTekstWymagane

Kwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.

currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia
pattern
"^[A-Z]{3}$"
minor_unitsLiczba całkowitaWymagane

Liczba cyfr części ułamkowej używanych przez walutę.

minimum: 0maximum: 4
refundRefundData Wymagane

Zapisane informacje o zwrocie środków.

Pola · refund
amountMoneyData nullWymagane

Kwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.

completed_atTekst nullWymagane

Data i czas zakończenia.

Tekst:format: "date-time"
statusTekstWymagane

Status obsługiwany przez daną operację.

Ograniczenia
enum
["pending", "completed"]
updated_atTekst nullWymagane

Data i czas ostatniej aktualizacji.

Tekst:format: "date-time"
versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

resolution_stateTekstWymagane

Stan rozpatrzenia zgłoszenia klienta.

Ograniczenia
enum
["unknown", "open", "completed", "rejected", "cancelled"]
statusRequestStatusData Wymagane

Status obsługiwany przez daną operację.

Pola · status
idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API.

localeTekstWymagane

Język wybrany dla tego żądania.

nameTekst nullWymagane

Nazwa zasobu we właściwym kontekście.

typeRequestType Wymagane

Typ zasobu.

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"
versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Pola · meta

ContextPageMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

ContextMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100
Przykład odpowiedzi

Status HTTP

200
Poprawna odpowiedź Schemat
400
Nieprawidłowe żądanie
401
Wymagane uwierzytelnienie
403
Brak uprawnień
404
Nie znaleziono zasobu
409
Konflikt wersji
422
Błąd walidacji danych
429
Przekroczono limit zapytań
Pozostałe statusy HTTP (7)
405
Niedozwolona metoda
413
Zbyt duże żądanie
415
Nieobsługiwany format
500
Błąd serwera
502
Błąd bramy API
503
Usługa niedostępna
504
Przekroczono czas odpowiedzi

Katalog błędów: ErrorResponse

Nagłówki

401

WWW-AuthenticateTekstOpcjonalne

Schemat uwierzytelniania wymagany przez serwer.

405

AllowTekstOpcjonalne

Metody HTTP obsługiwane przez ten zasób.

429, 503

Retry-AfterLiczba całkowitaOpcjonalne

Minimalny czas przed ponowieniem, w sekundach.

minimum: 0