Abrufen — Bestellungen

Lesen Sie Daten aus „Bestellungen“. Das Ergebnis hängt von den Parametern dieser Operation ab.

GET`/api/v1/orders/{order_id}`

Authentifizierung: Bearer
Verfügbar ab: BASIC
Erforderliche Berechtigungen: orders.order:read

Beispielanfrage

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

Beispielantwort 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"
      },
      "discount_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discounts": [
        {
          "amount": {
            "amount": "24.60",
            "currency": "PLN",
            "minor_units": 2
          },
          "campaign_id": "saved-coupon",
          "code": "SAVE",
          "kind": "coupon",
          "name": "Saved coupon",
          "sequence": 1,
          "version": 3
        }
      ],
      "gross": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "method_code": "shipping-old",
      "method_name": "Historic carrier",
      "net": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "pickup_point": null,
      "recipient_mode": "full_address",
      "tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_category_id": "standard",
      "tax_category_name": "VAT 23%",
      "tax_rate": "0.23"
    },
    "discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "discounts": [
      {
        "amount": {
          "amount": "12.30",
          "currency": "PLN",
          "minor_units": 2
        },
        "campaign_id": "saved-coupon",
        "code": "SAVE",
        "kind": "coupon",
        "name": "Saved coupon",
        "sequence": 1,
        "shipping_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "version": 3
      }
    ],
    "id": "order-0000",
    "invoice": null,
    "invoice_requested": false,
    "lifecycle_state": "placed",
    "lines": [
      {
        "discount_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [
          {
            "amount": {
              "amount": "12.30",
              "currency": "PLN",
              "minor_units": 2
            },
            "campaign_id": "saved-coupon",
            "code": "SAVE",
            "kind": "coupon",
            "name": "Saved coupon",
            "sequence": 1,
            "shipping_amount": null,
            "version": 3
          }
        ],
        "identifiers": {},
        "image": null,
        "line_id": "saved-line-a",
        "manual_discount": {
          "amount": {
            "amount": "12.30",
            "currency": "PLN",
            "minor_units": 2
          },
          "kind": "fixed",
          "value": "12.30"
        },
        "name": "Saved A",
        "original_total": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "200.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "46.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 1,
        "product_id": "product-api",
        "quantity": 2,
        "sku": "A",
        "tax": {
          "amount": "20.70",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax_category_id": "standard",
        "tax_category_name": "VAT 23%",
        "tax_rate": "0.23",
        "total": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "180.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "41.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "23.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      },
      {
        "discount_amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [],
        "identifiers": {},
        "image": null,
        "line_id": "b548a171-c331-505f-98f8-db3a06070998",
        "manual_discount": null,
        "name": "Saved B",
        "original_total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 2,
        "product_id": "deleted-product",
        "quantity": 1,
        "sku": "B",
        "tax": null,
        "tax_category_id": "reduced",
        "tax_category_name": "VAT 8%",
        "tax_rate": "0.08",
        "total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      }
    ],
    "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
    },
    "pickup_point": null,
    "prices_include_tax": true,
    "shipping_address": null,
    "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_breakdown": {
      "groups": [
        {
          "gross": {
            "amount": "221.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "180.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "41.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        },
        {
          "gross": {
            "amount": "108.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "100.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "8.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.08"
        },
        {
          "gross": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "shipping",
          "tax": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        }
      ],
      "unallocated_tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      }
    },
    "tax_country_code": "PL",
    "total": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "totals": {
      "before_discounts": {
        "gross": {
          "amount": "378.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "320.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "58.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "discounts": {
        "gross": {
          "amount": "49.20",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "40.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "9.20",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "order": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "product_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products_before_discounts": {
        "gross": {
          "amount": "354.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "300.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "54.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping": {
        "gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_before_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      }
    }
  },
  "meta": {
    "request_id": "example-request"
  }
}

Funktionsweise

Die Sammlung enthält Zusammenfassungen und Filter für Nummer, Status, Zahlungsstatus und Erstellungszeit.
Bestelllisten und Details enthalten delivery.dates. Geplante Daten im Format YYYY-MM-DD bestätigen keinen Versand. Aktuelle Daten haben Vorrang; ältere Bestellungen verwenden die gespeicherte Schätzung. Gelöschte oder unbekannte Werte sind null. Details enthalten auch alle Positionen und Produktbilder.

Gültige Statuskennungen erhalten Sie über /api/v1/order-statuses.
Bestellstatus und Zahlungsstatus haben getrennte PATCH-Endpunkte und Berechtigungen.
Eine Änderung des gespeicherten Zahlungsstatus belastet keine Karte und löst beim Zahlungsanbieter keine Erstattung aus.

Sicheres Schreiben

Berechtigungen und Tarife

Bestellung · Summen

Beträge und Steuersätze stammen aus der gespeicherten Bestellung einschließlich Positionskorrekturen. Fehlende historische Angaben sind null; aktuelle Katalogsteuersätze ersetzen sie nicht. Geldbeträge bleiben Dezimalzeichenfolgen.

Die Liste liefert Zusammenfassungen. Rufen Sie für jedes Ergebnis GET /api/v1/orders/{order_id} ab, um vollständige Abrechnungsdaten zu exportieren. GET-Wiederholungen sind begrenzt und beachten Retry-After. Der Export nach Erstellungsdatum synchronisiert keine späteren Korrekturen.

tax_country_code · Steuerland · Gespeicherte Bestelldaten · ISO 3166-1 alpha-2; null.
lines[].unit_* · Eine Einheit · Vor Rabatten; lines[].original_total_* · Vor Rabatten; lines[].total_* · Nach Rabatten.
lines[].discount_* · Rabatte; manual_discount · Manueller Rabatt; percentage "10" = 10%.
delivery.net / tax / gross · Nach Rabatten; delivery.original_* · Vor Rabatten; delivery.discount_* · Rabatte.
tax_rate: "0.23" = 23%; "0" ≠ null. Unbekannt: null; bekannte Null: 0.
totals · Summen; tax_breakdown.groups · Steuergruppen; Nicht zugeordnete Steuer = order.tax − Σ groups.tax; ±.

payment.amount ist die Bestellsumme. Der Zahlungsstatus bestimmt keine bezahlten, erstatteten oder offenen Beträge.

Parameter

Pfadparameter

order_idZeichenfolgeErforderlich

Kennung der zugehörigen Bestellung.

Einschränkungen

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Beispiel: "example"

Diese Operation akzeptiert keinen JSON-Inhalt.

Antworten

Antwort 200

Vollständiges Modell: ApiResponse_OrderDetailData_

dataOrderDetailData Erforderlich

Nutzdaten einer erfolgreichen Antwort.

Felder · data

Vollständiges Modell: OrderDetailData

created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"

customerCustomerData Erforderlich

Für diese Ressource gespeicherte Kundendaten.

Felder · customer

Vollständiges Modell: CustomerData

emailZeichenfolgeErforderlich: E-Mail-Adresse.
first_nameZeichenfolge nullErforderlich: Vorname.
last_nameZeichenfolge nullErforderlich: Nachname.
phoneZeichenfolge nullErforderlich: Telefonnummer.

deliveryShippingDetailData Erforderlich

Versandart und zugehörige Informationen.

Felder · delivery

Vollständiges Modell: ShippingDetailData

amountMoneyData Erforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

datesDeliveryDatesData Erforderlich

Versand- und Lieferdaten

discount_grossMoneyData Erforderlich

Bruttobetrag · Rabatte; Unbekannt: null; bekannte Null: 0.

discount_netMoneyData nullErforderlich

Nettobetrag · Rabatte; Unbekannt: null; bekannte Null: 0.

discount_taxMoneyData nullErforderlich

Steuerbetrag · Rabatte; Unbekannt: null; bekannte Null: 0.

discountsArray <OrderDeliveryDiscountData > nullErforderlich

Rabatte

grossMoneyData Erforderlich

Bruttobetrag · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

method_codeZeichenfolge nullErforderlich

Code der Versand- oder Zahlungsart.

method_nameZeichenfolge nullErforderlich

Name der Versand- oder Zahlungsart.

netMoneyData nullErforderlich

Nettobetrag · Nach Rabatten; Unbekannt: null; bekannte Null: 0.

original_grossMoneyData Erforderlich

Bruttobetrag · Versand · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

original_netMoneyData nullErforderlich

Nettobetrag · Versand · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

original_taxMoneyData nullErforderlich

Steuerbetrag · Versand · Vor Rabatten; Unbekannt: null; bekannte Null: 0.

pickup_pointDeliveryPickupPointData nullErforderlich

Abholpunkt

recipient_modeZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["full_address", "pickup_contact"]

taxMoneyData nullErforderlich

Steuerinformationen.

tax_category_idZeichenfolge nullErforderlich

Kennung der Steuerkategorie.

tax_category_nameZeichenfolge nullErforderlich

Gespeicherter Name der Steuerkategorie; null.

tax_rateZeichenfolge nullErforderlich

tax_rate · Gespeicherte Bestelldaten: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Erforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

Felder · discount_amount

Vollständiges Modell: MoneyData

amountZeichenfolgeErforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

currencyZeichenfolgeErforderlich

Währungscode des Betrags.

Einschränkungen

pattern: "^[A-Z]{3}$"

minor_unitsGanzzahlErforderlich

Anzahl der Nachkommastellen der Währung.

minimum: 0maximum: 4

discountsArray <OrderDiscountData > Erforderlich

Rabatte

Felder · discounts

OrderDiscountData

Vollständiges Modell: OrderDiscountData

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

invoiceInvoiceData nullErforderlich

Rechnungsangaben.

Felder · invoice

InvoiceData

Vollständiges Modell: InvoiceData

null

invoice_requestedBoolescher WertErforderlich

Gibt an, ob eine Rechnung angefordert wurde.

lifecycle_stateOrderLifecycleState Erforderlich

Geschäftlicher Lebenszyklusstatus.

linesArray <OrderLineData > Erforderlich

Gespeicherte Bestellpositionen.

Felder · lines

OrderLineData

Vollständiges Modell: OrderLineData

localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

numberZeichenfolgeErforderlich

Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

paymentPaymentData Erforderlich

Für die Bestellung gespeicherte Zahlungsdetails.

Felder · payment

Vollständiges Modell: PaymentData

amountMoneyData Erforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

environmentZeichenfolgeErforderlich

Dem Datensatz zugeordnete Umgebungsinformationen.

Einschränkungen

enum: ["live", "sandbox"]

method_codeZeichenfolge nullErforderlich

Code der Versand- oder Zahlungsart.

method_nameZeichenfolge nullErforderlich

Name der Versand- oder Zahlungsart.

paid_atZeichenfolge nullErforderlich

Zeitpunkt der Kennzeichnung als bezahlt.

Zeichenfolge:format: "date-time"

statusOrderPaymentStatus Erforderlich

Von dieser konkreten Operation akzeptierter Status.

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

pickup_pointPickupPointData nullErforderlich

Abholpunkt

Felder · pickup_point

PickupPointData

Vollständiges Modell: PickupPointData

null

prices_include_taxBoolescher WertErforderlich

Gibt an, ob Listenpreise Steuern enthalten.

shipping_addressAddressData nullErforderlich

Lieferadresse.

Felder · shipping_address

AddressData

Vollständiges Modell: AddressData

null

shipping_discount_amountMoneyData Erforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

Felder · shipping_discount_amount

Vollständiges Modell: MoneyData

amountZeichenfolgeErforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

currencyZeichenfolgeErforderlich

Währungscode des Betrags.

Einschränkungen

pattern: "^[A-Z]{3}$"

minor_unitsGanzzahlErforderlich

Anzahl der Nachkommastellen der Währung.

minimum: 0maximum: 4

statusOrderStatusData Erforderlich

Von dieser konkreten Operation akzeptierter Status.

Felder · status

Vollständiges Modell: OrderStatusData

idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen.
nameZeichenfolgeErforderlich: Name der Ressource im jeweiligen Kontext.
updated_atZeichenfolgeErforderlich: Zeitpunkt der letzten Änderung.
format: "date-time"
versionGanzzahlErforderlich: Ressourcenversion zur Nebenläufigkeitskontrolle.

subtotalMoneyData Erforderlich

Betrag vor den zusätzlich in der Antwort angegebenen Komponenten.

Felder · subtotal

Vollständiges Modell: MoneyData

amountZeichenfolgeErforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

currencyZeichenfolgeErforderlich

Währungscode des Betrags.

Einschränkungen

pattern: "^[A-Z]{3}$"

minor_unitsGanzzahlErforderlich

Anzahl der Nachkommastellen der Währung.

minimum: 0maximum: 4

taxMoneyData Erforderlich

Steuerinformationen.

Felder · tax

Vollständiges Modell: MoneyData

amountZeichenfolgeErforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

currencyZeichenfolgeErforderlich

Währungscode des Betrags.

Einschränkungen

pattern: "^[A-Z]{3}$"

minor_unitsGanzzahlErforderlich

Anzahl der Nachkommastellen der Währung.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Erforderlich

Steuergruppen · source + tax_rate; unallocated_tax.

Felder · tax_breakdown

Vollständiges Modell: OrderTaxBreakdownData

groupsArray <OrderTaxGroupData > Erforderlich: Steuergruppen · source + tax_rate; Unbekannt: null; bekannte Null: 0.
unallocated_taxMoneyData Erforderlich: Nicht zugeordnete Steuer = order.tax − Σ groups.tax; ±.

tax_country_codeZeichenfolge nullErforderlich

Steuerland · Gespeicherte Bestelldaten · ISO 3166-1 alpha-2; null.

totalMoneyData Erforderlich

Gesamtbetrag.

Felder · total

Vollständiges Modell: MoneyData

amountZeichenfolgeErforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

currencyZeichenfolgeErforderlich

Währungscode des Betrags.

Einschränkungen

pattern: "^[A-Z]{3}$"

minor_unitsGanzzahlErforderlich

Anzahl der Nachkommastellen der Währung.

minimum: 0maximum: 4

totalsOrderTotalsData Erforderlich

Summen · net / tax / gross; Vor Rabatten / Nach Rabatten.

Felder · totals

Vollständiges Modell: OrderTotalsData

before_discountsOrderAmountBreakdownData Erforderlich: Bestellung · Vor Rabatten · net / tax / gross.
discountsOrderAmountBreakdownData Erforderlich: Rabatte
orderOrderAmountBreakdownData Erforderlich: Bestellung · Nach Rabatten · net / tax / gross.
product_discountsOrderAmountBreakdownData Erforderlich: Produkte · Rabatte · net / tax / gross.
productsOrderAmountBreakdownData Erforderlich: Produkte · Nach Rabatten · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Erforderlich: Produkte · Vor Rabatten · net / tax / gross.
shippingOrderAmountBreakdownData Erforderlich: Versand · Nach Rabatten · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Erforderlich: Versand · Vor Rabatten · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Erforderlich: Versand · Rabatte · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Erforderlich

Metadaten der Antwort.

Felder · meta

ContextPageMeta

Vollständiges Modell: ContextPageMeta

localeZeichenfolgeErforderlich: Für diese Anfrage ausgewählte Sprache.
market_codeZeichenfolgeErforderlich: Vom Kontext-Endpunkt zurückgegebener Marktcode.
market_idZeichenfolgeErforderlich: Vom Kontext-Endpunkt zurückgegebene Marktkennung.
paginationPagination Erforderlich: Metadaten der Cursor-Paginierung.
request_idZeichenfolgeErforderlich: Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.
minLength: 1maxLength: 100

ContextMeta

Vollständiges Modell: ContextMeta

localeZeichenfolgeErforderlich: Für diese Anfrage ausgewählte Sprache.
market_codeZeichenfolgeErforderlich: Vom Kontext-Endpunkt zurückgegebener Marktcode.
market_idZeichenfolgeErforderlich: Vom Kontext-Endpunkt zurückgegebene Marktkennung.
request_idZeichenfolgeErforderlich: Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.
minLength: 1maxLength: 100

PageMeta

Vollständiges Modell: PageMeta

paginationPagination Erforderlich: Metadaten der Cursor-Paginierung.
request_idZeichenfolgeErforderlich: Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.
minLength: 1maxLength: 100

RequestMeta

Vollständiges Modell: RequestMeta

request_idZeichenfolgeErforderlich: Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.
minLength: 1maxLength: 100

Beispielantwort

HTTP-Status

200: Erfolgreiche Antwort Schema
400: Ungültige Anfrage
401: Authentifizierung erforderlich
403: Berechtigung verweigert
404: Ressource nicht gefunden
409: Versionskonflikt
422: Validierung fehlgeschlagen
429: Anfragelimit überschritten

Weitere HTTP-Statuscodes (7)

405: Methode nicht erlaubt
413: Anfrage zu groß
415: Nicht unterstützter Medientyp
500: Serverfehler
502: API-Gateway-Fehler
503: Dienst nicht verfügbar
504: Gateway-Zeitüberschreitung

Fehlerkatalog: ErrorResponse

Header

401

WWW-AuthenticateZeichenfolgeOptional: Vom Server verlangtes Authentifizierungsschema.

405

AllowZeichenfolgeOptional: Von dieser Ressource unterstützte HTTP-Methoden.

429, 503

Retry-AfterGanzzahlOptional: Mindestwartezeit vor einem erneuten Versuch in Sekunden.

minimum: 0

Fehlerkatalog · Mehr erfahren

GET/api/v1/orders/{order_id}

Codebeispiele

Beispielanfrage

cURL

PHP

Python

Beispielantwort 200

Funktionsweise

Bestellung · Summen

Parameter

Pfadparameter

Antworten

Antwort 200

HTTP-Status

GET`/api/v1/orders/{order_id}`