Hoppa till innehållet
ShopentlyLearn

Hämta — Returer, reklamationer och byten

Läs data från ”Returer, reklamationer och byten”. Resultatet beror på åtgärdens parametrar.

GET/api/v1/requests/{request_id}

Autentisering
Bearer
Tillgänglig från
BASIC
Behörigheter som krävs
returns.request:read

Kodexempel

Exempel på begäran

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

Exempel på svar 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"
  }
}

Så fungerar det

  • Använd samlings- och detaljendpoints för ärendenummer och typ, tillhörande beställning, anmälda artiklar, kunduppgifter och återbetalningsdata.
  • Giltiga ärendetyper är return, exchange och complaint.
  • Hämta statusidentifierare från /api/v1/request-statuses.
  • Status och återbetalningsbelopp ändras genom separata skrivningar med versionskontroll.
  • Att ändra det registrerade återbetalningsbeloppet uppdaterar ärendet men genomför ingen penningöverföring.

Parametrar

Sökvägsparametrar

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

Begränsningar
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exempel: "example"

Den här operationen tar inte emot JSON-innehåll.

Svar

Svar 200

dataRequestDetailData Obligatoriskt

Innehållet i ett lyckat svar.

Fält · data
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
customerRequestCustomerData Obligatoriskt

Kunduppgifter registrerade för resursen.

Fält · customer
emailSträngObligatoriskt

E-postadress.

nameSträngObligatoriskt

Resursens namn i aktuell kontext.

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

itemsArray <RequestItemData > Obligatoriskt

Artiklar eller poster som ingår i resursen.

Fält · items
numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

order_idSträngObligatoriskt

Identifierare för tillhörande beställning.

order_numberSträngObligatoriskt

Tillhörande beställningsnummer.

products_valueMoneyData Obligatoriskt

Värdet på produkterna i beställningen.

Fält · products_value
amountSträngObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar
pattern
"^[A-Z]{3}$"
minor_unitsHeltalObligatoriskt

Antal decimaler som används för valutan.

minimum: 0maximum: 4
refundRefundData Obligatoriskt

Registrerad information om återbetalning.

Fält · refund
amountMoneyData nullObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

completed_atSträng nullObligatoriskt

Tidpunkt för slutförande.

Sträng:format: "date-time"
statusSträngObligatoriskt

Status som accepteras av den aktuella operationen.

Begränsningar
enum
["pending", "completed"]
updated_atSträng nullObligatoriskt

Tidpunkt för senaste uppdatering.

Sträng:format: "date-time"
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

resolution_stateSträngObligatoriskt

Status för lösning av ett kundärende.

Begränsningar
enum
["unknown", "open", "completed", "rejected", "cancelled"]
statusRequestStatusData Obligatoriskt

Status som accepteras av den aktuella operationen.

Fält · status
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

localeSträngObligatoriskt

Språk valt för denna begäran.

nameSträng nullObligatoriskt

Resursens namn i aktuell kontext.

typeRequestType Obligatoriskt

Resurstyp.

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriskt

Metadata för svaret.

Fält · meta

ContextPageMeta

localeSträngObligatoriskt

Språk valt för denna begäran.

market_codeSträngObligatoriskt

Marknadskod returnerad av kontextendpointen.

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

ContextMeta

localeSträngObligatoriskt

Språk valt för denna begäran.

market_codeSträngObligatoriskt

Marknadskod returnerad av kontextendpointen.

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

RequestMeta

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100
Exempel på svar

HTTP-status

200
Lyckat svar Schema
400
Ogiltig begäran
401
Autentisering krävs
403
Åtkomst nekad
404
Resursen hittades inte
409
Versionskonflikt
422
Valideringen misslyckades
429
Anropsgränsen överskreds
Övriga HTTP-statusar (7)
405
Metoden tillåts inte
413
För stor begäran
415
Formatet stöds inte
500
Serverfel
502
Fel i API-gateway
503
Tjänsten är inte tillgänglig
504
Tidsgränsen överskreds

Felkatalog: ErrorResponse

HTTP-huvuden

401

WWW-AuthenticateSträngValfritt

Autentiseringsschema som servern kräver.

405

AllowSträngValfritt

HTTP-metoder som resursen stöder.

429, 503

Retry-AfterHeltalValfritt

Minsta väntetid före ett nytt försök, i sekunder.

minimum: 0