Preskočiť na obsah
ShopentlyLearn
Slovenčina

Načítať — Objednávky

Načítajte údaje z „Objednávky“. Výsledok závisí od parametrov tejto operácie.

GET/api/v1/orders/{order_id}

Overovanie
Bearer
Dostupné od plánu
BASIC
Požadované oprávnenia
orders.order:read

Príklady kódu

Príklad požiadavky

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

Príklad odpovede 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"
  }
}

Ako to funguje

  • Zoznam ponúka prehľady objednávok a filtre podľa čísla, stavu, stavu platby a času vytvorenia.
  • Zoznam aj detail objednávky obsahujú delivery.dates. Plánované dátumy YYYY-MM-DD nepotvrdzujú odoslanie. Aktuálne dátumy majú prednosť; staršie objednávky používajú uložený odhad. Vymazané alebo neznáme hodnoty sú null. Detail obsahuje aj všetky položky a obrázky produktov.
  • Platné identifikátory stavov načítajte z /api/v1/order-statuses.
  • Stav objednávky a stav platby používajú oddelené koncové body PATCH a oprávnenia.
  • Zmena evidovaného stavu platby nestiahne peniaze z karty ani nevykoná refundáciu u poskytovateľa platieb.

Bezpečné zápisy

Oprávnenia a plány

Objednávka · Súčty

Sumy a sadzby pochádzajú z uloženej objednávky vrátane opráv položiek. Chýbajúce historické údaje sú null a nenahrádzajú sa aktuálnymi sadzbami katalógu. Sumy zostávajú desatinnými reťazcami.

Zoznam vracia súhrny. Pre každý výsledok načítajte GET /api/v1/orders/{order_id} a exportujte úplné finančné údaje. Opakovania GET sú obmedzené a rešpektujú Retry-After. Export podľa dátumu vytvorenia nesynchronizuje neskoršie opravy.

  • tax_country_code · Daňová krajina · Uložená snímka objednávky · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Jedna jednotka · Pred zľavami; lines[].original_total_* · Pred zľavami; lines[].total_* · Po zľavách.
  • lines[].discount_* · Zľavy; manual_discount · Ručná zľava; percentage "10" = 10%.
  • delivery.net / tax / gross · Po zľavách; delivery.original_* · Pred zľavami; delivery.discount_* · Zľavy.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Neznáme: null; známa nula: 0.
  • totals · Súčty; tax_breakdown.groups · Daňové skupiny; Nepriradená daň = order.tax − Σ groups.tax; ±.

payment.amount je celková suma objednávky. Stav platby neurčuje zaplatené, vrátené ani dlžné sumy.

Parametre

Parametre cesty

order_idReťazecPovinné

Identifikátor súvisiacej objednávky.

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

Táto operácia neprijíma telo JSON.

Odpovede

Odpoveď 200

Úplný model: ApiResponse_OrderDetailData_

dataOrderDetailData Povinné

Obsah úspešnej odpovede.

Polia · data

Úplný model: OrderDetailData

created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
customerCustomerData Povinné

Údaje zákazníka zaznamenané pri tomto zdroji.

Polia · customer

Úplný model: CustomerData

emailReťazecPovinné

E-mailová adresa.

first_nameReťazec nullPovinné

Meno.

last_nameReťazec nullPovinné

Priezvisko.

phoneReťazec nullPovinné

Telefónne číslo.

deliveryShippingDetailData Povinné

Spôsob doručenia a súvisiace údaje.

Polia · delivery

Úplný model: ShippingDetailData

amountMoneyData Povinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

datesDeliveryDatesData Povinné

Dátumy odoslania a doručenia

discount_grossMoneyData Povinné

Suma s daňou · Zľavy; Neznáme: null; známa nula: 0.

discount_netMoneyData nullPovinné

Suma bez dane · Zľavy; Neznáme: null; známa nula: 0.

discount_taxMoneyData nullPovinné

Suma dane · Zľavy; Neznáme: null; známa nula: 0.

discountsPole <OrderDeliveryDiscountData > nullPovinné

