Lekéré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/{order_id}`

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

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

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"
      },
      "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"
  }
}

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.

Biztonságos írások

Jogosultságok és csomagok

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.

tax_country_code · Adózási ország · Mentett rendelési adatok · ISO 3166-1 alpha-2; null.
lines[].unit_* · Egy egység · Kedvezmények előtt; lines[].original_total_* · Kedvezmények előtt; lines[].total_* · Kedvezmények után.
lines[].discount_* · Kedvezmények; manual_discount · Kézi kedvezmény; percentage "10" = 10%.
delivery.net / tax / gross · Kedvezmények után; delivery.original_* · Kedvezmények előtt; delivery.discount_* · Kedvezmények.
tax_rate: "0.23" = 23%; "0" ≠ null. Ismeretlen: null; ismert nulla: 0.
totals · Összesítések; tax_breakdown.groups · Adócsoportok; Fel nem osztott adó = order.tax − Σ groups.tax; ±.

A payment.amount a rendelés végösszege. A fizetési állapot nem határozza meg a fizetett, visszatérített vagy fennmaradó összegeket.

Paraméterek

Útvonalparaméterek

order_idKarakterláncKötelező

A kapcsolódó rendelés azonosítója.

Korlátozások

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

Példa: "example"

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

Válaszok

Válasz 200

Teljes modell: ApiResponse_OrderDetailData_

dataOrderDetailData Kötelező

A sikeres válasz adatai.

Mezők · data

Teljes modell: OrderDetailData

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.

Mezők · customer

Teljes modell: CustomerData

emailKarakterláncKötelező: E-mail-cím.
first_nameKarakterlánc nullKötelező: Utónév.
last_nameKarakterlánc nullKötelező: Családi név.
phoneKarakterlánc nullKötelező: Telefonszám.

deliveryShippingDetailData Kötelező

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

Mezők · delivery

Teljes modell: ShippingDetailData

amountMoneyData Kötelező

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

datesDeliveryDatesData Kötelező

Feladási és kézbesítési dátumok

discount_grossMoneyData Kötelező

Bruttó összeg · Kedvezmények; Ismeretlen: null; ismert nulla: 0.

discount_netMoneyData nullKötelező

Nettó összeg · Kedvezmények; Ismeretlen: null; ismert nulla: 0.

discount_taxMoneyData nullKötelező

Adó összege · Kedvezmények; Ismeretlen: null; ismert nulla: 0.

discountsTömb <OrderDeliveryDiscountData > nullKötelező

Kedvezmények

grossMoneyData Kötelező

Bruttó összeg · Kedvezmények után; Ismeretlen: null; ismert nulla: 0.

method_codeKarakterlánc nullKötelező

A szállítási vagy fizetési mód kódja.

method_nameKarakterlánc nullKötelező

A szállítási vagy fizetési mód neve.

netMoneyData nullKötelező

Nettó összeg · Kedvezmények után; Ismeretlen: null; ismert nulla: 0.

original_grossMoneyData Kötelező

Bruttó összeg · Szállítás · Kedvezmények előtt; Ismeretlen: null; ismert nulla: 0.

original_netMoneyData nullKötelező

Nettó összeg · Szállítás · Kedvezmények előtt; Ismeretlen: null; ismert nulla: 0.

original_taxMoneyData nullKötelező

Adó összege · Szállítás · Kedvezmények előtt; Ismeretlen: null; ismert nulla: 0.

pickup_pointDeliveryPickupPointData nullKötelező

Átvételi pont

recipient_modeKarakterláncKötelező

Az adatstruktúra változata, a megengedett értékek szerint.

Korlátozások

enum: ["full_address", "pickup_contact"]

taxMoneyData nullKötelező

Adóadatok.

tax_category_idKarakterlánc nullKötelező

Adókategória-azonosító.

tax_category_nameKarakterlánc nullKötelező

Adókategória mentett neve; null.

tax_rateKarakterlánc nullKötelező

tax_rate · Mentett rendelési adatok: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Kötelező

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

Mezők · discount_amount

Teljes modell: MoneyData

amountKarakterláncKötelező

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

currencyKarakterláncKötelező

Az összeg pénznemkódja.

Korlátozások

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

minor_unitsEgész számKötelező

A pénznem által használt tizedesjegyek száma.

minimum: 0maximum: 4

discountsTömb <OrderDiscountData > Kötelező

Kedvezmények

Mezők · discounts

OrderDiscountData

Teljes modell: OrderDiscountData

idKarakterláncKötelező

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

invoiceInvoiceData nullKötelező

Számlaadatok.

Mezők · invoice

InvoiceData

Teljes modell: InvoiceData

null

invoice_requestedLogikai értékKötelező

Jelzi, hogy kértek-e számlát.

lifecycle_stateOrderLifecycleState Kötelező

Az üzleti életciklus állapota.

linesTömb <OrderLineData > Kötelező

A rendelési tételek pillanatfelvételei.

Mezők · lines

OrderLineData

Teljes modell: OrderLineData

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.

Mezők · payment

Teljes modell: PaymentData

amountMoneyData Kötelező

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

environmentKarakterláncKötelező

A rekordhoz csatolt környezeti adatok.

Korlátozások

enum: ["live", "sandbox"]

method_codeKarakterlánc nullKötelező

A szállítási vagy fizetési mód kódja.

method_nameKarakterlánc nullKötelező

A szállítási vagy fizetési mód neve.

paid_atKarakterlánc nullKötelező

A fizetett állapot rögzítésének dátuma és időpontja.

Karakterlánc:format: "date-time"

statusOrderPaymentStatus Kötelező

Az adott művelet által elfogadott állapot.

updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"

versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

pickup_pointPickupPointData nullKötelező

Átvételi pont

Mezők · pickup_point

PickupPointData

Teljes modell: PickupPointData

null

prices_include_taxLogikai értékKötelező

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

shipping_addressAddressData nullKötelező

Szállítási cím.

Mezők · shipping_address

AddressData

Teljes modell: AddressData

null

shipping_discount_amountMoneyData Kötelező

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

Mezők · shipping_discount_amount

Teljes modell: MoneyData

amountKarakterláncKötelező

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

currencyKarakterláncKötelező

Az összeg pénznemkódja.

Korlátozások

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

minor_unitsEgész számKötelező

A pénznem által használt tizedesjegyek száma.

minimum: 0maximum: 4

statusOrderStatusData Kötelező

Az adott művelet által elfogadott állapot.

Mezők · status

Teljes modell: OrderStatusData

idKarakterláncKötelező: Erőforrás-azonosító; a visszaadott alakban őrizze meg.
nameKarakterláncKötelező: Az erőforrás neve az adott környezetben.
updated_atKarakterláncKötelező: A legutóbbi módosítás időpontja.
format: "date-time"
versionEgész számKötelező: Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

subtotalMoneyData Kötelező

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

Mezők · subtotal

Teljes modell: MoneyData

amountKarakterláncKötelező

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

currencyKarakterláncKötelező

Az összeg pénznemkódja.

Korlátozások

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

minor_unitsEgész számKötelező

A pénznem által használt tizedesjegyek száma.

minimum: 0maximum: 4

taxMoneyData Kötelező

Adóadatok.

Mezők · tax

Teljes modell: MoneyData

amountKarakterláncKötelező

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

currencyKarakterláncKötelező

Az összeg pénznemkódja.

Korlátozások

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

minor_unitsEgész számKötelező

A pénznem által használt tizedesjegyek száma.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Kötelező

Adócsoportok · source + tax_rate; unallocated_tax.

Mezők · tax_breakdown

Teljes modell: OrderTaxBreakdownData

groupsTömb <OrderTaxGroupData > Kötelező: Adócsoportok · source + tax_rate; Ismeretlen: null; ismert nulla: 0.
unallocated_taxMoneyData Kötelező: Fel nem osztott adó = order.tax − Σ groups.tax; ±.

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.

Mezők · total

Teljes modell: MoneyData

amountKarakterláncKötelező

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

currencyKarakterláncKötelező

Az összeg pénznemkódja.

Korlátozások

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

minor_unitsEgész számKötelező

A pénznem által használt tizedesjegyek száma.

minimum: 0maximum: 4

totalsOrderTotalsData Kötelező

Összesítések · net / tax / gross; Kedvezmények előtt / Kedvezmények után.

Mezők · totals

Teljes modell: OrderTotalsData

before_discountsOrderAmountBreakdownData Kötelező: Rendelés · Kedvezmények előtt · net / tax / gross.
discountsOrderAmountBreakdownData Kötelező: Kedvezmények
orderOrderAmountBreakdownData Kötelező: Rendelés · Kedvezmények után · net / tax / gross.
product_discountsOrderAmountBreakdownData Kötelező: Termékek · Kedvezmények · net / tax / gross.
productsOrderAmountBreakdownData Kötelező: Termékek · Kedvezmények után · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Kötelező: Termékek · Kedvezmények előtt · net / tax / gross.
shippingOrderAmountBreakdownData Kötelező: Szállítás · Kedvezmények után · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Kötelező: Szállítás · Kedvezmények előtt · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Kötelező: Szállítás · Kedvezmények · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Kötelező

A válasz metaadatai.

Mezők · meta

ContextPageMeta

Teljes modell: 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

Teljes modell: 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

Teljes modell: 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

Teljes modell: 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

Hibakatalógus · További információ

GET/api/v1/orders/{order_id}

Kódpéldák

Példakérés

cURL

PHP

Python

Példaválasz 200

Működés

Rendelés · Összesítések

Paraméterek

Útvonalparaméterek

Válaszok

Válasz 200

HTTP-állapot

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