Przejdź do treści
ShopentlyLearn
Polski

Modele zamówień

Schematy zamówień Shopently API: podsumowanie, szczegóły, statusy i płatności. Poznaj typy pól oraz struktury odpowiedzi.

Schematy danych

Adres dostawy

AddressData · Schemat · Modele zamówień
address_line_1Tekst nullWymagane

Pierwszy wiersz adresu.

address_line_2Tekst nullWymagane

Dodatkowe informacje adresowe.

cityTekst nullWymagane

Miasto lub miejscowość.

country_codeTekst nullWymagane

Kod kraju.

first_nameTekst nullWymagane

Imię.

house_numberTekst nullWymagane

Numer budynku lub domu.

last_nameTekst nullWymagane

Nazwisko.

phoneTekst nullWymagane

Numer telefonu.

postal_codeTekst nullWymagane

Kod pocztowy.

regionTekst nullWymagane

Region administracyjny.

streetTekst nullWymagane

Nazwa ulicy.

Dodatkowe pola: Nie

ApiResponse_OrderFileListData_

ApiResponse_OrderFileListData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
dataOrderFileListData Wymagane

Dane poprawnej odpowiedzi.

Przykład: {"files":[{"can_download":true,"category":"digital","filename":"manual.pdf","id":"example","label":"Manual","line_id":"example","mime_type":"application/pdf","product_id":"example","purchase_id":"00000000-0000-4000-8000-000000000001","reason":"paid","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"source_file_id":"00000000-0000-4000-8000-000000000001","source_version_id":"00000000-0000-4000-8000-000000000001","source_version_number":1,"state":"active"}],"updates_pending":false}
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

ApiResponse_OrderReleaseListData_

ApiResponse_OrderReleaseListData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
dataOrderReleaseListData Wymagane

Dane poprawnej odpowiedzi.

Przykład: {"releases":[{"access_reason":"paid","access_state":"active","current_release":null,"grant_reason":"purchase","granted_at":"2026-01-01T12:00:00Z","id":"example","line_id":"example","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","product_id":"example","published_at":"2026-01-01T12:00:00Z","purchase_id":"00000000-0000-4000-8000-000000000001","release_id":"00000000-0000-4000-8000-000000000001","release_sequence":1,"update_days":365,"update_mode":"period","update_months":null,"updates_until":"2027-01-01T12:00:00Z","version_label":"1.0"}],"updates_pending":false}
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

Pobierz listę zamówień — Odpowiedź

ApiResponse_list_OrderSummaryData__ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
dataTablica <OrderSummaryData > Wymagane

Przykład odpowiedzi · ApiResponse_list_OrderSummaryData__.

Przykład: [{"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"},"method_code":"shipping-old","method_name":"Historic carrier","pickup_point":null,"recipient_mode":"full_address"},"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"id":"order-0000","lifecycle_state":"placed","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},"prices_include_tax":true,"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_country_code":"PL","total":{"amount":"329.40","currency":"PLN","minor_units":2}}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

Pobierz zamówienie — Odpowiedź

ApiResponse_OrderDetailData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
dataOrderDetailData Wymagane

Przykład odpowiedzi · OrderDetailData.

Przykład: {"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}}}}
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"request_id":"example-request"}

Dodatkowe pola: Nie

CurrentReleaseData

CurrentReleaseData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
acquiredWartość logicznaWymagane

Dostęp po zakupie (true / false)

changelogTekstWymagane

Opis zmian

covered_by_purchaseWartość logicznaWymagane

Dostęp po zakupie (true / false)

idTekstWymagane

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

published_atTekstWymagane

Opublikuj wydanie · UTC

format: "date-time"
requires_new_purchaseWartość logicznaWymagane

Bez możliwości pobrania przyszłych plików po zakupie · requires_new_purchase

sequenceLiczba całkowitaWymagane

Pozycja w uporządkowanej kolekcji.

version_labelTekstWymagane

Wersja

Dodatkowe pola: Nie

Dane klienta zapisane dla tego zasobu

CustomerData · Schemat · Modele zamówień
emailTekstWymagane

Adres e-mail.

Przykład: "customer@example.invalid"
first_nameTekst nullWymagane

Imię.

Przykład: "Example"
last_nameTekst nullWymagane

Nazwisko.

Przykład: "Example"
phoneTekst nullWymagane

Numer telefonu.

Przykład: null

Dodatkowe pola: Nie

DeliveryContentDeletion

DeliveryContentDeletion · Żądanie usunięcia wydanego kodu albo pliku z zachowaniem historii przydziału.
expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1
Przykład: 1
reasonTekstWymagane

Powód zapisany dla zmiany.

minLength: 1maxLength: 500
Przykład: "Withdraw a revoked license"

Dodatkowe pola: Nie

Daty wysyłki i dostawy

DeliveryDatesData · 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.
dispatch_timezoneTekst nullWymagane

Strefa czasowa wysyłki (IANA; null).

Przykład: "Europe/Warsaw"
estimated_delivery_fromTekst nullWymagane

Początek przewidywanej dostawy (YYYY-MM-DD; null).

Tekst:format: "date"
Przykład: "2026-10-20"
estimated_delivery_toTekst nullWymagane

Koniec przewidywanej dostawy (YYYY-MM-DD; null).

Tekst:format: "date"
Przykład: "2026-10-21"
planned_dispatch_onTekst nullWymagane

Planowana data wysyłki (YYYY-MM-DD; null).

Tekst:format: "date"
Przykład: "2026-10-19"

Dodatkowe pola: Nie

DeliveryReplacement

DeliveryReplacement · Żądanie podmiany przydziału w zamówieniu na istniejącą dostępną jednostkę.
expected_unit_versionLiczba całkowitaWymagane

Bieżąca wersja dostępnej jednostki wybranej jako zamiennik.

minimum: 1
Przykład: 1
expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1
Przykład: 1
reasonTekstWymagane

Powód zapisany dla zmiany.

minLength: 1maxLength: 500
Przykład: "Replace an invalid activation code"
replacement_unit_idTekstWymagane

Identyfikator istniejącej wolnej jednostki wybranej na zamiennik przydziału w zamówieniu.

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000008"

Dodatkowe pola: Nie

DeliveryPickupPointData

DeliveryPickupPointData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
addressPickupPointAddressData Wymagane

Adres dostawy.

codeTekstWymagane

Stały kod przeznaczony do przetwarzania przez integrację.

Ograniczenia
pattern
"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesData nullWymagane

Wartość opisana przez otaczający schemat.

country_codeTekstWymagane

Kod kraju.

Ograniczenia
pattern
"^[A-Z]{2}$"
environmentTekstWymagane

Informacje o środowisku przypisane do rekordu.

Ograniczenia
enum
["live", "sandbox"]
kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia
enum
["locker", "pickup_point"]
location_descriptionTekst nullWymagane

Opis w wybranym języku.

Tekst:maxLength: 1000
nameTekstWymagane

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

minLength: 1maxLength: 160
opening_hoursTekst nullWymagane

Godziny otwarcia

Tekst:maxLength: 500
operatorTekstWymagane

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

minLength: 1maxLength: 63
verified_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"

Dodatkowe pola: Nie

ApiResponse[list[DeliveryData]]

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · Stronicowane przydziały cyfrowe jednego zamówienia; kody wymagają osobnego żądania treści.
dataTablica <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > Wymagane

Dane poprawnej odpowiedzi.

Przykład: [{"can_download":true,"content_state":"present","delete_due_at":null,"filename":null,"first_available_at":"2026-11-03T12:00:00Z","generation":1,"id":"00000000-0000-4000-8000-000000000005","kind":"code","line_id":"line-example","order_id":"order-example","payload_id":"00000000-0000-4000-8000-000000000012","product_id":"example","reason":"","size_bytes":null,"state":"available","unit_id":"00000000-0000-4000-8000-000000000011","unit_ordinal":1,"variant_id":null,"version":2}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Dodatkowe pola: Nie

DeliveryData

shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · Jeden cyfrowy przydział dla konkretnej pozycji i zakupionej sztuki wraz z bieżącą możliwością pobrania.
can_downloadWartość logicznaWymagane

Pobierz (true / false)

Przykład: true
content_stateTekstWymagane

Stan zawartości: present, deleting albo deleted. Wpis historii może pozostać po usunięciu.

Przykład: "present"
delete_due_atTekst nullWymagane

Termin usunięcia pliku albo null, gdy automatyczne usuwanie jest wyłączone.

Tekst:format: "date-time"
Przykład: null
filenameTekst nullWymagane

Plik

Przykład: null
first_available_atTekst nullWymagane

Pierwszy moment udostępnienia dla tego zakupu. Podmiana nie rozpoczyna retencji od nowa.

Tekst:format: "date-time"
Przykład: "2026-11-03T12:00:00Z"
generationLiczba całkowitaWymagane

Generacja przydziału. Podmiana tworzy nową generację i zachowuje starą w historii.

Przykład: 1
idTekstWymagane

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

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000005"
kindTekst nullWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Przykład: "code"
line_idTekstWymagane

Stały identyfikator pozycji zamówienia.

Przykład: "line-example"
order_idTekstWymagane

Identyfikator powiązanego zamówienia.

Przykład: "order-example"
payload_idTekstWymagane

Identyfikator dokładnej rewizji kodu albo pliku. Nie jest publicznym adresem pobierania.

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000012"
product_idTekstWymagane

Identyfikator produktu.

Przykład: "example"
reasonTekstWymagane

Powód zapisany dla zmiany.

Przykład: ""
size_bytesLiczba całkowita nullWymagane

Rozmiar w bajtach

Przykład: null
stateTekstWymagane

Status

Przykład: "available"
unit_idTekstWymagane

Identyfikator jednego indywidualnego kodu albo pliku w puli produktu.

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000011"
unit_ordinalLiczba całkowitaWymagane

Numer sztuki w ilości zakupionej w danej pozycji zamówienia.

Przykład: 1
variant_idTekst nullWymagane

Identyfikator wariantu produktu.

Przykład: null
versionLiczba całkowitaWymagane

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

Przykład: 2

Dodatkowe pola: Nie

Dane do faktury

InvoiceData · Schemat · Modele zamówień
address_line_1Tekst nullWymagane

Pierwszy wiersz adresu.

address_line_2Tekst nullWymagane

Dodatkowe informacje adresowe.

cityTekst nullWymagane

Miasto lub miejscowość.

company_nameTekst nullWymagane

Nazwa firmy.

country_codeTekst nullWymagane

Kod kraju.

house_numberTekst nullWymagane

Numer budynku lub domu.

postal_codeTekst nullWymagane

Kod pocztowy.

regionTekst nullWymagane

Region administracyjny.

streetTekst nullWymagane

Nazwa ulicy.

tax_identifierTekst nullWymagane

Numer identyfikacji podatkowej.

tax_schemeTekst nullWymagane

Schemat obliczania podatku.

Dodatkowe pola: Nie

Kwota netto / Kwota podatku / Kwota brutto

OrderAmountBreakdownData · 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.
grossMoneyData Wymagane

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

Przykład: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullWymagane

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

Przykład: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullWymagane

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

Przykład: {"amount":"58.60","currency":"PLN","minor_units":2}

Dodatkowe pola: Nie

Dostawa · Rabaty

OrderDeliveryDiscountData · 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.
amountMoneyData Wymagane

Kwota brutto · Dostawa · Rabaty.

Przykład: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idTekstWymagane

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

Przykład: "saved-coupon"
codeTekst nullWymagane

Stały kod przeznaczony do przetwarzania przez integrację.

Przykład: "SAVE"
kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia
enum
["coupon", "promotion"]
Przykład: "coupon"
nameTekstWymagane

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

Przykład: "Saved coupon"
sequenceLiczba całkowita nullWymagane

Pozycja w uporządkowanej kolekcji.

Przykład: 1
versionLiczba całkowitaWymagane

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

Przykład: 3

Dodatkowe pola: Nie

Pobierz zamówienie — Odpowiedź

OrderDetailData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"
Przykład: "2026-10-19T10:00:00Z"
customerCustomerData Wymagane

Dane klienta zapisane dla tego zasobu.

Przykład: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Wymagane

Metoda dostawy i powiązane informacje.

Przykład: {"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_amountMoneyData Wymagane

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

Przykład: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsTablica <OrderDiscountData > Wymagane

Rabaty

Przykład: [{"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}]
idTekstWymagane

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

Przykład: "order-0000"
invoiceInvoiceData nullWymagane

Dane do faktury.

Przykład: null
invoice_requestedWartość logicznaWymagane

Czy zażądano faktury.

Przykład: false
lifecycle_stateOrderLifecycleState Wymagane

Stan cyklu życia biznesowego.

Przykład: "placed"
linesTablica <OrderLineData > Wymagane

Zapisane pozycje zamówienia.

Przykład: [{"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":[]}]
localeTekstWymagane

Język wybrany dla tego żądania.

Przykład: "pl"
market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

Przykład: "market-pl"
numberTekstWymagane

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

Przykład: "0001"
paymentPaymentData Wymagane

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

Przykład: {"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_pointPickupPointData nullWymagane

Punkt odbioru

Przykład: null
prices_include_taxWartość logicznaWymagane

Czy ceny w cenniku zawierają podatek.

Przykład: true
shipping_addressAddressData nullWymagane

Adres dostawy.

Przykład: null
shipping_discount_amountMoneyData Wymagane

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

Przykład: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Wymagane

Status obsługiwany przez daną operację.

Przykład: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Wymagane

Kwota przed dodatkowymi składnikami pokazanymi w odpowiedzi.

Przykład: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Wymagane

Informacje o podatku.

Przykład: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Wymagane

Grupy podatkowe · source + tax_rate; unallocated_tax.

Przykład: {"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_codeTekst nullWymagane

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

Przykład: "PL"
totalMoneyData Wymagane

Łączna kwota.

Przykład: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Wymagane

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

Przykład: {"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}}}

Dodatkowe pola: Nie

OrderFileData

OrderFileData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
can_downloadWartość logicznaWymagane

Pobierz (true / false)

Przykład: true
categoryFileCategory Wymagane

Kategoria pliku: internal / customer_document / digital

Przykład: "digital"
filenameTekstWymagane

Plik

Przykład: "manual.pdf"
idTekstWymagane

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

Przykład: "example"
labelTekstWymagane

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

Przykład: "Manual"
line_idTekstWymagane

Stały identyfikator pozycji zamówienia.

Przykład: "example"
mime_typeTekstWymagane

Typ zawartości zasobu multimedialnego.

Przykład: "application/pdf"
product_idTekstWymagane

Identyfikator produktu.

Przykład: "example"
purchase_idTekstWymagane

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

Przykład: "00000000-0000-4000-8000-000000000001"
reasonTekstWymagane

Powód zapisany dla zmiany.

Przykład: "paid"
sha256TekstWymagane

SHA-256 (hex, 64)

Przykład: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesLiczba całkowitaWymagane

Rozmiar w bajtach

minimum: 1maximum: 262144000
Przykład: 46
source_file_idTekstWymagane

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

Przykład: "00000000-0000-4000-8000-000000000001"
source_version_idTekstWymagane

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

Przykład: "00000000-0000-4000-8000-000000000001"
source_version_numberLiczba całkowitaWymagane

Wersja

minimum: 1
Przykład: 1
stateTekstWymagane

Status

Przykład: "active"

Dodatkowe pola: Nie

OrderFileListData

OrderFileListData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
filesTablica <OrderFileData > Wymagane

Pliki produktu

Przykład: [{"can_download":true,"category":"digital","filename":"manual.pdf","id":"example","label":"Manual","line_id":"example","mime_type":"application/pdf","product_id":"example","purchase_id":"00000000-0000-4000-8000-000000000001","reason":"paid","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"source_file_id":"00000000-0000-4000-8000-000000000001","source_version_id":"00000000-0000-4000-8000-000000000001","source_version_number":1,"state":"active"}]
updates_pendingWartość logicznaWymagane

Dostęp do przyszłych plików po zakupie · updates_pending

Przykład: false

Dodatkowe pola: Nie

Metadane i adres zdjęcia

OrderImageData · Schemat · Modele zamówień
altTekst nullWymagane

Tekst alternatywny zdjęcia.

sourceTekstOpcjonalne

Źródło zarejestrowanej aktywności.

const: "current_catalog"
Wartość domyślna: "current_catalog"
urlTekstWymagane

Adres zasobu.

Dodatkowe pola: Nie

Stan cyklu życia biznesowego

OrderLifecycleState · Schemat · Modele zamówień Tekst
Ograniczenia
enum
["placed", "cancelled", "fulfilled", "returned"]

Dodatkowe pola: Tak

Zapisane pozycje zamówienia

OrderLineData · Schemat · Modele zamówień
discount_amountMoneyData Wymagane

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

Przykład: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Wymagane

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

Przykład: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullWymagane

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

Przykład: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullWymagane

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

Przykład: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsTablica <OrderDiscountData > Wymagane

Rabaty · net / tax / gross.

Przykład: [{"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}]
identifiersObiektDodatkowe pola: TekstWymagane

Kody identyfikacyjne produktu.

Przykład: {}
imageOrderImageData nullWymagane

Metadane i adres zdjęcia.

Przykład: null
line_idTekstWymagane

Stały identyfikator pozycji zamówienia.

Przykład: "saved-line-a"
manual_discountOrderManualDiscountData nullWymagane

Rabat ręczny; null.

Przykład: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameTekstWymagane

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

Przykład: "Saved A"
original_totalMoneyData Wymagane

Łączna kwota.

Przykład: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Wymagane

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

Przykład: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullWymagane

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

Przykład: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullWymagane

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

Przykład: {"amount":"46.00","currency":"PLN","minor_units":2}
positionLiczba całkowitaWymagane

Pozycja w uporządkowanej kolekcji.

Przykład: 1
product_idTekstWymagane

Identyfikator produktu.

Przykład: "product-api"
quantityLiczba całkowitaWymagane

Liczba jednostek.

Przykład: 2
skuTekstWymagane

Kod jednostki magazynowej SKU.

Przykład: "A"
taxMoneyData nullWymagane

Kwota podatku · Jedna sztuka · Zapisana migawka zamówienia; tax ≠ unit_tax; Nieznane: null; znane zero: 0.

Przykład: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idTekst nullWymagane

Identyfikator kategorii podatkowej · Zapisana migawka zamówienia; null.

Przykład: "standard"
tax_category_nameTekst nullWymagane

Zapisana nazwa kategorii podatkowej; null.

Przykład: "VAT 23%"
tax_rateTekst nullWymagane

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

Przykład: "0.23"
totalMoneyData Wymagane

Łączna kwota.

Przykład: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Wymagane

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

Przykład: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullWymagane

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

Przykład: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullWymagane

Kwota podatku · Produkty · Po rabatach · Zapisana migawka zamówienia; Nieznane: null; znane zero: 0.

Przykład: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Wymagane

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

Przykład: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullWymagane

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

Przykład: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Wymagane

Cena jednostkowa.

Przykład: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullWymagane

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

Przykład: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idTekst nullWymagane

Identyfikator wariantu produktu.

Przykład: null
variant_optionsTablica <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Wymagane

Opcje wariantu powiązane z produktem lub zapisaną pozycją.

Przykład: []

Dodatkowe pola: Nie

Rabat ręczny

OrderManualDiscountData · 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.
amountMoneyData Wymagane

Kwota brutto · Rabat ręczny · Zapisana migawka zamówienia.

Przykład: {"amount":"12.30","currency":"PLN","minor_units":2}
kindTekstWymagane

Rodzaj rabatu: percentage / fixed.

Ograniczenia
enum
["percentage", "fixed"]
Przykład: "fixed"
valueTekstWymagane

Skonfigurowana wartość: percentage "10" = 10%; fixed = Kwota brutto.

Przykład: "12.30"

Dodatkowe pola: Nie

Status obsługiwany przez daną operację

OrderPaymentStatus · Schemat · Modele zamówień Tekst
Ograniczenia
enum
["unpaid", "paid", "failed", "refunded"]

Dodatkowe pola: Tak

OrderReleaseData

OrderReleaseData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
access_reasonTekstWymagane

Dostęp po zakupie · Powód zapisany dla zmiany.

Przykład: "paid"
access_stateTekstWymagane

Dostęp po zakupie · Status

Przykład: "active"
current_releaseCurrentReleaseData nullWymagane

Wydania cyfrowe · current_release

Przykład: null
grant_reasonTekstWymagane

Dostęp po zakupie · Powód zapisany dla zmiany.

Przykład: "purchase"
granted_atTekstWymagane

Dostęp po zakupie · UTC

format: "date-time"
Przykład: "2026-01-01T12:00:00Z"
idTekstWymagane

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

Przykład: "example"
line_idTekstWymagane

Stały identyfikator pozycji zamówienia.

Przykład: "example"
manifest_sha256TekstWymagane

Wydania cyfrowe · SHA-256

Przykład: "1111111111111111111111111111111111111111111111111111111111111111"
product_idTekstWymagane

Identyfikator produktu.

Przykład: "example"
published_atTekstWymagane

Opublikuj wydanie · UTC

format: "date-time"
Przykład: "2026-01-01T12:00:00Z"
purchase_idTekstWymagane

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

Przykład: "00000000-0000-4000-8000-000000000001"
release_idTekstWymagane

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

Przykład: "00000000-0000-4000-8000-000000000001"
release_sequenceLiczba całkowitaWymagane

Wydania cyfrowe · Pozycja w uporządkowanej kolekcji.

Przykład: 1
update_daysLiczba całkowita nullWymagane

Liczba dni (days; null)

Przykład: 365
update_modeTekstWymagane

Dostęp do przyszłych plików po zakupie: none / period / unlimited

Przykład: "period"
update_monthsLiczba całkowita nullWymagane

Miesiące (months; null)

Przykład: null
updates_untilTekst nullWymagane

Dostęp do przyszłych plików po zakupie · UTC

Tekst:format: "date-time"
Przykład: "2027-01-01T12:00:00Z"
version_labelTekstWymagane

Wersja

Przykład: "1.0"

Dodatkowe pola: Nie

OrderReleaseListData

OrderReleaseListData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
releasesTablica <OrderReleaseData > Wymagane

Wydania cyfrowe

Przykład: [{"access_reason":"paid","access_state":"active","current_release":null,"grant_reason":"purchase","granted_at":"2026-01-01T12:00:00Z","id":"example","line_id":"example","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","product_id":"example","published_at":"2026-01-01T12:00:00Z","purchase_id":"00000000-0000-4000-8000-000000000001","release_id":"00000000-0000-4000-8000-000000000001","release_sequence":1,"update_days":365,"update_mode":"period","update_months":null,"updates_until":"2027-01-01T12:00:00Z","version_label":"1.0"}]
updates_pendingWartość logicznaWymagane

Dostęp do przyszłych plików po zakupie · updates_pending

Przykład: false

Dodatkowe pola: Nie

Status obsługiwany przez daną operację

OrderStatusData · Schemat · Modele zamówień
idTekstWymagane

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

Przykład: "status-0"
nameTekstWymagane

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

Przykład: "Status 0"
updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"
Przykład: "2026-10-19T10:00:00Z"
versionLiczba całkowitaWymagane

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

Przykład: 1

Dodatkowe pola: Nie

Pobierz statusy zamówień — Odpowiedź

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"
Przykład: "2026-01-01T12:00:00Z"
idTekstWymagane

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

Przykład: "status-0"
is_initialWartość logicznaWymagane

Czy jest to status początkowy.

Przykład: true
nameTekstWymagane

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

Przykład: "New"
positionLiczba całkowitaWymagane

Pozycja w uporządkowanej kolekcji.

Przykład: 0

Dodatkowe pola: Nie

Pobierz statusy zamówień — Odpowiedź

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
dataTablica <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Wymagane

Przykład odpowiedzi · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Przykład: [{"created_at":"2026-01-01T12:00:00Z","id":"status-0","is_initial":true,"name":"New","position":0},{"created_at":"2026-01-01T12:00:00Z","id":"status-1","is_initial":false,"name":"Processing","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

Zmień status zamówienia — Treść żądania

OrderStatusUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807
Przykład: 1
status_idTekstWymagane

Identyfikator pobrany z odpowiedniego słownika statusów.

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

Dodatkowe pola: Nie

Pobierz listę zamówień — Odpowiedź

OrderSummaryData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"
Przykład: "2026-10-19T10:00:00Z"
customerCustomerData Wymagane

Dane klienta zapisane dla tego zasobu.

Przykład: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Wymagane

Metoda dostawy i powiązane informacje.

Przykład: {"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"},"method_code":"shipping-old","method_name":"Historic carrier","pickup_point":null,"recipient_mode":"full_address"}
discount_amountMoneyData Wymagane

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

Przykład: {"amount":"24.60","currency":"PLN","minor_units":2}
idTekstWymagane

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

Przykład: "order-0000"
lifecycle_stateOrderLifecycleState Wymagane

Stan cyklu życia biznesowego.

Przykład: "placed"
localeTekstWymagane

Język wybrany dla tego żądania.

Przykład: "pl"
market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

Przykład: "market-pl"
numberTekstWymagane

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

Przykład: "0001"
paymentPaymentData Wymagane

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

Przykład: {"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}
prices_include_taxWartość logicznaWymagane

Czy ceny w cenniku zawierają podatek.

Przykład: true
shipping_discount_amountMoneyData Wymagane

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

Przykład: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Wymagane

Status obsługiwany przez daną operację.

Przykład: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Wymagane

Kwota przed dodatkowymi składnikami pokazanymi w odpowiedzi.

Przykład: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Wymagane

Informacje o podatku.

Przykład: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeTekst nullWymagane

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

Przykład: "PL"
totalMoneyData Wymagane

Łączna kwota.

Przykład: {"amount":"329.40","currency":"PLN","minor_units":2}

Dodatkowe pola: Nie

Zamówienie · Grupy podatkowe

OrderTaxBreakdownData · 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.
groupsTablica <OrderTaxGroupData > Wymagane

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

Przykład: [{"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_taxMoneyData Wymagane

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

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}

Dodatkowe pola: Nie

Grupy podatkowe

OrderTaxGroupData · 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.
grossMoneyData Wymagane

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

Przykład: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullWymagane

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

Przykład: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceTekstWymagane

Źródło: products (Produkty), shipping (Dostawa).

Ograniczenia
enum
["products", "shipping"]
Przykład: "products"
taxMoneyData nullWymagane

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

Przykład: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateTekst nullWymagane

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

Przykład: "0.23"

Dodatkowe pola: Nie

Zamówienie · Podsumowania

OrderTotalsData · 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.
before_discountsOrderAmountBreakdownData Wymagane

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

Przykład: {"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}}
discountsOrderAmountBreakdownData Wymagane

Rabaty · net / tax / gross.

Przykład: {"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}}
orderOrderAmountBreakdownData Wymagane

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

Przykład: {"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_discountsOrderAmountBreakdownData Wymagane

Produkty · Rabaty · net / tax / gross.

Przykład: {"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}}
productsOrderAmountBreakdownData Wymagane

Produkty · Po rabatach · net / tax / gross.

Przykład: {"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_discountsOrderAmountBreakdownData Wymagane

Produkty · Przed rabatami · net / tax / gross.

Przykład: {"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}}
shippingOrderAmountBreakdownData Wymagane

Dostawa · Po rabatach · net / tax / gross.

Przykład: {"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_discountsOrderAmountBreakdownData Wymagane

Dostawa · Przed rabatami · net / tax / gross.

Przykład: {"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_discountsOrderAmountBreakdownData Wymagane

Dostawa · Rabaty · net / tax / gross.

Przykład: {"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}}

Dodatkowe pola: Nie

Opcje wariantu powiązane z produktem lub zapisaną pozycją

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Schemat · Modele zamówień
nameTekstWymagane

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

valueTekstWymagane

Wartość opisana przez otaczający schemat.

Dodatkowe pola: Nie

OrderDiscountData

OrderDiscountData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
amountMoneyData Wymagane

Kwota brutto · Produkty · Rabaty.

Przykład: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idTekstWymagane

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

Przykład: "saved-coupon"
codeTekst nullWymagane

Stały kod przeznaczony do przetwarzania przez integrację.

Przykład: "SAVE"
kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia
enum
["coupon", "promotion"]
Przykład: "coupon"
nameTekstWymagane

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

Przykład: "Saved coupon"
sequenceLiczba całkowita nullOpcjonalne

Kolejność zastosowania; null.

Przykład: 1
shipping_amountMoneyData nullOpcjonalne

Kwota brutto · Dostawa · Rabaty; null.

Przykład: {"amount":"24.60","currency":"PLN","minor_units":2}
versionLiczba całkowitaWymagane

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

Przykład: 3

Dodatkowe pola: Nie

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

PaymentData · Schemat · Modele zamówień
amountMoneyData Wymagane

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.

Przykład: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentTekstWymagane

Informacje o środowisku przypisane do rekordu.

Ograniczenia
enum
["live", "sandbox"]
Przykład: "live"
method_codeTekst nullWymagane

Kod metody dostawy lub płatności.

Przykład: "payment-old"
method_nameTekst nullWymagane

Nazwa metody dostawy lub płatności.

Przykład: "Historic method"
paid_atTekst nullWymagane

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

Tekst:format: "date-time"
Przykład: null
statusOrderPaymentStatus Wymagane

Status obsługiwany przez daną operację.

Przykład: "unpaid"
updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"
Przykład: "2026-10-19T10:00:00Z"
versionLiczba całkowitaWymagane

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

Przykład: 0

Dodatkowe pola: Nie

Zmień status płatności zamówienia — Treść żądania

PaymentStatusUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 0maximum: 9223372036854775807
Przykład: 0
reasonTekstWymagane

Powód zapisany dla zmiany.

minLength: 1maxLength: 500
Przykład: "Bank transfer confirmed"
statusPaymentStatus Wymagane

Status obsługiwany przez daną operację. unpaid: nieopłacone; paid: opłacone; failed: nieudana płatność; refunded: zwrócone.

Przykład: "paid"

Dodatkowe pola: Nie

Status obsługiwany przez daną operację

PaymentStatus · Schemat · Modele zamówień Tekst
Ograniczenia
enum
["unpaid", "paid", "failed", "refunded"]

Dodatkowe pola: Tak

PickupPointAddressData

PickupPointAddressData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
address_line_1TekstWymagane

Pierwszy wiersz adresu.

minLength: 1maxLength: 240
cityTekstWymagane

Miasto lub miejscowość.

minLength: 1maxLength: 160
postal_codeTekstWymagane

Kod pocztowy.

minLength: 1maxLength: 32

Dodatkowe pola: Nie

PickupPointCoordinatesData

PickupPointCoordinatesData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
latitudeLiczbaWymagane

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeLiczbaWymagane

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Dodatkowe pola: Nie

PickupPointData

PickupPointData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
address_line1TekstWymagane

Pierwszy wiersz adresu.

cityTekstWymagane

Miasto lub miejscowość.

codeTekstWymagane

Stały kod przeznaczony do przetwarzania przez integrację.

country_codeTekstWymagane

Kod kraju.

kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia
enum
["locker", "pickup_point"]
latitudeLiczba nullWymagane

WGS84 φ (°)

location_descriptionTekst nullWymagane

Opis w wybranym języku.

longitudeLiczba nullWymagane

WGS84 λ (°)

nameTekstWymagane

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

opening_hoursTekst nullWymagane

Godziny otwarcia

operatorTekstWymagane

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

postal_codeTekstWymagane

Kod pocztowy.

Dodatkowe pola: Nie

PickupPointSummaryData

PickupPointSummaryData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
codeTekstWymagane

Stały kod przeznaczony do przetwarzania przez integrację.

Ograniczenia
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeTekstWymagane

Kod kraju.

Ograniczenia
pattern
"^[A-Z]{2}$"
environmentTekstWymagane

Informacje o środowisku przypisane do rekordu.

Ograniczenia
enum
["live", "sandbox"]
kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia
enum
["locker", "pickup_point"]
operatorTekstWymagane

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

minLength: 1maxLength: 63

Dodatkowe pola: Nie

Dane klienta zapisane dla tego zasobu

RequestCustomerData · Schemat · Modele zamówień
emailTekstWymagane

Adres e-mail.

Przykład: "customer@example.invalid"
nameTekstWymagane

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

Przykład: "Example"

Dodatkowe pola: Nie

Metoda dostawy i powiązane informacje

ShippingData · Schemat · Modele zamówień
amountMoneyData Wymagane

Kwota brutto dostawy zapisana w zamówieniu jako MoneyData. Późniejsze zmiany podatku nie zmieniają tej historycznej kwoty.

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Wymagane

Daty wysyłki i dostawy. 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.

Przykład: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
method_codeTekst nullWymagane

Kod metody dostawy lub płatności.

Przykład: "shipping-old"
method_nameTekst nullWymagane

Nazwa metody dostawy lub płatności.

Przykład: "Historic carrier"
pickup_pointPickupPointSummaryData nullWymagane

Punkt odbioru

Przykład: null
recipient_modeTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Przykład: "full_address"

Dodatkowe pola: Nie

ShippingDetailData

ShippingDetailData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
amountMoneyData Wymagane

Kwota brutto dostawy zapisana w zamówieniu jako MoneyData. Późniejsze zmiany podatku nie zmieniają tej historycznej kwoty.

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Wymagane

Daty wysyłki i dostawy. 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.

Przykład: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
discount_grossMoneyData Wymagane

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

Przykład: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullWymagane

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

Przykład: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullWymagane

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

Przykład: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsTablica <OrderDeliveryDiscountData > nullWymagane

Dostawa · Rabaty; []: 0; null: Nieznane: null; znane zero: 0.

Przykład: [{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}]
grossMoneyData Wymagane

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

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeTekst nullWymagane

Kod metody dostawy lub płatności.

Przykład: "shipping-old"
method_nameTekst nullWymagane

Nazwa metody dostawy lub płatności.

Przykład: "Historic carrier"
netMoneyData nullWymagane

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

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Wymagane

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

Przykład: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullWymagane

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

Przykład: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullWymagane

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

Przykład: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullWymagane

Punkt odbioru

Przykład: null
recipient_modeTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Przykład: "full_address"
taxMoneyData nullWymagane

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

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idTekst nullWymagane

Identyfikator kategorii podatkowej · Zapisana migawka zamówienia; null.

Przykład: "standard"
tax_category_nameTekst nullWymagane

Zapisana nazwa kategorii podatkowej; null.

Przykład: "VAT 23%"
tax_rateTekst nullWymagane

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

Przykład: "0.23"

Dodatkowe pola: Nie