Ugrás a tartalomhoz
ShopentlyLearn
Magyar

Adatsémák: Rendelések

Adatsémák: Rendelések. Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

Adatsémák

Szállítási cím

AddressData · Séma · Adatsémák: Rendelések
address_line_1Karakterlánc nullKötelező

A cím első sora.

address_line_2Karakterlánc nullKötelező

További címadatok.

cityKarakterlánc nullKötelező

Város vagy település.

country_codeKarakterlánc nullKötelező

Országkód.

first_nameKarakterlánc nullKötelező

Utónév.

house_numberKarakterlánc nullKötelező

Épület- vagy házszám.

last_nameKarakterlánc nullKötelező

Családi név.

phoneKarakterlánc nullKötelező

Telefonszám.

postal_codeKarakterlánc nullKötelező

Irányítószám.

regionKarakterlánc nullKötelező

Közigazgatási régió.

streetKarakterlánc nullKötelező

Utcanév.

További mezők: Nem

ApiResponse_OrderFileListData_

ApiResponse_OrderFileListData_ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai. Az upload_id létrehozása után küldje a fájlokat multipart/form-data formátumban, majd rendelje a termékhez. A letöltéshez Bearer-token és a category szerinti jogosultság szükséges; a válasz a fájl bájtjait tartalmazza nyilvános cím és jelszó nélkül. A mode=period esetén days (1–3650) vagy a korábbi months adható meg, egyszerre mindkettő nem. A feltételek vásárláskor rögzülnek; a visszatérítés csak az érintett tétel hozzáférését vonja vissza.
dataOrderFileListData Kötelező

A sikeres válasz adatai.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

További mezők: Nem

ApiResponse_OrderReleaseListData_

ApiResponse_OrderReleaseListData_ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai. Az upload_id létrehozása után küldje a fájlokat multipart/form-data formátumban, majd rendelje a termékhez. A letöltéshez Bearer-token és a category szerinti jogosultság szükséges; a válasz a fájl bájtjait tartalmazza nyilvános cím és jelszó nélkül. A mode=period esetén days (1–3650) vagy a korábbi months adható meg, egyszerre mindkettő nem. A feltételek vásárláskor rögzülnek; a visszatérítés csak az érintett tétel hozzáférését vonja vissza.
dataOrderReleaseListData Kötelező

A sikeres válasz adatai.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

További mezők: Nem

Listázás — Rendelések — Válasz

ApiResponse_list_OrderSummaryData__ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
dataTömb <OrderSummaryData > Kötelező

Példaválasz · ApiResponse_list_OrderSummaryData__.

