Hangi — Tagastused, kaebused ja vahetused
Lugege andmeid ressursist „Tagastused, kaebused ja vahetused“. Tulemus sõltub toimingu parameetritest.
GET/api/v1/requests/{request_id}
- Autentimine
Bearer- Saadaval alates
- BASIC
- Nõutavad õigused
returns.request:read
Koodinäited
Päringu näide
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))
Vastuse näide 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"
}
}
Kuidas see toimib
- Kasuta kogumi ja üksikasjade lõpp-punkte pöördumise numbri ja tüübi, seotud tellimuse, esitatud kaupade, kliendiandmete ja tagastusteabe saamiseks.
- Kehtivad tüübid on return, exchange ja complaint.
- Loe olekuidentifikaatorid /api/v1/request-statuses kaudu.
- Olek ja tagastussumma on eraldi versioonikontrolliga muudatused.
- Salvestatud tagastussumma muutmine uuendab pöördumise kirjet; see ei teosta rahaülekannet.
Parameetrid
Tee parameetrid
request_idStringKohustuslikPöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.
Piirangud
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
See toiming ei võta vastu JSON-sisu.
Vastused
Vastus 200
Täielik mudel: ApiResponse_RequestDetailData_
dataRequestDetailDataKohustuslikEduka vastuse andmed.
Väljad ·
dataTäielik mudel:
RequestDetailDatacreated_atStringKohustuslikLoomise aeg.
format:"date-time"customerRequestCustomerDataKohustuslikSelle ressursi juurde salvestatud klienditeave.
Väljad ·
customerTäielik mudel:
RequestCustomerDataemailStringKohustuslikE-posti aadress.
nameStringKohustuslikRessursi nimi vastavas kontekstis.
idStringKohustuslikRessursi identifikaator; säilita see tagastatud kujul.
itemsMassiiv <RequestItemData> KohustuslikRessursis sisalduvad kirjed.
Väljad ·
itemsnumberStringKohustuslikKasutajale mõeldud tellimuse või pöördumise number.
order_idStringKohustuslikSeotud tellimuse identifikaator.
order_numberStringKohustuslikSeotud tellimuse number.
products_valueMoneyDataKohustuslikTellimuse toodete väärtus.
Väljad ·
products_valueamountStringKohustuslikJSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.
currencyStringKohustuslikSumma valuutakood.
Piirangud
pattern"^[A-Z]{3}$"
minor_unitsTäisarvKohustuslikValuuta kasutatavate kümnendkohtade arv.
minimum:0maximum:4
refundRefundDataKohustuslikSalvestatud tagastusteave.
Väljad ·
refundamountMoneyDatanullKohustuslikJSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.
completed_atString nullKohustuslikLõpetamise aeg.
String:format:"date-time"statusStringKohustuslikSelle konkreetse toimingu lubatud olek.
Piirangud
enum["pending", "completed"]
updated_atString nullKohustuslikViimase uuendamise aeg.
String:format:"date-time"versionTäisarvKohustuslikRessursi versioon samaaegsuse kontrolliks.
resolution_stateStringKohustuslikKliendipöördumise lahendamise olek.
Piirangud
enum["unknown", "open", "completed", "rejected", "cancelled"]
statusRequestStatusDataKohustuslikSelle konkreetse toimingu lubatud olek.
Väljad ·
statusTäielik mudel:
RequestStatusDataidStringKohustuslikRessursi identifikaator; säilita see tagastatud kujul.
localeStringKohustuslikSelle päringu jaoks valitud keel.
nameString nullKohustuslikRessursi nimi vastavas kontekstis.
typeRequestTypeKohustuslikRessursi tüüp.
updated_atStringKohustuslikViimase uuendamise aeg.
format:"date-time"versionTäisarvKohustuslikRessursi versioon samaaegsuse kontrolliks.
metaContextPageMetaContextMetaPageMetaRequestMetaKohustuslikVastuse metaandmed.
Väljad ·
metaTäielik mudel:
ContextPageMetalocaleStringKohustuslikSelle päringu jaoks valitud keel.
market_codeStringKohustuslikKonteksti lõpp-punkti tagastatud turukood.
market_idStringKohustuslikKonteksti lõpp-punkti tagastatud turuidentifikaator.
paginationPaginationKohustuslikKursoripõhise lehekülgjaotuse metaandmed.
request_idStringKohustuslikPöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.
minLength:1maxLength:100
localeStringKohustuslikSelle päringu jaoks valitud keel.
market_codeStringKohustuslikKonteksti lõpp-punkti tagastatud turukood.
market_idStringKohustuslikKonteksti lõpp-punkti tagastatud turuidentifikaator.
request_idStringKohustuslikPöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.
minLength:1maxLength:100
paginationPaginationKohustuslikKursoripõhise lehekülgjaotuse metaandmed.
request_idStringKohustuslikPöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.
minLength:1maxLength:100
request_idStringKohustuslikPöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.
minLength:1maxLength:100
HTTP-olek
200- Edukas vastus Skeem
400- Vigane päring
401- Autentimine on nõutav
403- Juurdepääs keelatud
404- Ressurssi ei leitud
409- Versioonikonflikt
422- Valideerimine nurjus
429- Päringupiirang ületatud
Muud HTTP olekud (7)
405- Meetod pole lubatud
413- Päring on liiga suur
415- Vormingut ei toetata
500- Serveri viga
502- API lüüsi viga
503- Teenus pole saadaval
504- Ajalimiit ületatud
Veakataloog: ErrorResponse
Päised
401
WWW-AuthenticateStringValikulineServeri nõutav autentimisskeem.
405
AllowStringValikulineSelle ressursi toetatud HTTP-meetodid.
429, 503
Retry-AfterTäisarvValikulineMinimaalne viivitus enne korduskatset, sekundites.
minimum:0