Zľavy

grossMoneyData Povinné

Suma s daňou · Po zľavách; Neznáme: null; známa nula: 0.

method_codeReťazec nullPovinné

Kód spôsobu doručenia alebo platby.

method_nameReťazec nullPovinné

Názov spôsobu doručenia alebo platby.

netMoneyData nullPovinné

Suma bez dane · Po zľavách; Neznáme: null; známa nula: 0.

original_grossMoneyData Povinné

Suma s daňou · Doprava · Pred zľavami; Neznáme: null; známa nula: 0.

original_netMoneyData nullPovinné

Suma bez dane · Doprava · Pred zľavami; Neznáme: null; známa nula: 0.

original_taxMoneyData nullPovinné

Suma dane · Doprava · Pred zľavami; Neznáme: null; známa nula: 0.

pickup_pointDeliveryPickupPointData nullPovinné

Výdajné miesto

recipient_modeReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["full_address", "pickup_contact"]
taxMoneyData nullPovinné

Daňové údaje.

tax_category_idReťazec nullPovinné

Identifikátor daňovej kategórie.

tax_category_nameReťazec nullPovinné

Uložený názov daňovej kategórie; null.

tax_rateReťazec nullPovinné

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

discount_amountMoneyData Povinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Polia · discount_amount

Úplný model: MoneyData

amountReťazecPovinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

currencyReťazecPovinné

Kód meny sumy.

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

Počet desatinných miest používaných menou.

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

Zľavy

Polia · discounts

OrderDiscountData

Úplný model: OrderDiscountData

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.

invoiceInvoiceData nullPovinné

Fakturačné údaje.

Polia · invoice

InvoiceData

Úplný model: InvoiceData

null

invoice_requestedLogická hodnotaPovinné

Či bola požadovaná faktúra.

lifecycle_stateOrderLifecycleState Povinné

Stav obchodného životného cyklu.

linesPole <OrderLineData > Povinné

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

Polia · lines

OrderLineData

Úplný model: OrderLineData

localeReťazecPovinné

Jazyk vybraný pre túto požiadavku.

market_idReťazecPovinné

Identifikátor trhu vrátený koncovým bodom kontextu.

numberReťazecPovinné

Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

paymentPaymentData Povinné

Platobné údaje zaznamenané pri objednávke.

Polia · payment

Úplný model: PaymentData

amountMoneyData Povinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

environmentReťazecPovinné

Informácie o prostredí pripojené k záznamu.

Obmedzenia
enum
["live", "sandbox"]
method_codeReťazec nullPovinné

Kód spôsobu doručenia alebo platby.

method_nameReťazec nullPovinné

Názov spôsobu doručenia alebo platby.

paid_atReťazec nullPovinné

Dátum a čas označenia platby ako zaplatenej.

Reťazec:format: "date-time"
statusOrderPaymentStatus Povinné

Stav prijímaný touto konkrétnou operáciou.

updated_atReťazecPovinné

Čas poslednej aktualizácie.

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

Verzia zdroja používaná na riadenie súbežných zmien.

pickup_pointPickupPointData nullPovinné

Výdajné miesto

Polia · pickup_point

PickupPointData

Úplný model: PickupPointData

null

prices_include_taxLogická hodnotaPovinné

Či uvedené ceny zahŕňajú daň.

shipping_addressAddressData nullPovinné

Doručovacia adresa.

Polia · shipping_address

AddressData

Úplný model: AddressData

null

shipping_discount_amountMoneyData Povinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Polia · shipping_discount_amount

Úplný model: MoneyData

amountReťazecPovinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

currencyReťazecPovinné

Kód meny sumy.

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

Počet desatinných miest používaných menou.

minimum: 0maximum: 4
statusOrderStatusData Povinné

Stav prijímaný touto konkrétnou operáciou.

Polia · status

Úplný model: OrderStatusData

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.

nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

updated_atReťazecPovinné

Čas poslednej aktualizácie.

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

Verzia zdroja používaná na riadenie súbežných zmien.

subtotalMoneyData Povinné

