Přejít na obsah
ShopentlyLearn
Čeština

Načíst — Objednávky

Načtěte data z „Objednávky“. Výsledek závisí na parametrech této operace.

GET/api/v1/orders/{order_id}

Ověřování
Bearer
Dostupné od tarifu
BASIC
Požadovaná oprávnění
orders.order:read

Příklady kódu

Příklad požadavku

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říklad odpovědi 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"
  }
}

Jak to funguje

  • Seznam nabízí přehledy objednávek a filtry podle čísla, stavu, stavu platby a času vytvoření.
  • Seznam i detail objednávky obsahují delivery.dates. Plánovaná data YYYY-MM-DD nepotvrzují odeslání. Aktuální data mají přednost; starší objednávky používají uložený odhad. Vymazané nebo neznámé hodnoty jsou null. Detail obsahuje také všechny položky a obrázky produktů.
  • Platné identifikátory stavů načtěte z /api/v1/order-statuses.
  • Stav objednávky a stav platby používají oddělené koncové body PATCH a oprávnění.
  • Změna evidovaného stavu platby nestrhne peníze z karty ani neprovede refundaci u poskytovatele plateb.

Bezpečné zápisy

Oprávnění a tarify

Objednávka · Součty

Částky a sazby pocházejí z uložené objednávky včetně oprav položek. Chybějící historické údaje jsou null a nenahrazují se aktuálními sazbami katalogu. Částky zůstávají desetinnými řetězci.

Seznam vrací souhrny. Pro každý výsledek načtěte GET /api/v1/orders/{order_id} a exportujte úplné finanční údaje. Opakování GET jsou omezená a respektují Retry-After. Export podle data vytvoření nesynchronizuje pozdější opravy.

  • tax_country_code · Daňová země · Uložený snímek objednávky · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Jedna jednotka · Před slevami; lines[].original_total_* · Před slevami; lines[].total_* · Po slevách.
  • lines[].discount_* · Slevy; manual_discount · Ruční sleva; percentage "10" = 10%.
  • delivery.net / tax / gross · Po slevách; delivery.original_* · Před slevami; delivery.discount_* · Slevy.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Neznámé: null; známá nula: 0.
  • totals · Součty; tax_breakdown.groups · Daňové skupiny; Nepřiřazená daň = order.tax − Σ groups.tax; ±.

payment.amount je celková částka objednávky. Stav platby neurčuje zaplacené, vrácené ani dlužné částky.

Parametry

Parametry cesty

order_idŘetězecPovinné

Identifikátor související objednávky.

Omezení
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "example"

Tato operace nepřijímá tělo JSON.

Odpovědi

Odpověď 200

Úplný model: ApiResponse_OrderDetailData_

dataOrderDetailData Povinné

Obsah úspěšné odpovědi.

Pole · data

Úplný model: OrderDetailData

created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"
customerCustomerData Povinné

Údaje zákazníka zaznamenané u tohoto zdroje.

Pole · customer

Úplný model: CustomerData

emailŘetězecPovinné

E-mailová adresa.

first_nameŘetězec nullPovinné

Jméno.

last_nameŘetězec nullPovinné

Příjmení.

phoneŘetězec nullPovinné

Telefonní číslo.

deliveryShippingDetailData Povinné

Způsob doručení a související údaje.

Pole · delivery

Úplný model: ShippingDetailData

amountMoneyData Povinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

datesDeliveryDatesData Povinné

Data odeslání a doručení

discount_grossMoneyData Povinné

Částka s daní · Slevy; Neznámé: null; známá nula: 0.

discount_netMoneyData nullPovinné

Částka bez daně · Slevy; Neznámé: null; známá nula: 0.

discount_taxMoneyData nullPovinné

Částka daně · Slevy; Neznámé: null; známá nula: 0.

discountsPole <OrderDeliveryDiscountData > nullPovinné

Slevy

grossMoneyData Povinné

Částka s daní · Po slevách; Neznámé: null; známá nula: 0.

method_codeŘetězec nullPovinné

Kód způsobu doručení nebo platby.

method_nameŘetězec nullPovinné

Název způsobu doručení nebo platby.

netMoneyData nullPovinné

Částka bez daně · Po slevách; Neznámé: null; známá nula: 0.

original_grossMoneyData Povinné

Částka s daní · Doprava · Před slevami; Neznámé: null; známá nula: 0.

original_netMoneyData nullPovinné

Částka bez daně · Doprava · Před slevami; Neznámé: null; známá nula: 0.

original_taxMoneyData nullPovinné

Částka daně · Doprava · Před slevami; Neznámé: null; známá nula: 0.

pickup_pointDeliveryPickupPointData nullPovinné

Výdejní místo

recipient_modeŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["full_address", "pickup_contact"]
taxMoneyData nullPovinné

Daňové údaje.

tax_category_idŘetězec nullPovinné

Identifikátor daňové kategorie.

tax_category_nameŘetězec nullPovinné

Uložený název daňové kategorie; null.

tax_rateŘetězec nullPovinné

tax_rate · Uložený snímek objednávky: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Povinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

Pole · discount_amount

Úplný model: MoneyData

amountŘetězecPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

currencyŘetězecPovinné

Kód měny částky.

Omezení
pattern
"^[A-Z]{3}$"
minor_unitsCelé čísloPovinné

Počet desetinných míst používaných měnou.

minimum: 0maximum: 4
discountsPole <OrderDiscountData > Povinné

Slevy

Pole · discounts

OrderDiscountData

Úplný model: OrderDiscountData

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

invoiceInvoiceData nullPovinné

Fakturační údaje.

Pole · invoice

