Prikaži seznam — Naročila
Preberite podatke iz »Naročila«. Rezultat je odvisen od parametrov tega dejanja.
GET/api/v1/orders
- Preverjanje pristnosti
Bearer- Na voljo od paketa
- BASIC
- Zahtevana dovoljenja
orders.order:read
Primeri kode
Primer zahteve
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))
Primer odgovora 200
{
"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"
}
}
Kako deluje
- Zbirka vsebuje povzetke naročil in filtre po številki, statusu, plačilnem statusu in času nastanka.
- Seznam in podrobnosti naročila vsebujejo delivery.dates. Načrtovani datumi YYYY-MM-DD ne potrjujejo odpreme. Trenutni datumi imajo prednost; starejša naročila uporabljajo shranjeno oceno. Izbrisane ali neznane vrednosti so null. Podrobnosti vsebujejo tudi vse postavke in slike izdelkov.
- Veljavne identifikatorje statusov pridobite iz /api/v1/order-statuses.
- Status naročila in plačila uporabljata ločeni končni točki PATCH in dovoljenja.
- Sprememba zabeleženega plačilnega statusa ne bremeni kartice in ne izvede vračila pri ponudniku plačil.
Naročilo · Skupni zneski
Zneski in stopnje izvirajo iz shranjenega naročila, vključno s popravki postavk. Manjkajoči pretekli podatki so null in se ne nadomestijo s trenutnimi stopnjami kataloga. Zneski ostanejo decimalni nizi.
Seznam vrne povzetke. Za vsak rezultat pridobite GET /api/v1/orders/{order_id} za popolne finančne podatke. Ponovitve GET so omejene in upoštevajo Retry-After. Izvoz po datumu nastanka ne sinhronizira poznejših popravkov.
Parametri
Parametri poizvedbe
limitCelo številoIzbirnoNajvečje število zapisov na tej strani.
minimum:1maximum:100cursorNiz nullIzbirnoVrednost za nadaljevanje, vrnjena na prejšnji strani; njene notranje strukture ne razlagajte.
Niz:minLength:1maxLength:1024numberNiz nullIzbirnoUporabniku prikazana številka naročila ali zahtevka.
Niz:minLength:1maxLength:48status_idNiz nullIzbirnoIdentifikator iz ustreznega slovarja statusov.
Omejitve · Niz 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
payment_statusNiz nullIzbirnoZabeleženi plačilni status.
Omejitve · Niz 1
enum["unpaid", "paid", "failed", "refunded"]
created_fromNiz nullIzbirnoZačetek filtra časa nastanka.
Niz:format:"date-time"created_toNiz nullIzbirnoKonec filtra časa nastanka.
Niz:format:"date-time"
Ta operacija ne sprejema telesa JSON.
Odgovori
Odgovor 200
Celoten model: ApiResponse_list_OrderSummaryData__
dataPolje elementov <OrderSummaryData> ObveznoVsebina uspešnega odgovora.
Polja ·
dataCeloten model:
OrderSummaryDatacreated_atNizObveznoČas nastanka.
format:"date-time"customerCustomerDataObveznoPodatki stranke, zabeleženi za ta vir.
deliveryShippingDataObveznoNačin dostave in povezani podatki.
discount_amountMoneyDataObveznoDecimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.
idNizObveznoIdentifikator vira; ohranite ga v vrnjeni obliki.
lifecycle_stateOrderLifecycleStateObveznoStanje poslovnega življenjskega cikla.
localeNizObveznoJezik, izbran za to zahtevo.
market_idNizObveznoIdentifikator trga, vrnjen s končno točko konteksta.
numberNizObveznoUporabniku prikazana številka naročila ali zahtevka.
paymentPaymentDataObveznoPodrobnosti plačila, zabeležene za naročilo.
prices_include_taxLogična vrednostObveznoAli navedene cene vključujejo davek.
shipping_discount_amountMoneyDataObveznoDecimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.
statusOrderStatusDataObveznoStatus, ki ga sprejema ta operacija.
subtotalMoneyDataObveznoZnesek pred dodatnimi postavkami, prikazanimi v odgovoru.
taxMoneyDataObveznoDavčni podatki.
tax_country_codeNiz nullObveznoDavčna država · Shranjeni podatki naročila · ISO 3166-1 alpha-2; null.
totalMoneyDataObveznoSkupni znesek.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodatki odgovora.
Polja ·
metaCeloten model:
ContextPageMetalocaleNizObveznoJezik, izbran za to zahtevo.
market_codeNizObveznoKoda trga, vrnjena s končno točko konteksta.
market_idNizObveznoIdentifikator trga, vrnjen s končno točko konteksta.
paginationPaginationObveznoMetapodatki straničenja s kazalcem.
request_idNizObveznoIdentifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.
minLength:1maxLength:100
localeNizObveznoJezik, izbran za to zahtevo.
market_codeNizObveznoKoda trga, vrnjena s končno točko konteksta.
market_idNizObveznoIdentifikator trga, vrnjen s končno točko konteksta.
request_idNizObveznoIdentifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.
minLength:1maxLength:100
paginationPaginationObveznoMetapodatki straničenja s kazalcem.
request_idNizObveznoIdentifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.
minLength:1maxLength:100
request_idNizObveznoIdentifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.
minLength:1maxLength:100
Status HTTP
200- Uspešen odgovor Shema
400- Neveljavna zahteva
401- Potrebna je avtentikacija
403- Dostop zavrnjen
404- Vir ni najden
409- Spor različic
422- Preverjanje ni uspelo
429- Presežena omejitev zahtev
Druga stanja HTTP (7)
405- Metoda ni dovoljena
413- Zahteva je prevelika
415- Nepodprta oblika
500- Napaka strežnika
502- Napaka prehoda API
503- Storitev ni na voljo
504- Časovna omejitev je potekla
Katalog napak: ErrorResponse
Glave
401
WWW-AuthenticateNizIzbirnoShema preverjanja pristnosti, ki jo zahteva strežnik.
405
AllowNizIzbirnoMetode HTTP, ki jih podpira ta vir.
429, 503
Retry-AfterCelo številoIzbirnoNajkrajši zamik pred ponovitvijo v sekundah.
minimum:0