Przejdź do treści
ShopentlyLearn
Polski

Pobierz zamówienie

Pobierz zamówienie przez Shopently API. Identyfikator order_id. Przykłady cURL, PHP i Python.

GET/api/v1/orders/{order_id}

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

Przykłady kodu

Przykład żądania

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/orders/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))

Przykład odpowiedzi 200

JSON
{
  "data": {
    "created_at": "2026-10-19T10:00:00Z",
    "customer": {
      "email": "customer@example.invalid",
      "first_name": "Example",
      "last_name": "Example",
      "phone": null
    },
    "delivery": {
      "amount": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "dates": {
        "dispatch_timezone": "Europe/Warsaw",
        "estimated_delivery_from": "2026-10-20",
        "estimated_delivery_to": "2026-10-21",
        "planned_dispatch_on": "2026-10-19"
      },
      "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 działa

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

Bezpieczny zapis

Uprawnienia i plany

Zamówienie · Podsumowania

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

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

  • tax_country_code · Kraj podatkowy · Zapisana migawka zamówienia · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Jedna sztuka · Przed rabatami; lines[].original_total_* · Przed rabatami; lines[].total_* · Po rabatach.
  • lines[].discount_* · Rabaty; manual_discount · Rabat ręczny; percentage "10" = 10%.
  • delivery.net / tax / gross · Po rabatach; delivery.original_* · Przed rabatami; delivery.discount_* · Rabaty.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Nieznane: null; znane zero: 0.
  • totals · Podsumowania; tax_breakdown.groups · Grupy podatkowe; Nieprzypisany podatek = order.tax − Σ groups.tax; ±.

payment.amount to łączna kwota zamówienia. Status płatności nie określa kwoty wpłaconej, zwróconej ani pozostałej do zapłaty.

Parametry

Parametry ścieżki

order_idTekstWymagane

Identyfikator powiązanego zamówienia.

Ograniczenia
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Przykład: "example"

Ta operacja nie przyjmuje treści JSON.

Odpowiedzi

Odpowiedź 200

Pełny model: ApiResponse_OrderDetailData_

dataOrderDetailData Wymagane

Dane poprawnej odpowiedzi.

Pola · data

Pełny model: OrderDetailData

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"
customerCustomerData Wymagane

Dane klienta zapisane dla tego zasobu.

Pola · customer

Pełny model: CustomerData

emailTekstWymagane

Adres e-mail.

first_nameTekst nullWymagane

Imię.

last_nameTekst nullWymagane

Nazwisko.

phoneTekst nullWymagane

Numer telefonu.

deliveryShippingDetailData Wymagane

Metoda dostawy i powiązane informacje.

Pola · delivery

Pełny model: ShippingDetailData

amountMoneyData Wymagane

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

datesDeliveryDatesData Wymagane

Daty wysyłki i dostawy

discount_grossMoneyData Wymagane

Kwota brutto · Rabaty; Nieznane: null; znane zero: 0.

discount_netMoneyData nullWymagane

Kwota netto · Rabaty; Nieznane: null; znane zero: 0.

discount_taxMoneyData nullWymagane

Kwota podatku · Rabaty; Nieznane: null; znane zero: 0.

discountsTablica <OrderDeliveryDiscountData > nullWymagane

Rabaty

grossMoneyData Wymagane

Kwota brutto · Po rabatach; Nieznane: null; znane zero: 0.

method_codeTekst nullWymagane

Kod metody dostawy lub płatności.

method_nameTekst nullWymagane

Nazwa metody dostawy lub płatności.

netMoneyData nullWymagane

Kwota netto · Po rabatach; Nieznane: null; znane zero: 0.

original_grossMoneyData Wymagane

Kwota brutto · Dostawa · Przed rabatami; Nieznane: null; znane zero: 0.

original_netMoneyData nullWymagane

Kwota netto · Dostawa · Przed rabatami; Nieznane: null; znane zero: 0.

original_taxMoneyData nullWymagane

Kwota podatku · Dostawa · Przed rabatami; Nieznane: null; znane zero: 0.

pickup_pointDeliveryPickupPointData nullWymagane

Punkt odbioru

recipient_modeTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia
enum
["full_address", "pickup_contact"]
taxMoneyData nullWymagane

Informacje o podatku.

tax_category_idTekst nullWymagane

Identyfikator kategorii podatkowej.

tax_category_nameTekst nullWymagane

Zapisana nazwa kategorii podatkowej; null.

tax_rateTekst nullWymagane

tax_rate · Zapisana migawka zamówienia: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Wymagane

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

Pola · discount_amount

Pełny model: MoneyData

amountTekstWymagane

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

currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia
pattern
"^[A-Z]{3}$"
minor_unitsLiczba całkowitaWymagane

Liczba cyfr części ułamkowej używanych przez walutę.

minimum: 0maximum: 4
discountsTablica <OrderDiscountData > Wymagane

Rabaty

Pola · discounts

OrderDiscountData

Pełny model: OrderDiscountData

idTekstWymagane

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

invoiceInvoiceData nullWymagane

Dane do faktury.

Pola · invoice

InvoiceData

Pełny model: InvoiceData

null

invoice_requestedWartość logicznaWymagane

Czy zażądano faktury.

lifecycle_stateOrderLifecycleState Wymagane

Stan cyklu życia biznesowego.

linesTablica <OrderLineData > Wymagane

Zapisane pozycje zamówienia.

Pola · lines

OrderLineData

Pełny model: OrderLineData

localeTekstWymagane

Język wybrany dla tego żądania.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

numberTekstWymagane

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

paymentPaymentData Wymagane

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

Pola · payment

Pełny model: PaymentData

amountMoneyData Wymagane

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

environmentTekstWymagane

Informacje o środowisku przypisane do rekordu.

Ograniczenia
enum
["live", "sandbox"]
method_codeTekst nullWymagane

Kod metody dostawy lub płatności.

method_nameTekst nullWymagane

Nazwa metody dostawy lub płatności.

paid_atTekst nullWymagane

Data i czas oznaczenia płatności jako opłaconej.

Tekst:format: "date-time"
statusOrderPaymentStatus Wymagane

Status obsługiwany przez daną operację.

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"
versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

pickup_pointPickupPointData nullWymagane

Punkt odbioru

Pola · pickup_point

PickupPointData

Pełny model: PickupPointData

null

prices_include_taxWartość logicznaWymagane

Czy ceny w cenniku zawierają podatek.

shipping_addressAddressData nullWymagane

Adres dostawy.

Pola · shipping_address

AddressData

Pełny model: AddressData

null

shipping_discount_amountMoneyData Wymagane

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

Pola · shipping_discount_amount

Pełny model: MoneyData

amountTekstWymagane

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

currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia
pattern
"^[A-Z]{3}$"
minor_unitsLiczba całkowitaWymagane

Liczba cyfr części ułamkowej używanych przez walutę.

minimum: 0maximum: 4
statusOrderStatusData Wymagane

Status obsługiwany przez daną operację.

Pola · status

Pełny model: OrderStatusData

idTekstWymagane

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

nameTekstWymagane

Nazwa zasobu we właściwym kontekście.

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"
versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

subtotalMoneyData Wymagane

Kwota przed dodatkowymi składnikami pokazanymi w odpowiedzi.

Pola · subtotal

Pełny model: MoneyData

amountTekstWymagane

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

currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia
pattern
"^[A-Z]{3}$"
minor_unitsLiczba całkowitaWymagane

Liczba cyfr części ułamkowej używanych przez walutę.

minimum: 0maximum: 4
taxMoneyData Wymagane

Informacje o podatku.

Pola · tax

Pełny model: MoneyData

amountTekstWymagane

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

currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia
pattern
"^[A-Z]{3}$"
minor_unitsLiczba całkowitaWymagane

Liczba cyfr części ułamkowej używanych przez walutę.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Wymagane

Grupy podatkowe · source + tax_rate; unallocated_tax.

Pola · tax_breakdown

Pełny model: OrderTaxBreakdownData

groupsTablica <OrderTaxGroupData > Wymagane

Grupy podatkowe · source + tax_rate; Nieznane: null; znane zero: 0.

unallocated_taxMoneyData Wymagane

Nieprzypisany podatek = order.tax − Σ groups.tax; ±.

tax_country_codeTekst nullWymagane

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

totalMoneyData Wymagane

Łączna kwota.

Pola · total

Pełny model: MoneyData

amountTekstWymagane

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

currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia
pattern
"^[A-Z]{3}$"
minor_unitsLiczba całkowitaWymagane

Liczba cyfr części ułamkowej używanych przez walutę.

minimum: 0maximum: 4
totalsOrderTotalsData Wymagane

Podsumowania · net / tax / gross; Przed rabatami / Po rabatach.

Pola · totals

Pełny model: OrderTotalsData

before_discountsOrderAmountBreakdownData Wymagane

Zamówienie · Przed rabatami · net / tax / gross.

discountsOrderAmountBreakdownData Wymagane

Rabaty

orderOrderAmountBreakdownData Wymagane

Zamówienie · Po rabatach · net / tax / gross.

product_discountsOrderAmountBreakdownData Wymagane

Produkty · Rabaty · net / tax / gross.

productsOrderAmountBreakdownData Wymagane

Produkty · Po rabatach · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Wymagane

Produkty · Przed rabatami · net / tax / gross.

shippingOrderAmountBreakdownData Wymagane

Dostawa · Po rabatach · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Wymagane

Dostawa · Przed rabatami · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Wymagane

Dostawa · Rabaty · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Pola · meta

ContextPageMeta

Pełny model: ContextPageMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

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

minLength: 1maxLength: 100

ContextMeta

Pełny model: ContextMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

request_idTekstWymagane

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

minLength: 1maxLength: 100

PageMeta

Pełny model: PageMeta

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

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

minLength: 1maxLength: 100

RequestMeta

Pełny model: RequestMeta

request_idTekstWymagane

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

minLength: 1maxLength: 100
Przykład odpowiedzi

Status HTTP

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

Katalog błędów: ErrorResponse

Nagłówki

401

WWW-AuthenticateTekstOpcjonalne

Schemat uwierzytelniania wymagany przez serwer.

405

AllowTekstOpcjonalne

Metody HTTP obsługiwane przez ten zasób.

429, 503

Retry-AfterLiczba całkowitaOpcjonalne

Minimalny czas przed ponowieniem, w sekundach.

minimum: 0

Katalog błędów · Dowiedz się więcej