InvoiceData

Úplný model: InvoiceData

null

invoice_requestedLogická hodnotaPovinné

Zda byla požadována faktura.

lifecycle_stateOrderLifecycleState Povinné

Stav obchodního životního cyklu.

linesPole <OrderLineData > Povinné

Uložené údaje položek objednávky.

Pole · lines

OrderLineData

Úplný model: OrderLineData

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

paymentPaymentData Povinné

Platební údaje zaznamenané u objednávky.

Pole · payment

Úplný model: PaymentData

amountMoneyData Povinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

environmentŘetězecPovinné

Informace o prostředí připojené k záznamu.

Omezení
enum
["live", "sandbox"]
method_codeŘetězec nullPovinné

Kód způsobu doručení nebo platby.

method_nameŘetězec nullPovinné

Název způsobu doručení nebo platby.

paid_atŘetězec nullPovinné

Datum a čas označení platby jako zaplacené.

Řetězec:format: "date-time"
statusOrderPaymentStatus Povinné

Stav přijímaný touto konkrétní operací.

updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

pickup_pointPickupPointData nullPovinné

Výdejní místo

Pole · pickup_point

PickupPointData

Úplný model: PickupPointData

null

prices_include_taxLogická hodnotaPovinné

Zda uvedené ceny zahrnují daň.

shipping_addressAddressData nullPovinné

Doručovací adresa.

Pole · shipping_address

AddressData

Úplný model: AddressData

null

shipping_discount_amountMoneyData Povinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

Pole · shipping_discount_amount

Úplný model: MoneyData

amountŘetězecPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

currencyŘetězecPovinné

Kód měny částky.

Omezení
pattern
"^[A-Z]{3}$"
minor_unitsCelé čísloPovinné

Počet desetinných míst používaných měnou.

minimum: 0maximum: 4
statusOrderStatusData Povinné

Stav přijímaný touto konkrétní operací.

Pole · status

Úplný model: OrderStatusData

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

subtotalMoneyData Povinné

Částka před dalšími složkami uvedenými v odpovědi.

Pole · subtotal

Úplný model: MoneyData

amountŘetězecPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

currencyŘetězecPovinné

Kód měny částky.

Omezení
pattern
"^[A-Z]{3}$"
minor_unitsCelé čísloPovinné

Počet desetinných míst používaných měnou.

minimum: 0maximum: 4
taxMoneyData Povinné

Daňové údaje.

Pole · tax

Úplný model: MoneyData

amountŘetězecPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

currencyŘetězecPovinné

Kód měny částky.

Omezení
pattern
"^[A-Z]{3}$"
minor_unitsCelé čísloPovinné

Počet desetinných míst používaných měnou.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Povinné

Daňové skupiny · source + tax_rate; unallocated_tax.

Pole · tax_breakdown

Úplný model: OrderTaxBreakdownData

groupsPole <OrderTaxGroupData > Povinné

Daňové skupiny · source + tax_rate; Neznámé: null; známá nula: 0.

unallocated_taxMoneyData Povinné

Nepřiřazená daň = order.tax − Σ groups.tax; ±.

tax_country_codeŘetězec nullPovinné

Daňová země · Uložený snímek objednávky · ISO 3166-1 alpha-2; null.

totalMoneyData Povinné

Celková částka.

Pole · total

Úplný model: MoneyData

amountŘetězecPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

currencyŘetězecPovinné

Kód měny částky.

Omezení
pattern
"^[A-Z]{3}$"
minor_unitsCelé čísloPovinné

Počet desetinných míst používaných měnou.

minimum: 0maximum: 4
totalsOrderTotalsData Povinné

Součty · net / tax / gross; Před slevami / Po slevách.

Pole · totals

Úplný model: OrderTotalsData

before_discountsOrderAmountBreakdownData Povinné

Objednávka · Před slevami · net / tax / gross.

discountsOrderAmountBreakdownData Povinné

Slevy

orderOrderAmountBreakdownData Povinné

Objednávka · Po slevách · net / tax / gross.

product_discountsOrderAmountBreakdownData Povinné

Produkty · Slevy · net / tax / gross.

productsOrderAmountBreakdownData Povinné

Produkty · Po slevách · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Povinné

Produkty · Před slevami · net / tax / gross.

shippingOrderAmountBreakdownData Povinné

Doprava · Po slevách · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Povinné

Doprava · Před slevami · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Povinné

Doprava · Slevy · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metadata odpovědi.

Pole · meta

ContextPageMeta

Úplný model: ContextPageMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

ContextMeta

Úplný model: ContextMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

PageMeta

Úplný model: PageMeta

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

RequestMeta

Úplný model: RequestMeta

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100
Příklad odpovědi

Stav HTTP

200
Úspěšná odpověď Schéma
400
Neplatný požadavek
401
Vyžadováno ověření
403
Přístup odepřen
404
Zdroj nenalezen
409
Konflikt verzí
422
Chyba validace
429
Překročen limit požadavků
Další stavy HTTP (7)
405
Metoda není povolena
413
Příliš velký požadavek
415
Nepodporovaný formát
500
Chyba serveru
502
Chyba brány API
503
Služba nedostupná
504
Vypršel časový limit

Katalog chyb: ErrorResponse

Hlavičky

401

WWW-AuthenticateŘetězecVolitelné

Způsob ověření požadovaný serverem.

405

AllowŘetězecVolitelné

Metody HTTP podporované tímto zdrojem.

429, 503

Retry-AfterCelé čísloVolitelné

Minimální prodleva před opakováním v sekundách.

minimum: 0

Katalog chyb · Další informace