Ugrás a tartalomhoz
ShopentlyLearn

Listázás — Rendelések

Olvassa be a(z) „Rendelések” adatait. Az eredmény a művelet paramétereitől függ.

GET/api/v1/orders

Hitelesítés
Bearer
Elérhető ettől a csomagtól
BASIC
Szükséges jogosultságok
orders.order:read

Kódpéldák

Példakérés

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/orders?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/orders?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/orders?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))

Példaválasz 200

JSON
{
  "data": [
    {
      "created_at": "2026-10-19T10:00:00Z",
      "customer": {
        "email": "customer@example.invalid",
        "first_name": "Example",
        "last_name": "Example",
        "phone": null
      },
      "delivery": {
        "amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "dates": {
          "dispatch_timezone": "Europe/Warsaw",
          "estimated_delivery_from": "2026-10-20",
          "estimated_delivery_to": "2026-10-21",
          "planned_dispatch_on": "2026-10-19"
        },
        "method_code": "shipping-old",
        "method_name": "Historic carrier",
        "pickup_point": null,
        "recipient_mode": "full_address"
      },
      "discount_amount": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "id": "order-0000",
      "lifecycle_state": "placed",
      "locale": "pl",
      "market_id": "market-pl",
      "number": "0001",
      "payment": {
        "amount": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "environment": "live",
        "method_code": "payment-old",
        "method_name": "Historic method",
        "paid_at": null,
        "status": "unpaid",
        "updated_at": "2026-10-19T10:00:00Z",
        "version": 0
      },
      "prices_include_tax": true,
      "shipping_discount_amount": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "status": {
        "id": "status-0",
        "name": "Status 0",
        "updated_at": "2026-10-19T10:00:00Z",
        "version": 1
      },
      "subtotal": {
        "amount": "329.40",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax": {
        "amount": "49.40",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_country_code": "PL",
      "total": {
        "amount": "329.40",
        "currency": "PLN",
        "minor_units": 2
      }
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "limit": 20,
      "next_cursor": null
    },
    "request_id": "example"
  }
}

Működés

  • A lista rendelés-összesítéseket és szám, állapot, fizetési állapot, illetve létrehozási idő szerinti szűrőket ad.
  • A rendeléslista és a részletek tartalmazzák a delivery.dates objektumot. A YYYY-MM-DD dátumok tervezettek, nem igazolják a feladást. Az aktuális dátumok elsőbbséget élveznek; a régebbi rendelések a mentett becslést használják. A törölt vagy ismeretlen érték null. A részletek minden tételt és termékképet is tartalmaznak.
  • Az érvényes állapotazonosítókat az /api/v1/order-statuses végpontból kérdezze le.
  • A rendelési és fizetési állapot külön PATCH végpontot és jogosultságot használ.
  • A rögzített fizetési állapot módosítása nem terhel bankkártyát, és nem indít visszatérítést a fizetési szolgáltatónál.

Rendelés · Összesítések

Az összegek és adókulcsok a mentett rendelésből származnak, a tételjavításokkal együtt. A hiányzó előzmény null, és nem helyettesíthető a katalógus aktuális adókulcsaival. Az összegek decimális karakterláncok maradnak.

A lista összefoglalókat ad vissza. Minden találathoz kérje le a GET /api/v1/orders/{order_id} végpontot a teljes pénzügyi exporthoz. A GET-ismétlések korlátozottak és figyelembe veszik a Retry-After értékét. A létrehozási dátum szerinti export nem szinkronizál későbbi javításokat.

Paraméterek

Lekérdezési paraméterek

limitEgész számNem kötelező

Az oldalon szereplő rekordok maximális száma.

minimum: 1maximum: 100
Alapértelmezett: 50Példa: 20
cursorKarakterlánc nullNem kötelező

Az előző oldal által visszaadott, átlátszatlan folytatási érték.

Karakterlánc:minLength: 1maxLength: 1024
numberKarakterlánc nullNem kötelező

A rendelés vagy bejelentés felhasználóknak szánt száma.

