Gå til indhold
ShopentlyLearn

Vis liste — Ordrer

Læs data fra ”Ordrer”. Resultatet afhænger af handlingens parametre.

GET/api/v1/orders

Godkendelse
Bearer
Tilgængelig fra
BASIC
Nødvendige rettigheder
orders.order:read

Kodeeksempler

Eksempel på forespørgsel

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

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

Principper

  • Samlingen giver ordreoversigter og filtre for nummer, status, betalingsstatus og oprettelsestidspunkt.
  • Ordrelisten og detaljer indeholder delivery.dates. Datoer i YYYY-MM-DD er planlagte og bekræfter ikke afsendelse. Aktuelle datoer har forrang; ældre ordrer bruger det gemte estimat. Slettede eller ukendte værdier er null. Detaljer indeholder også alle ordrelinjer og produktbilleder.
  • Hent gyldige statusidentifikatorer fra /api/v1/order-statuses.
  • Ordrestatus og betalingsstatus bruger separate PATCH-endepunkter og rettigheder.
  • Ændring af den registrerede betalingsstatus trækker ikke penge på et kort og udløser ikke en refusion via en betalingsudbyder.

Ordre · Totaler

Beløb og satser kommer fra den gemte ordre, inklusive rettelser af linjer. Manglende historiske oplysninger er null og erstattes ikke med katalogets aktuelle satser. Beløb forbliver decimalstrenge.

Listen returnerer oversigter. Hent GET /api/v1/orders/{order_id} for hvert resultat for at eksportere fulde økonomiske oplysninger. GET-forsøg er begrænsede og følger Retry-After. Eksport efter oprettelsesdato synkroniserer ikke senere rettelser.

Parametre

Forespørgselsparametre

limitHeltalValgfrit

Maksimalt antal poster på denne side.

minimum: 1maximum: 100
Standard: 50Eksempel: 20
cursorStreng nullValgfrit

Uigennemsigtig fortsættelsesværdi returneret af den foregående side.

Streng:minLength: 1maxLength: 1024
numberStreng nullValgfrit

Ordre- eller sagsnummer beregnet til mennesker.

Streng:minLength: 1maxLength: 48
status_idStreng nullValgfrit

Identifikator hentet fra den relevante statusliste.

Begrænsninger · Streng 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
payment_statusStreng nullValgfrit

Registreret betalingsstatus.

Begrænsninger · Streng 1
enum
["unpaid", "paid", "failed", "refunded"]
created_fromStreng nullValgfrit

Start på filteret for oprettelsestidspunkt.

Streng:format: "date-time"
created_toStreng nullValgfrit

Slutning på filteret for oprettelsestidspunkt.

Streng:format: "date-time"

Denne operation accepterer ikke JSON-indhold.

Svar

Svar 200

dataArray <OrderSummaryData > Obligatorisk

Indholdet af et vellykket svar.

Felter · data

OrderSummaryData

created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
customerCustomerData Obligatorisk

Kundeoplysninger registreret for denne ressource.

deliveryShippingData Obligatorisk

Leveringsmetode og tilhørende oplysninger.

discount_amountMoneyData Obligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

lifecycle_stateOrderLifecycleState Obligatorisk

Tilstand i forretningslivscyklussen.

localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

paymentPaymentData Obligatorisk

Betalingsoplysninger registreret for ordren.

prices_include_taxBoolesk værdiObligatorisk

Om de angivne priser inkluderer afgifter.

shipping_discount_amountMoneyData Obligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

statusOrderStatusData Obligatorisk

Status accepteret af denne specifikke operation.

subtotalMoneyData Obligatorisk

Beløb før de yderligere bestanddele vist i svaret.

taxMoneyData Obligatorisk

Afgiftsoplysninger.

tax_country_codeStreng nullObligatorisk

Skatteland · Gemte ordredata · ISO 3166-1 alpha-2; null.

totalMoneyData Obligatorisk

Samlet beløb.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorisk

Svarmetadata.

Felter · meta

ContextPageMeta

localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

market_codeStrengObligatorisk

Markedskode returneret af kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

ContextMeta

localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

market_codeStrengObligatorisk

Markedskode returneret af kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

RequestMeta

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel på svar

HTTP-status

200
Vellykket svar Skema
400
Ugyldig anmodning
401
Godkendelse påkrævet
403
Adgang nægtet
404
Ressource ikke fundet
409
Versionskonflikt
422
Validering mislykkedes
429
Grænsen for anmodninger er overskredet
Andre HTTP-statusser (7)
405
Metoden er ikke tilladt
413
Anmodningen er for stor
415
Formatet understøttes ikke
500
Serverfejl
502
Fejl i API-gateway
503
Tjenesten er utilgængelig
504
Tidsgrænsen er overskredet

Fejlkatalog: ErrorResponse

Headere

401

WWW-AuthenticateStrengValgfrit

Godkendelsesmetode, som serveren kræver.

405

AllowStrengValgfrit

HTTP-metoder, som denne ressource understøtter.

429, 503

Retry-AfterHeltalValgfrit

Mindste ventetid før næste forsøg, i sekunder.

minimum: 0