Przejdź do treści
ShopentlyLearn

Pobierz listę zamówień

Pobierz listę zamówień przez Shopently API. Parametry limit, cursor, number, status_id. Przykłady cURL, PHP i Python.

GET/api/v1/orders

Uwierzytelnianie
Bearer
Dostępne od planu
BASIC
Wymagane uprawnienia
orders.order:read

Przykłady kodu

Przykład żądania

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

Przykład odpowiedzi 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"
  }
}

Jak to działa

  • Lista udostępnia podsumowania i filtry numeru, statusu, statusu płatności i daty utworzenia.
  • Lista i szczegóły zamówienia zawierają delivery.dates. Daty YYYY-MM-DD są planowane, nie potwierdzają nadania. Bieżące daty mają pierwszeństwo; dla starszych zamówień używana jest zapisana estymacja. Wyczyszczone lub nieznane wartości to null. Szczegóły zawierają też wszystkie pozycje i zdjęcia produktów.
  • Prawidłowe identyfikatory statusów pobierz z /api/v1/order-statuses.
  • Status zamówienia i status płatności mają oddzielne endpointy PATCH i uprawnienia.
  • Zmiana zapisanego statusu płatności nie obciąża karty ani nie zleca zwrotu u operatora płatności.

Zamówienie · Podsumowania

Kwoty i stawki podatku pochodzą z zapisanego zamówienia, z uwzględnieniem korekt pozycji. Brakująca historia ma wartość null; nie zastępują jej bieżące stawki z katalogu. Kwoty pozostają tekstami dziesiętnymi.

Lista zwraca podsumowania. Dla każdego wyniku pobierz GET /api/v1/orders/{order_id}, aby wyeksportować pełne rozliczenie. Ponawianie GET jest ograniczone i uwzględnia Retry-After. Eksport według daty utworzenia nie synchronizuje późniejszych korekt.

Parametry

Parametry zapytania

limitLiczba całkowitaOpcjonalne

Maksymalna liczba rekordów na tej stronie.

minimum: 1maximum: 100
Wartość domyślna: 50Przykład: 20
cursorTekst nullOpcjonalne

Nieinterpretowany znacznik kontynuacji zwrócony na poprzedniej stronie.

Tekst:minLength: 1maxLength: 1024
numberTekst nullOpcjonalne

Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

Tekst:minLength: 1maxLength: 48
status_idTekst nullOpcjonalne

Identyfikator pobrany z odpowiedniego słownika statusów.

Ograniczenia · Tekst 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
payment_statusTekst nullOpcjonalne

Zapisany status płatności.

Ograniczenia · Tekst 1
enum
["unpaid", "paid", "failed", "refunded"]
created_fromTekst nullOpcjonalne

Początek zakresu filtrowania według daty utworzenia.

Tekst:format: "date-time"
created_toTekst nullOpcjonalne

Koniec zakresu filtrowania według daty utworzenia.

Tekst:format: "date-time"

Ta operacja nie przyjmuje treści JSON.

Odpowiedzi

Odpowiedź 200

dataTablica <OrderSummaryData > Wymagane

Dane poprawnej odpowiedzi.

Pola · data

OrderSummaryData

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"
customerCustomerData Wymagane

Dane klienta zapisane dla tego zasobu.

deliveryShippingData Wymagane

Metoda dostawy i powiązane informacje.

discount_amountMoneyData Wymagane

Kwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API.

lifecycle_stateOrderLifecycleState Wymagane

Stan cyklu życia biznesowego.

localeTekstWymagane

Język wybrany dla tego żądania.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

numberTekstWymagane

Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

paymentPaymentData Wymagane

Szczegóły płatności zapisane dla zamówienia.

prices_include_taxWartość logicznaWymagane

Czy ceny w cenniku zawierają podatek.

shipping_discount_amountMoneyData Wymagane

Kwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.

statusOrderStatusData Wymagane

Status obsługiwany przez daną operację.

subtotalMoneyData Wymagane

Kwota przed dodatkowymi składnikami pokazanymi w odpowiedzi.

taxMoneyData Wymagane

Informacje o podatku.

tax_country_codeTekst nullWymagane

Kraj podatkowy · Zapisana migawka zamówienia · ISO 3166-1 alpha-2; null.

totalMoneyData Wymagane

Łączna kwota.

metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Pola · meta

ContextPageMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

ContextMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100
Przykład odpowiedzi

Status HTTP

200
Poprawna odpowiedź Schemat
400
Nieprawidłowe żądanie
401
Wymagane uwierzytelnienie
403
Brak uprawnień
404
Nie znaleziono zasobu
409
Konflikt wersji
422
Błąd walidacji danych
429
Przekroczono limit zapytań
Pozostałe statusy HTTP (7)
405
Niedozwolona metoda
413
Zbyt duże żądanie
415
Nieobsługiwany format
500
Błąd serwera
502
Błąd bramy API
503
Usługa niedostępna
504
Przekroczono czas odpowiedzi

Katalog błędów: ErrorResponse

Nagłówki

401

WWW-AuthenticateTekstOpcjonalne

Schemat uwierzytelniania wymagany przez serwer.

405

AllowTekstOpcjonalne

Metody HTTP obsługiwane przez ten zasób.

429, 503

Retry-AfterLiczba całkowitaOpcjonalne

Minimalny czas przed ponowieniem, w sekundach.

minimum: 0