Karakterlánc:minLength: 1maxLength: 48
status_idKarakterlánc nullNem kötelező

A megfelelő állapotszótárból kapott azonosító.

Korlátozások · Karakterlánc 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
payment_statusKarakterlánc nullNem kötelező

A rögzített fizetési állapot.

Korlátozások · Karakterlánc 1
enum
["unpaid", "paid", "failed", "refunded"]
created_fromKarakterlánc nullNem kötelező

A létrehozási idő szerinti szűrés kezdete.

Karakterlánc:format: "date-time"
created_toKarakterlánc nullNem kötelező

A létrehozási idő szerinti szűrés vége.

Karakterlánc:format: "date-time"

Ez a művelet nem fogad JSON-törzset.

Válaszok

Válasz 200

dataTömb <OrderSummaryData > Kötelező

A sikeres válasz adatai.

Mezők · data

OrderSummaryData

created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"
customerCustomerData Kötelező

Az erőforráshoz rögzített ügyféladatok.

deliveryShippingData Kötelező

Szállítási mód és kapcsolódó adatok.

discount_amountMoneyData Kötelező

JSON-karakterláncként kódolt tizedes összeg; null csak ott, ahol engedélyezett.

idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg.

lifecycle_stateOrderLifecycleState Kötelező

Az üzleti életciklus állapota.

localeKarakterláncKötelező

A kéréshez kiválasztott nyelv.

market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

numberKarakterláncKötelező

A rendelés vagy bejelentés felhasználóknak szánt száma.

paymentPaymentData Kötelező

A rendeléshez rögzített fizetési adatok.

prices_include_taxLogikai értékKötelező

Jelzi, hogy a felsorolt árak tartalmazzák-e az adót.

shipping_discount_amountMoneyData Kötelező

JSON-karakterláncként kódolt tizedes összeg; null csak ott, ahol engedélyezett.

statusOrderStatusData Kötelező

Az adott művelet által elfogadott állapot.

subtotalMoneyData Kötelező

Összeg a válaszban feltüntetett további összetevők hozzáadása előtt.

taxMoneyData Kötelező

Adóadatok.

tax_country_codeKarakterlánc nullKötelező

Adózási ország · Mentett rendelési adatok · ISO 3166-1 alpha-2; null.

totalMoneyData Kötelező

Teljes összeg.

metaContextPageMeta ContextMeta PageMeta RequestMeta Kötelező

A válasz metaadatai.

Mezők · meta

ContextPageMeta

localeKarakterláncKötelező

A kéréshez kiválasztott nyelv.

market_codeKarakterláncKötelező

A környezetvégpont által visszaadott piackód.

market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

paginationPagination Kötelező

A kurzoros lapozás metaadatai.

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100

ContextMeta

localeKarakterláncKötelező

A kéréshez kiválasztott nyelv.

market_codeKarakterláncKötelező

A környezetvégpont által visszaadott piackód.

market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100

PageMeta

paginationPagination Kötelező

A kurzoros lapozás metaadatai.

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100

RequestMeta

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100
Példaválasz

HTTP-állapot

200
Sikeres válasz Séma
400
Érvénytelen kérés
401
Hitelesítés szükséges
403
Hozzáférés megtagadva
404
Az erőforrás nem található
409
Verzióütközés
422
Sikertelen ellenőrzés
429
Kérésszámkorlát túllépve
További HTTP-állapotok (7)
405
Nem engedélyezett metódus
413
Túl nagy kérés
415
Nem támogatott formátum
500
Szerverhiba
502
API-átjáróhiba
503
A szolgáltatás nem érhető el
504
Időtúllépés

Hibakatalógus: ErrorResponse

Fejlécek

401

WWW-AuthenticateKarakterláncNem kötelező

A szerver által megkövetelt hitelesítési séma.

405

AllowKarakterláncNem kötelező

Az erőforrás által támogatott HTTP-metódusok.

429, 503

Retry-AfterEgész számNem kötelező

Az újrapróbálás előtti minimális várakozás másodpercben.

minimum: 0