Példa: [{"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 Kötelező

A válasz metaadatai.

Példa: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

További mezők: Nem

Lekérés — Rendelések — Válasz

ApiResponse_OrderDetailData_ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
dataOrderDetailData Kötelező

Példaválasz · OrderDetailData.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"request_id":"example-request"}

További mezők: Nem

CurrentReleaseData

CurrentReleaseData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai. Az upload_id létrehozása után küldje a fájlokat multipart/form-data formátumban, majd rendelje a termékhez. A letöltéshez Bearer-token és a category szerinti jogosultság szükséges; a válasz a fájl bájtjait tartalmazza nyilvános cím és jelszó nélkül. A mode=period esetén days (1–3650) vagy a korábbi months adható meg, egyszerre mindkettő nem. A feltételek vásárláskor rögzülnek; a visszatérítés csak az érintett tétel hozzáférését vonja vissza.
acquiredLogikai értékKötelező

Hozzáférés vásárlás után (true / false)

changelogKarakterláncKötelező

Változások leírása

covered_by_purchaseLogikai értékKötelező

Hozzáférés vásárlás után (true / false)

idKarakterláncKötelező

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

published_atKarakterláncKötelező

Kiadás közzététele · UTC

format: "date-time"
requires_new_purchaseLogikai értékKötelező

Nincs hozzáférés a vásárlás után hozzáadott fájlokhoz · requires_new_purchase

sequenceEgész számKötelező

Pozíció a rendezett gyűjteményben.

version_labelKarakterláncKötelező

Verzió

További mezők: Nem

Az erőforráshoz rögzített ügyféladatok

CustomerData · Séma · Adatsémák: Rendelések
emailKarakterláncKötelező

E-mail-cím.

Példa: "customer@example.invalid"
first_nameKarakterlánc nullKötelező

Utónév.

Példa: "Example"
last_nameKarakterlánc nullKötelező

Családi név.

Példa: "Example"
phoneKarakterlánc nullKötelező

Telefonszám.

Példa: null

További mezők: Nem

DeliveryContentDeletion

DeliveryContentDeletion · Töröld végleg a tartalmat az előzmények megőrzésével. A kód nem kerül vissza az eladható készletbe.
expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1
Példa: 1
reasonKarakterláncKötelező

A módosításhoz rögzített indok.

minLength: 1maxLength: 500
Példa: "Withdraw a revoked license"

További mezők: Nem

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

DeliveryDatesData · A rendeléslista és a részletek tartalmazzák a delivery.dates objektumot. A YYYY-MM-DD dátumok tervezettek, nem igazolják a feladást. Az aktuális dátumok elsőbbséget élveznek; a régebbi rendelések a mentett becslést használják. A törölt vagy ismeretlen érték null. A részletek minden tételt és termékképet is tartalmaznak.
dispatch_timezoneKarakterlánc nullKötelező

A feladás időzónája (IANA; null).

Példa: "Europe/Warsaw"
estimated_delivery_fromKarakterlánc nullKötelező

A várható kézbesítés kezdete (YYYY-MM-DD; null).

Karakterlánc:format: "date"
Példa: "2026-10-20"
estimated_delivery_toKarakterlánc nullKötelező

A várható kézbesítés vége (YYYY-MM-DD; null).

Karakterlánc:format: "date"
Példa: "2026-10-21"
planned_dispatch_onKarakterlánc nullKötelező

Tervezett feladási dátum (YYYY-MM-DD; null).

Karakterlánc:format: "date"
Példa: "2026-10-19"

További mezők: Nem

DeliveryReplacement

DeliveryReplacement · Válassz egy meglévő szabad egységet. A csere nem indítja újra a megőrzési időt.
expected_unit_versionEgész számKötelező

A szabad csereegység jelenlegi verziója.

minimum: 1
Példa: 1
expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1
Példa: 1
reasonKarakterláncKötelező

A módosításhoz rögzített indok.

minLength: 1maxLength: 500
Példa: "Replace an invalid activation code"
replacement_unit_idKarakterláncKötelező

Egy meglévő szabad csereegység azonosítója.

format: "uuid"
Példa: "00000000-0000-4000-8000-000000000008"

További mezők: Nem

DeliveryPickupPointData

DeliveryPickupPointData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
addressPickupPointAddressData Kötelező

Szállítási cím.

codeKarakterláncKötelező

Stabil, géppel feldolgozható kód.

Korlátozások
pattern
"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesData nullKötelező

A környező séma által leírt érték.

country_codeKarakterláncKötelező

Országkód.

Korlátozások
pattern
"^[A-Z]{2}$"
environmentKarakterláncKötelező

A rekordhoz csatolt környezeti adatok.

Korlátozások
enum
["live", "sandbox"]
kindKarakterláncKötelező

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

Korlátozások
enum
["locker", "pickup_point"]
location_descriptionKarakterlánc nullKötelező

Leírás a kiválasztott nyelven.

Karakterlánc:maxLength: 1000
nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

minLength: 1maxLength: 160
opening_hoursKarakterlánc nullKötelező

Opening hours

Karakterlánc:maxLength: 500
operatorKarakterláncKötelező

Az erőforrás neve az adott környezetben.

minLength: 1maxLength: 63
verified_atKarakterláncKötelező

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

format: "date-time"

További mezők: Nem

ApiResponse[list[DeliveryData]]

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · Kérd le a kiosztott egységeket kódok nélkül. A visszatérítés csak az érintett rendelési sorok hozzáférését veszi el.
dataTömb <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > Kötelező

A sikeres válasz adatai.

Példa: [{"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 Kötelező

A válasz metaadatai.

Példa: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

További mezők: Nem

DeliveryData

shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · Kérd le a kiosztott egységeket kódok nélkül. A visszatérítés csak az érintett rendelési sorok hozzáférését veszi el.
can_downloadLogikai értékKötelező

Letöltés (true / false)

Példa: true
content_stateKarakterláncKötelező

Tartalomállapot: present / deleting / deleted.

Példa: "present"
delete_due_atKarakterlánc nullKötelező

Ütemezett fájltörlés; null kikapcsolja.

Karakterlánc:format: "date-time"
Példa: null
filenameKarakterlánc nullKötelező

Fájl

Példa: null
first_available_atKarakterlánc nullKötelező

A vásárlás első hozzáférése; a csere nem indítja újra a határidőt.

Karakterlánc:format: "date-time"
Példa: "2026-11-03T12:00:00Z"
generationEgész számKötelező

A kiosztás generációja; cserekor növekszik.

Példa: 1
idKarakterláncKötelező

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

format: "uuid"
Példa: "00000000-0000-4000-8000-000000000005"
kindKarakterlánc nullKötelező

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

Példa: "code"
line_idKarakterláncKötelező

A rendelési tétel állandó azonosítója.

Példa: "line-example"
order_idKarakterláncKötelező

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

Példa: "order-example"
payload_idKarakterláncKötelező

Tartalomazonosító; nem nyilvános letöltési URL.

format: "uuid"
Példa: "00000000-0000-4000-8000-000000000012"
product_idKarakterláncKötelező

Termékazonosító.

Példa: "example"
reasonKarakterláncKötelező

A módosításhoz rögzített indok.

Példa: ""
size_bytesEgész szám nullKötelező

Méret bájtban

Példa: null
stateKarakterláncKötelező

Állapot

Példa: "available"
unit_idKarakterláncKötelező

Egy egyedi kód vagy fájl azonosítója.

format: "uuid"
Példa: "00000000-0000-4000-8000-000000000011"
unit_ordinalEgész számKötelező

A vásárolt egység sorszáma a rendelési sorban.

Példa: 1
variant_idKarakterlánc nullKötelező

Termékvariáns-azonosító.

Példa: null
versionEgész számKötelező

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

Példa: 2

További mezők: Nem

Számlaadatok

InvoiceData · Séma · Adatsémák: Rendelések
address_line_1Karakterlánc nullKötelező

A cím első sora.

address_line_2Karakterlánc nullKötelező

További címadatok.

cityKarakterlánc nullKötelező

Város vagy település.

company_nameKarakterlánc nullKötelező

Cégnév.

country_codeKarakterlánc nullKötelező

Országkód.

house_numberKarakterlánc nullKötelező

Épület- vagy házszám.

postal_codeKarakterlánc nullKötelező

Irányítószám.

regionKarakterlánc nullKötelező

Közigazgatási régió.

streetKarakterlánc nullKötelező

Utcanév.

tax_identifierKarakterlánc nullKötelező

Adóazonosító szám.

tax_schemeKarakterlánc nullKötelező

Adószámítási séma.

További mezők: Nem

Nettó összeg / Adó összege / Bruttó összeg

OrderAmountBreakdownData · Az összegek és adókulcsok a mentett rendelésből származnak, a tételjavításokkal együtt. A hiányzó előzmény null, és nem helyettesíthető a katalógus aktuális adókulcsaival. Az összegek decimális karakterláncok maradnak.
grossMoneyData Kötelező

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

Példa: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullKötelező

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

Példa: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullKötelező

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

Példa: {"amount":"58.60","currency":"PLN","minor_units":2}

További mezők: Nem

Szállítás · Kedvezmények

OrderDeliveryDiscountData · Az összegek és adókulcsok a mentett rendelésből származnak, a tételjavításokkal együtt. A hiányzó előzmény null, és nem helyettesíthető a katalógus aktuális adókulcsaival. Az összegek decimális karakterláncok maradnak.
amountMoneyData Kötelező

Bruttó összeg · Szállítás · Kedvezmények.

Példa: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idKarakterláncKötelező

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

Példa: "saved-coupon"
codeKarakterlánc nullKötelező

Stabil, géppel feldolgozható kód.

Példa: "SAVE"
kindKarakterláncKötelező

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

Korlátozások
enum
["coupon", "promotion"]
Példa: "coupon"
nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "Saved coupon"
sequenceEgész szám nullKötelező

Pozíció a rendezett gyűjteményben.

Példa: 1
versionEgész számKötelező

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

Példa: 3

További mezők: Nem

Lekérés — Rendelések — Válasz

OrderDetailData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"
Példa: "2026-10-19T10:00:00Z"
customerCustomerData Kötelező

Az erőforráshoz rögzített ügyféladatok.

Példa: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Kötelező

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

Példa: {"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 Kötelező

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

Példa: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsTömb <OrderDiscountData > Kötelező

Kedvezmények

Példa: [{"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}]
idKarakterláncKötelező

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

Példa: "order-0000"
invoiceInvoiceData nullKötelező

Számlaadatok.

Példa: null
invoice_requestedLogikai értékKötelező

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

Példa: false
lifecycle_stateOrderLifecycleState Kötelező

Az üzleti életciklus állapota.

Példa: "placed"
linesTömb <OrderLineData > Kötelező

A rendelési tételek pillanatfelvételei.

Példa: [{"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":[]}]
localeKarakterláncKötelező

A kéréshez kiválasztott nyelv.

Példa: "pl"
market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

Példa: "market-pl"
numberKarakterláncKötelező

A rendelés vagy bejelentés felhasználóknak szánt száma.

Példa: "0001"
paymentPaymentData Kötelező

A rendeléshez rögzített fizetési adatok.

Példa: {"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 nullKötelező

Átvételi pont

Példa: null
prices_include_taxLogikai értékKötelező

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

Példa: true
shipping_addressAddressData nullKötelező

Szállítási cím.

Példa: null
shipping_discount_amountMoneyData Kötelező

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

Példa: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Kötelező

Az adott művelet által elfogadott állapot.

Példa: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Kötelező

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

Példa: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Kötelező

Adóadatok.

Példa: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Kötelező

Adócsoportok · source + tax_rate; unallocated_tax.

Példa: {"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_codeKarakterlánc nullKötelező

Adózási ország · Mentett rendelési adatok · ISO 3166-1 alpha-2; null.

Példa: "PL"
totalMoneyData Kötelező

Teljes összeg.

Példa: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Kötelező

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

Példa: {"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}}}

További mezők: Nem

OrderFileData

OrderFileData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai. Az upload_id létrehozása után küldje a fájlokat multipart/form-data formátumban, majd rendelje a termékhez. A letöltéshez Bearer-token és a category szerinti jogosultság szükséges; a válasz a fájl bájtjait tartalmazza nyilvános cím és jelszó nélkül. A mode=period esetén days (1–3650) vagy a korábbi months adható meg, egyszerre mindkettő nem. A feltételek vásárláskor rögzülnek; a visszatérítés csak az érintett tétel hozzáférését vonja vissza.
can_downloadLogikai értékKötelező

Letöltés (true / false)

Példa: true
categoryFileCategory Kötelező

Fájlkategória: internal / customer_document / digital

Példa: "digital"
filenameKarakterláncKötelező

Fájl

Példa: "manual.pdf"
idKarakterláncKötelező

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

Példa: "example"
labelKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "Manual"
line_idKarakterláncKötelező

A rendelési tétel állandó azonosítója.

Példa: "example"
mime_typeKarakterláncKötelező

A média tartalomtípusa.

Példa: "application/pdf"
product_idKarakterláncKötelező

Termékazonosító.

Példa: "example"
purchase_idKarakterláncKötelező

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

Példa: "00000000-0000-4000-8000-000000000001"
reasonKarakterláncKötelező

A módosításhoz rögzített indok.

Példa: "paid"
sha256KarakterláncKötelező

SHA-256 (hex, 64)

Példa: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesEgész számKötelező

Méret bájtban

minimum: 1maximum: 262144000
Példa: 46
source_file_idKarakterláncKötelező

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

Példa: "00000000-0000-4000-8000-000000000001"
source_version_idKarakterláncKötelező

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

Példa: "00000000-0000-4000-8000-000000000001"
source_version_numberEgész számKötelező

Verzió

minimum: 1
Példa: 1
stateKarakterláncKötelező

Állapot

Példa: "active"

További mezők: Nem

OrderFileListData

OrderFileListData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai. Az upload_id létrehozása után küldje a fájlokat multipart/form-data formátumban, majd rendelje a termékhez. A letöltéshez Bearer-token és a category szerinti jogosultság szükséges; a válasz a fájl bájtjait tartalmazza nyilvános cím és jelszó nélkül. A mode=period esetén days (1–3650) vagy a korábbi months adható meg, egyszerre mindkettő nem. A feltételek vásárláskor rögzülnek; a visszatérítés csak az érintett tétel hozzáférését vonja vissza.
filesTömb <OrderFileData > Kötelező

Termékfájlok

Példa: [{"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_pendingLogikai értékKötelező

Hozzáférés a jövőbeli fájlokhoz vásárlás után · updates_pending

Példa: false

További mezők: Nem

A kép metaadatai és URL-je

OrderImageData · Séma · Adatsémák: Rendelések
altKarakterlánc nullKötelező

A kép alternatív szövege.

sourceKarakterláncNem kötelező

A rögzített tevékenység forrása.

const: "current_catalog"
Alapértelmezett: "current_catalog"
urlKarakterláncKötelező

Az erőforrás URL-je.

További mezők: Nem

Az üzleti életciklus állapota

OrderLifecycleState · Séma · Adatsémák: Rendelések Karakterlánc
Korlátozások
enum
["placed", "cancelled", "fulfilled", "returned"]

További mezők: Igen

A rendelési tételek pillanatfelvételei

OrderLineData · Séma · Adatsémák: Rendelések
discount_amountMoneyData Kötelező

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

Példa: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Kötelező

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

Példa: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullKötelező

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

Példa: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullKötelező

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

Példa: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsTömb <OrderDiscountData > Kötelező

Kedvezmények · net / tax / gross.

Példa: [{"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}]
identifiersObjektumTovábbi mezők: KarakterláncKötelező

A termék azonosítókódjai.

Példa: {}
imageOrderImageData nullKötelező

A kép metaadatai és URL-je.

Példa: null
line_idKarakterláncKötelező

A rendelési tétel állandó azonosítója.

Példa: "saved-line-a"
manual_discountOrderManualDiscountData nullKötelező

Kézi kedvezmény; null.

Példa: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "Saved A"
original_totalMoneyData Kötelező

Teljes összeg.

Példa: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Kötelező

Bruttó összeg · Termékek · Kedvezmények előtt; Ismeretlen: null; ismert nulla: 0.

Példa: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullKötelező

Nettó összeg · Termékek · Kedvezmények előtt; Ismeretlen: null; ismert nulla: 0.

Példa: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullKötelező

Adó összege · Termékek · Kedvezmények előtt; Ismeretlen: null; ismert nulla: 0.

Példa: {"amount":"46.00","currency":"PLN","minor_units":2}
positionEgész számKötelező

Pozíció a rendezett gyűjteményben.

Példa: 1
product_idKarakterláncKötelező

Termékazonosító.

Példa: "product-api"
quantityEgész számKötelező

Egységek száma.

Példa: 2
skuKarakterláncKötelező

Készletnyilvántartási cikkszám.

Példa: "A"
taxMoneyData nullKötelező

Adó összege · Egy egység · Mentett rendelési adatok; tax ≠ unit_tax; Ismeretlen: null; ismert nulla: 0.

Példa: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idKarakterlánc nullKötelező

Adókategória azonosítója · Mentett rendelési adatok; null.

Példa: "standard"
tax_category_nameKarakterlánc nullKötelező

Adókategória mentett neve; null.

Példa: "VAT 23%"
tax_rateKarakterlánc nullKötelező

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

Példa: "0.23"
totalMoneyData Kötelező

Teljes összeg.

Példa: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Kötelező

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

Példa: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullKötelező

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

Példa: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullKötelező

Adó összege · Termékek · Kedvezmények után · Mentett rendelési adatok; Ismeretlen: null; ismert nulla: 0.

Példa: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Kötelező

Bruttó összeg · Egy egység · Kedvezmények előtt; Ismeretlen: null; ismert nulla: 0.

Példa: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullKötelező

Nettó összeg · Egy egység · Kedvezmények előtt; Ismeretlen: null; ismert nulla: 0.

Példa: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Kötelező

Egy egység ára.

Példa: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullKötelező

Adó összege · Egy egység · Kedvezmények előtt; Ismeretlen: null; ismert nulla: 0.

Példa: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idKarakterlánc nullKötelező

Termékvariáns-azonosító.

Példa: null
variant_optionsTömb <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Kötelező

A termékhez vagy pillanatfelvételhez kapcsolódó variánsopciók.

Példa: []

További mezők: Nem

Kézi kedvezmény

OrderManualDiscountData · Az összegek és adókulcsok a mentett rendelésből származnak, a tételjavításokkal együtt. A hiányzó előzmény null, és nem helyettesíthető a katalógus aktuális adókulcsaival. Az összegek decimális karakterláncok maradnak.
amountMoneyData Kötelező

Bruttó összeg · Kézi kedvezmény · Mentett rendelési adatok.

Példa: {"amount":"12.30","currency":"PLN","minor_units":2}
kindKarakterláncKötelező

Kedvezmény típusa: percentage / fixed.

Korlátozások
enum
["percentage", "fixed"]
Példa: "fixed"
valueKarakterláncKötelező

Beállított érték: percentage "10" = 10%; fixed = Bruttó összeg.

Példa: "12.30"

További mezők: Nem

Az adott művelet által elfogadott állapot

OrderPaymentStatus · Séma · Adatsémák: Rendelések Karakterlánc
Korlátozások
enum
["unpaid", "paid", "failed", "refunded"]

További mezők: Igen

OrderReleaseData

OrderReleaseData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai. Az upload_id létrehozása után küldje a fájlokat multipart/form-data formátumban, majd rendelje a termékhez. A letöltéshez Bearer-token és a category szerinti jogosultság szükséges; a válasz a fájl bájtjait tartalmazza nyilvános cím és jelszó nélkül. A mode=period esetén days (1–3650) vagy a korábbi months adható meg, egyszerre mindkettő nem. A feltételek vásárláskor rögzülnek; a visszatérítés csak az érintett tétel hozzáférését vonja vissza.
access_reasonKarakterláncKötelező

Hozzáférés vásárlás után · A módosításhoz rögzített indok.

Példa: "paid"
access_stateKarakterláncKötelező

Hozzáférés vásárlás után · Állapot

Példa: "active"
current_releaseCurrentReleaseData nullKötelező

Digitális kiadások · current_release

Példa: null
grant_reasonKarakterláncKötelező

Hozzáférés vásárlás után · A módosításhoz rögzített indok.

Példa: "purchase"
granted_atKarakterláncKötelező

Hozzáférés vásárlás után · UTC

format: "date-time"
Példa: "2026-01-01T12:00:00Z"
idKarakterláncKötelező

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

Példa: "example"
line_idKarakterláncKötelező

A rendelési tétel állandó azonosítója.

Példa: "example"
manifest_sha256KarakterláncKötelező

Digitális kiadások · SHA-256

Példa: "1111111111111111111111111111111111111111111111111111111111111111"
product_idKarakterláncKötelező

Termékazonosító.

Példa: "example"
published_atKarakterláncKötelező

Kiadás közzététele · UTC

format: "date-time"
Példa: "2026-01-01T12:00:00Z"
purchase_idKarakterláncKötelező

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

Példa: "00000000-0000-4000-8000-000000000001"
release_idKarakterláncKötelező

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

Példa: "00000000-0000-4000-8000-000000000001"
release_sequenceEgész számKötelező

Digitális kiadások · Pozíció a rendezett gyűjteményben.

Példa: 1
update_daysEgész szám nullKötelező

Napok száma (days; null)

Példa: 365
update_modeKarakterláncKötelező

Hozzáférés a jövőbeli fájlokhoz vásárlás után: none / period / unlimited

Példa: "period"
update_monthsEgész szám nullKötelező

Hónapok (months; null)

Példa: null
updates_untilKarakterlánc nullKötelező

Hozzáférés a jövőbeli fájlokhoz vásárlás után · UTC

Karakterlánc:format: "date-time"
Példa: "2027-01-01T12:00:00Z"
version_labelKarakterláncKötelező

Verzió

Példa: "1.0"

További mezők: Nem

OrderReleaseListData

OrderReleaseListData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai. Az upload_id létrehozása után küldje a fájlokat multipart/form-data formátumban, majd rendelje a termékhez. A letöltéshez Bearer-token és a category szerinti jogosultság szükséges; a válasz a fájl bájtjait tartalmazza nyilvános cím és jelszó nélkül. A mode=period esetén days (1–3650) vagy a korábbi months adható meg, egyszerre mindkettő nem. A feltételek vásárláskor rögzülnek; a visszatérítés csak az érintett tétel hozzáférését vonja vissza.
releasesTömb <OrderReleaseData > Kötelező

Digitális kiadások

Példa: [{"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_pendingLogikai értékKötelező

Hozzáférés a jövőbeli fájlokhoz vásárlás után · updates_pending

Példa: false

További mezők: Nem

Az adott művelet által elfogadott állapot

OrderStatusData · Séma · Adatsémák: Rendelések
idKarakterláncKötelező

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

Példa: "status-0"
nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "Status 0"
updated_atKarakterláncKötelező

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

format: "date-time"
Példa: "2026-10-19T10:00:00Z"
versionEgész számKötelező

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

Példa: 1

További mezők: Nem

Listázás · Állapotok — Rendelések — Válasz

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"
Példa: "2026-01-01T12:00:00Z"
idKarakterláncKötelező

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

Példa: "status-0"
is_initialLogikai értékKötelező

Jelzi, hogy ez a kezdeti állapot-e.

Példa: true
nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "New"
positionEgész számKötelező

Pozíció a rendezett gyűjteményben.

Példa: 0

További mezők: Nem

Listázás · Állapotok — Rendelések — Válasz

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
dataTömb <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Kötelező

Példaválasz · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Példa: [{"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 Kötelező

A válasz metaadatai.

Példa: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

További mezők: Nem

Módosítás · Állapot — Rendelések — Kérés törzse

OrderStatusUpdate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1maximum: 9223372036854775807
Példa: 1
status_idKarakterláncKötelező

A megfelelő állapotszótárból kapott azonosító.

Korlátozások
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Példa: "status-1"

További mezők: Nem

Listázás — Rendelések — Válasz

OrderSummaryData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"
Példa: "2026-10-19T10:00:00Z"
customerCustomerData Kötelező

Az erőforráshoz rögzített ügyféladatok.

Példa: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Kötelező

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

Példa: {"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 Kötelező

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

Példa: {"amount":"24.60","currency":"PLN","minor_units":2}
idKarakterláncKötelező

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

Példa: "order-0000"
lifecycle_stateOrderLifecycleState Kötelező

Az üzleti életciklus állapota.

Példa: "placed"
localeKarakterláncKötelező

A kéréshez kiválasztott nyelv.

Példa: "pl"
market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

Példa: "market-pl"
numberKarakterláncKötelező

A rendelés vagy bejelentés felhasználóknak szánt száma.

Példa: "0001"
paymentPaymentData Kötelező

A rendeléshez rögzített fizetési adatok.

Példa: {"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_taxLogikai értékKötelező

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

Példa: true
shipping_discount_amountMoneyData Kötelező

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

Példa: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Kötelező

Az adott művelet által elfogadott állapot.

Példa: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Kötelező

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

Példa: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Kötelező

Adóadatok.

Példa: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeKarakterlánc nullKötelező

Adózási ország · Mentett rendelési adatok · ISO 3166-1 alpha-2; null.

Példa: "PL"
totalMoneyData Kötelező

Teljes összeg.

Példa: {"amount":"329.40","currency":"PLN","minor_units":2}

További mezők: Nem

Rendelés · Adócsoportok

OrderTaxBreakdownData · Az összegek és adókulcsok a mentett rendelésből származnak, a tételjavításokkal együtt. A hiányzó előzmény null, és nem helyettesíthető a katalógus aktuális adókulcsaival. Az összegek decimális karakterláncok maradnak.
groupsTömb <OrderTaxGroupData > Kötelező

Adócsoportok · source + tax_rate; Ismeretlen: null; ismert nulla: 0.

Példa: [{"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 Kötelező

Fel nem osztott adó = order.tax − Σ groups.tax; ±.

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}

További mezők: Nem

Adócsoportok

OrderTaxGroupData · Az összegek és adókulcsok a mentett rendelésből származnak, a tételjavításokkal együtt. A hiányzó előzmény null, és nem helyettesíthető a katalógus aktuális adókulcsaival. Az összegek decimális karakterláncok maradnak.
grossMoneyData Kötelező

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

Példa: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullKötelező

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

Példa: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceKarakterláncKötelező

Forrás: products (Termékek), shipping (Szállítás).

Korlátozások
enum
["products", "shipping"]
Példa: "products"
taxMoneyData nullKötelező

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

Példa: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateKarakterlánc nullKötelező

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

Példa: "0.23"

További mezők: Nem

Rendelés · Összesítések

OrderTotalsData · Az összegek és adókulcsok a mentett rendelésből származnak, a tételjavításokkal együtt. A hiányzó előzmény null, és nem helyettesíthető a katalógus aktuális adókulcsaival. Az összegek decimális karakterláncok maradnak.
before_discountsOrderAmountBreakdownData Kötelező

Rendelés · Kedvezmények előtt · net / tax / gross.

Példa: {"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 Kötelező

Kedvezmények · net / tax / gross.

Példa: {"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 Kötelező

Rendelés · Kedvezmények után · net / tax / gross.

Példa: {"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 Kötelező

Termékek · Kedvezmények · net / tax / gross.

Példa: {"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 Kötelező

Termékek · Kedvezmények után · net / tax / gross.

Példa: {"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 Kötelező

Termékek · Kedvezmények előtt · net / tax / gross.

Példa: {"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 Kötelező

Szállítás · Kedvezmények után · net / tax / gross.

Példa: {"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 Kötelező

Szállítás · Kedvezmények előtt · net / tax / gross.

Példa: {"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 Kötelező

Szállítás · Kedvezmények · net / tax / gross.

Példa: {"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}}

További mezők: Nem

A termékhez vagy pillanatfelvételhez kapcsolódó variánsopciók

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Séma · Adatsémák: Rendelések
nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

valueKarakterláncKötelező

A környező séma által leírt érték.

További mezők: Nem

OrderDiscountData

OrderDiscountData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
amountMoneyData Kötelező

Bruttó összeg · Termékek · Kedvezmények.

Példa: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idKarakterláncKötelező

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

Példa: "saved-coupon"
codeKarakterlánc nullKötelező

Stabil, géppel feldolgozható kód.

Példa: "SAVE"
kindKarakterláncKötelező

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

Korlátozások
enum
["coupon", "promotion"]
Példa: "coupon"
nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "Saved coupon"
sequenceEgész szám nullNem kötelező

Alkalmazás sorrendje; null.

Példa: 1
shipping_amountMoneyData nullNem kötelező

Bruttó összeg · Szállítás · Kedvezmények; null.

Példa: {"amount":"24.60","currency":"PLN","minor_units":2}
versionEgész számKötelező

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

Példa: 3

További mezők: Nem

A rendeléshez rögzített fizetési adatok

PaymentData · Séma · Adatsémák: Rendelések
amountMoneyData Kötelező

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

Példa: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentKarakterláncKötelező

A rekordhoz csatolt környezeti adatok.

Korlátozások
enum
["live", "sandbox"]
Példa: "live"
method_codeKarakterlánc nullKötelező

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

Példa: "payment-old"
method_nameKarakterlánc nullKötelező

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

Példa: "Historic method"
paid_atKarakterlánc nullKötelező

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

Karakterlánc:format: "date-time"
Példa: null
statusOrderPaymentStatus Kötelező

Az adott művelet által elfogadott állapot.

Példa: "unpaid"
updated_atKarakterláncKötelező

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

format: "date-time"
Példa: "2026-10-19T10:00:00Z"
versionEgész számKötelező

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

Példa: 0

További mezők: Nem

Módosítás · Fizetési állapot — Rendelések — Kérés törzse

PaymentStatusUpdate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 0maximum: 9223372036854775807
Példa: 0
reasonKarakterláncKötelező

A módosításhoz rögzített indok.

minLength: 1maxLength: 500
Példa: "Bank transfer confirmed"
statusPaymentStatus Kötelező

Az adott művelet által elfogadott állapot. unpaid: kifizetetlen; paid: kifizetve; failed: sikertelen fizetés; refunded: visszatérítve.

Példa: "paid"

További mezők: Nem

Az adott művelet által elfogadott állapot

PaymentStatus · Séma · Adatsémák: Rendelések Karakterlánc
Korlátozások
enum
["unpaid", "paid", "failed", "refunded"]

További mezők: Igen

PickupPointAddressData

PickupPointAddressData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
address_line_1KarakterláncKötelező

A cím első sora.

minLength: 1maxLength: 240
cityKarakterláncKötelező

Város vagy település.

minLength: 1maxLength: 160
postal_codeKarakterláncKötelező

Irányítószám.

minLength: 1maxLength: 32

További mezők: Nem

PickupPointCoordinatesData

PickupPointCoordinatesData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
latitudeSzámKötelező

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeSzámKötelező

WGS84 λ (°)

minimum: -180.0maximum: 180.0

További mezők: Nem

PickupPointData

PickupPointData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
address_line1KarakterláncKötelező

A cím első sora.

cityKarakterláncKötelező

Város vagy település.

codeKarakterláncKötelező

Stabil, géppel feldolgozható kód.

country_codeKarakterláncKötelező

Országkód.

kindKarakterláncKötelező

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

Korlátozások
enum
["locker", "pickup_point"]
latitudeSzám nullKötelező

WGS84 φ (°)

location_descriptionKarakterlánc nullKötelező

Leírás a kiválasztott nyelven.

longitudeSzám nullKötelező

WGS84 λ (°)

nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

opening_hoursKarakterlánc nullKötelező

Opening hours

operatorKarakterláncKötelező

Az erőforrás neve az adott környezetben.

postal_codeKarakterláncKötelező

Irányítószám.

További mezők: Nem

PickupPointSummaryData

PickupPointSummaryData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
codeKarakterláncKötelező

Stabil, géppel feldolgozható kód.

Korlátozások
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeKarakterláncKötelező

Országkód.

Korlátozások
pattern
"^[A-Z]{2}$"
environmentKarakterláncKötelező

A rekordhoz csatolt környezeti adatok.

Korlátozások
enum
["live", "sandbox"]
kindKarakterláncKötelező

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

Korlátozások
enum
["locker", "pickup_point"]
operatorKarakterláncKötelező

Az erőforrás neve az adott környezetben.

minLength: 1maxLength: 63

További mezők: Nem

Az erőforráshoz rögzített ügyféladatok

RequestCustomerData · Séma · Adatsémák: Rendelések
emailKarakterláncKötelező

E-mail-cím.

Példa: "customer@example.invalid"
nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "Example"

További mezők: Nem

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

ShippingData · Séma · Adatsémák: Rendelések
amountMoneyData Kötelező

A rendelésben MoneyData formában rögzített bruttó szállítási összeg. A későbbi adóváltozások ezt a korábbi összeget nem módosítják.

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Kötelező

Feladási és kézbesítési dátumok. A rendeléslista és a részletek tartalmazzák a delivery.dates objektumot. A YYYY-MM-DD dátumok tervezettek, nem igazolják a feladást. Az aktuális dátumok elsőbbséget élveznek; a régebbi rendelések a mentett becslést használják. A törölt vagy ismeretlen érték null. A részletek minden tételt és termékképet is tartalmaznak.

Példa: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
method_codeKarakterlánc nullKötelező

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

Példa: "shipping-old"
method_nameKarakterlánc nullKötelező

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

Példa: "Historic carrier"
pickup_pointPickupPointSummaryData nullKötelező

Átvételi pont

Példa: null
recipient_modeKarakterláncKötelező

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

Korlátozások
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Példa: "full_address"

További mezők: Nem

ShippingDetailData

ShippingDetailData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
amountMoneyData Kötelező

A rendelésben MoneyData formában rögzített bruttó szállítási összeg. A későbbi adóváltozások ezt a korábbi összeget nem módosítják.

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Kötelező

Feladási és kézbesítési dátumok. A rendeléslista és a részletek tartalmazzák a delivery.dates objektumot. A YYYY-MM-DD dátumok tervezettek, nem igazolják a feladást. Az aktuális dátumok elsőbbséget élveznek; a régebbi rendelések a mentett becslést használják. A törölt vagy ismeretlen érték null. A részletek minden tételt és termékképet is tartalmaznak.

Példa: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
discount_grossMoneyData Kötelező

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

Példa: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullKötelező

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

Példa: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullKötelező

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

Példa: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsTömb <OrderDeliveryDiscountData > nullKötelező

Szállítás · Kedvezmények; []: 0; null: Ismeretlen: null; ismert nulla: 0.

Példa: [{"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 Kötelező

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

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeKarakterlánc nullKötelező

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

Példa: "shipping-old"
method_nameKarakterlánc nullKötelező

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

Példa: "Historic carrier"
netMoneyData nullKötelező

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

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Kötelező

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

Példa: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullKötelező

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

Példa: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullKötelező

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

Példa: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullKötelező

Átvételi pont

Példa: null
recipient_modeKarakterláncKötelező

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

Korlátozások
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Példa: "full_address"
taxMoneyData nullKötelező

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

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idKarakterlánc nullKötelező

Adókategória azonosítója · Mentett rendelési adatok; null.

Példa: "standard"
tax_category_nameKarakterlánc nullKötelező

Adókategória mentett neve; null.

Példa: "VAT 23%"
tax_rateKarakterlánc nullKötelező

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

Példa: "0.23"

További mezők: Nem