Suma pred ďalšími zložkami uvedenými v odpovedi.

Polia · subtotal

Úplný model: MoneyData

amountReťazecPovinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

currencyReťazecPovinné

Kód meny sumy.

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

Počet desatinných miest používaných menou.

minimum: 0maximum: 4
taxMoneyData Povinné

Daňové údaje.

Polia · tax

Úplný model: MoneyData

amountReťazecPovinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

currencyReťazecPovinné

Kód meny sumy.

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

Počet desatinných miest používaných menou.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Povinné

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

Polia · tax_breakdown

Úplný model: OrderTaxBreakdownData

groupsPole <OrderTaxGroupData > Povinné

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

unallocated_taxMoneyData Povinné

Nepriradená daň = order.tax − Σ groups.tax; ±.

tax_country_codeReťazec nullPovinné

Daňová krajina · Uložená snímka objednávky · ISO 3166-1 alpha-2; null.

totalMoneyData Povinné

Celková suma.

Polia · total

Úplný model: MoneyData

amountReťazecPovinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

currencyReťazecPovinné

Kód meny sumy.

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

Počet desatinných miest používaných menou.

minimum: 0maximum: 4
totalsOrderTotalsData Povinné

Súčty · net / tax / gross; Pred zľavami / Po zľavách.

Polia · totals

Úplný model: OrderTotalsData

before_discountsOrderAmountBreakdownData Povinné

Objednávka · Pred zľavami · net / tax / gross.

discountsOrderAmountBreakdownData Povinné

Zľavy

orderOrderAmountBreakdownData Povinné

Objednávka · Po zľavách · net / tax / gross.

product_discountsOrderAmountBreakdownData Povinné

Produkty · Zľavy · net / tax / gross.

productsOrderAmountBreakdownData Povinné

Produkty · Po zľavách · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Povinné

Produkty · Pred zľavami · net / tax / gross.

shippingOrderAmountBreakdownData Povinné

Doprava · Po zľavách · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Povinné

Doprava · Pred zľavami · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Povinné

Doprava · Zľavy · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metaúdaje odpovede.

Polia · meta

ContextPageMeta

Úplný model: ContextPageMeta

localeReťazecPovinné

Jazyk vybraný pre túto požiadavku.

market_codeReťazecPovinné

Kód trhu vrátený koncovým bodom kontextu.

market_idReťazecPovinné

Identifikátor trhu vrátený koncovým bodom kontextu.

paginationPagination Povinné

Metaúdaje stránkovania pomocou kurzora.

request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100

ContextMeta

Úplný model: ContextMeta

localeReťazecPovinné

Jazyk vybraný pre túto požiadavku.

market_codeReťazecPovinné

Kód trhu vrátený koncovým bodom kontextu.

market_idReťazecPovinné

Identifikátor trhu vrátený koncovým bodom kontextu.

request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100

PageMeta

Úplný model: PageMeta

paginationPagination Povinné

Metaúdaje stránkovania pomocou kurzora.

request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100

RequestMeta

Úplný model: RequestMeta

request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100
Príklad odpovede

Stav HTTP

200
Úspešná odpoveď Schéma
400
Neplatná požiadavka
401
Vyžaduje sa overenie
403
Prístup zamietnutý
404
Zdroj sa nenašiel
409
Konflikt verzií
422
Chyba validácie
429
Prekročený limit požiadaviek
Ďalšie stavy HTTP (7)
405
Metóda nie je povolená
413
Príliš veľká požiadavka
415
Nepodporovaný formát
500
Chyba servera
502
Chyba brány API
503
Služba nedostupná
504
Vypršal časový limit

Katalóg chýb: ErrorResponse

Hlavičky

401

WWW-AuthenticateReťazecVoliteľné

Spôsob overenia požadovaný serverom.

405

AllowReťazecVoliteľné

Metódy HTTP podporované týmto zdrojom.

429, 503

Retry-AfterCelé čísloVoliteľné

Minimálne oneskorenie pred opakovaním v sekundách.

minimum: 0

Katalóg chýb · Ďalšie informácie