Mine sisu juurde
ShopentlyLearn
Eesti

Andmeskeemid: Tellimused

Andmeskeemid: Tellimused. API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

Andmeskeemid

Tarneaadress

AddressData · Skeem · Andmeskeemid: Tellimused
address_line_1String nullKohustuslik

Esimene aadressirida.

address_line_2String nullKohustuslik

Täiendav aadressiteave.

cityString nullKohustuslik

Linn või asula.

country_codeString nullKohustuslik

Riigikood.

first_nameString nullKohustuslik

Eesnimi.

house_numberString nullKohustuslik

Hoone või maja number.

last_nameString nullKohustuslik

Perekonnanimi.

phoneString nullKohustuslik

Telefoninumber.

postal_codeString nullKohustuslik

Postiindeks.

regionString nullKohustuslik

Halduspiirkond.

streetString nullKohustuslik

Tänavanimi.

Lisaväljad: Ei

ApiResponse_OrderFileListData_

ApiResponse_OrderFileListData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud. Pärast upload_id loomist saatke failid multipart/form-data kujul ja siduge need tootega. Allalaadimine nõuab Bearer-tokenit ja category õigust; vastus sisaldab faili baite ilma avaliku aadressi ja paroolita. Kui mode=period, valige days (1–3650) või senine months, mitte mõlemad. Tingimused salvestatakse ostul; tagasimakse eemaldab juurdepääsu ainult tagastatud tellimusrealt.
dataOrderFileListData Kohustuslik

Eduka vastuse andmed.

Näide: {"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 Kohustuslik

Vastuse metaandmed.

Näide: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

ApiResponse_OrderReleaseListData_

ApiResponse_OrderReleaseListData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud. Pärast upload_id loomist saatke failid multipart/form-data kujul ja siduge need tootega. Allalaadimine nõuab Bearer-tokenit ja category õigust; vastus sisaldab faili baite ilma avaliku aadressi ja paroolita. Kui mode=period, valige days (1–3650) või senine months, mitte mõlemad. Tingimused salvestatakse ostul; tagasimakse eemaldab juurdepääsu ainult tagastatud tellimusrealt.
dataOrderReleaseListData Kohustuslik

Eduka vastuse andmed.

Näide: {"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 Kohustuslik

Vastuse metaandmed.

Näide: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Loend — Tellimused — Vastus

ApiResponse_list_OrderSummaryData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
dataMassiiv <OrderSummaryData > Kohustuslik

Vastuse näide · ApiResponse_list_OrderSummaryData__.

Näide: [{"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 Kohustuslik

Vastuse metaandmed.

Näide: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Hangi — Tellimused — Vastus

ApiResponse_OrderDetailData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
dataOrderDetailData Kohustuslik

Vastuse näide · OrderDetailData.

Näide: {"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 Kohustuslik

Vastuse metaandmed.

Näide: {"request_id":"example-request"}

Lisaväljad: Ei

CurrentReleaseData

CurrentReleaseData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud. Pärast upload_id loomist saatke failid multipart/form-data kujul ja siduge need tootega. Allalaadimine nõuab Bearer-tokenit ja category õigust; vastus sisaldab faili baite ilma avaliku aadressi ja paroolita. Kui mode=period, valige days (1–3650) või senine months, mitte mõlemad. Tingimused salvestatakse ostul; tagasimakse eemaldab juurdepääsu ainult tagastatud tellimusrealt.
acquiredTõeväärtusKohustuslik

Juurdepääs pärast ostu (true / false)

changelogStringKohustuslik

Muudatuste kirjeldus

covered_by_purchaseTõeväärtusKohustuslik

Juurdepääs pärast ostu (true / false)

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

published_atStringKohustuslik

Avalda väljalase · UTC

format: "date-time"
requires_new_purchaseTõeväärtusKohustuslik

Pärast ostu lisatud failidele juurdepääs puudub · requires_new_purchase

sequenceTäisarvKohustuslik

Asukoht järjestatud kogumis.

version_labelStringKohustuslik

Versioon

Lisaväljad: Ei

Selle ressursi juurde salvestatud klienditeave

CustomerData · Skeem · Andmeskeemid: Tellimused
emailStringKohustuslik

E-posti aadress.

Näide: "customer@example.invalid"
first_nameString nullKohustuslik

Eesnimi.

Näide: "Example"
last_nameString nullKohustuslik

Perekonnanimi.

Näide: "Example"
phoneString nullKohustuslik

Telefoninumber.

Näide: null

Lisaväljad: Ei

DeliveryContentDeletion

DeliveryContentDeletion · Kustuta sisu jäädavalt ja säilita ajalugu. Kood ei muutu uuesti müüdavaks.
expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1
Näide: 1
reasonStringKohustuslik

Muudatuse juurde salvestatud põhjus.

minLength: 1maxLength: 500
Näide: "Withdraw a revoked license"

Lisaväljad: Ei

Saatmis- ja tarnekuupäevad

DeliveryDatesData · Tellimuste loend ja üksikasjad sisaldavad delivery.dates. Kuupäevad YYYY-MM-DD on kavandatud ega kinnita saatmist. Praegused kuupäevad on ülimuslikud; vanemad tellimused kasutavad salvestatud hinnangut. Kustutatud või teadmata väärtused on null. Üksikasjad sisaldavad ka kõiki tellimusridu ja tootepilte.
dispatch_timezoneString nullKohustuslik

Saatmise ajavöönd (IANA; null).

Näide: "Europe/Warsaw"
estimated_delivery_fromString nullKohustuslik

Eeldatava tarne algus (YYYY-MM-DD; null).

String:format: "date"
Näide: "2026-10-20"
estimated_delivery_toString nullKohustuslik

Eeldatava tarne lõpp (YYYY-MM-DD; null).

String:format: "date"
Näide: "2026-10-21"
planned_dispatch_onString nullKohustuslik

Kavandatud saatmiskuupäev (YYYY-MM-DD; null).

String:format: "date"
Näide: "2026-10-19"

Lisaväljad: Ei

DeliveryReplacement

DeliveryReplacement · Vali olemasolev vaba ühik. Asendamine ei alusta säilitusaega uuesti.
expected_unit_versionTäisarvKohustuslik

Vaba asendusühiku praegune versioon.

minimum: 1
Näide: 1
expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1
Näide: 1
reasonStringKohustuslik

Muudatuse juurde salvestatud põhjus.

minLength: 1maxLength: 500
Näide: "Replace an invalid activation code"
replacement_unit_idStringKohustuslik

Olemasoleva vaba asendusühiku ID.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000008"

Lisaväljad: Ei

DeliveryPickupPointData

DeliveryPickupPointData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
addressPickupPointAddressData Kohustuslik

Tarneaadress.

codeStringKohustuslik

Püsiv masinloetav kood.

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

Ümbritsevas skeemis kirjeldatud väärtus.

country_codeStringKohustuslik

Riigikood.

Piirangud
pattern
"^[A-Z]{2}$"
environmentStringKohustuslik

Kirjele lisatud keskkonnateave.

Piirangud
enum
["live", "sandbox"]
kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud
enum
["locker", "pickup_point"]
location_descriptionString nullKohustuslik

Kirjeldus valitud keeles.

String:maxLength: 1000
nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 160
opening_hoursString nullKohustuslik

Opening hours

String:maxLength: 500
operatorStringKohustuslik

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 63
verified_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

Lisaväljad: Ei

ApiResponse[list[DeliveryData]]

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · Vaata määratud ühikuid ilma koodideta. Tagasimakse eemaldab ligipääsu ainult vastavatelt tellimusridadelt.
dataMassiiv <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > Kohustuslik

Eduka vastuse andmed.

Näide: [{"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 Kohustuslik

Vastuse metaandmed.

Näide: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Lisaväljad: Ei

DeliveryData

shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · Vaata määratud ühikuid ilma koodideta. Tagasimakse eemaldab ligipääsu ainult vastavatelt tellimusridadelt.
can_downloadTõeväärtusKohustuslik

Laadi alla (true / false)

Näide: true
content_stateStringKohustuslik

Sisu olek: present / deleting / deleted.

Näide: "present"
delete_due_atString nullKohustuslik

Ajastatud faili kustutamine; null lülitab selle välja.

String:format: "date-time"
Näide: null
filenameString nullKohustuslik

Fail

Näide: null
first_available_atString nullKohustuslik

Selle ostu esimene ligipääs; asendus ei alusta tähtaega uuesti.

String:format: "date-time"
Näide: "2026-11-03T12:00:00Z"
generationTäisarvKohustuslik

Väljastuse põlvkond; suureneb asendamisel.

Näide: 1
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000005"
kindString nullKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Näide: "code"
line_idStringKohustuslik

Tellimusrea püsiv tunnus.

Näide: "line-example"
order_idStringKohustuslik

Seotud tellimuse identifikaator.

Näide: "order-example"
payload_idStringKohustuslik

Sisu ID; ei ole avalik allalaadimis-URL.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000012"
product_idStringKohustuslik

Toote identifikaator.

Näide: "example"
reasonStringKohustuslik

Muudatuse juurde salvestatud põhjus.

Näide: ""
size_bytesTäisarv nullKohustuslik

Suurus baitides

Näide: null
stateStringKohustuslik

Olek

Näide: "available"
unit_idStringKohustuslik

Ühe individuaalse koodi või faili ID.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000011"
unit_ordinalTäisarvKohustuslik

Ostetud ühiku number tellimusreal.

Näide: 1
variant_idString nullKohustuslik

Tootevariandi identifikaator.

Näide: null
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 2

Lisaväljad: Ei

Arveteave

InvoiceData · Skeem · Andmeskeemid: Tellimused
address_line_1String nullKohustuslik

Esimene aadressirida.

address_line_2String nullKohustuslik

Täiendav aadressiteave.

cityString nullKohustuslik

Linn või asula.

company_nameString nullKohustuslik

Ettevõtte nimi.

country_codeString nullKohustuslik

Riigikood.

house_numberString nullKohustuslik

Hoone või maja number.

postal_codeString nullKohustuslik

Postiindeks.

regionString nullKohustuslik

Halduspiirkond.

streetString nullKohustuslik

Tänavanimi.

tax_identifierString nullKohustuslik

Maksukohustuslase number.

tax_schemeString nullKohustuslik

Maksuarvestuse skeem.

Lisaväljad: Ei

Netosumma / Maksusumma / Brutosumma

OrderAmountBreakdownData · Summad ja maksumäärad pärinevad salvestatud tellimusest koos reaparandustega. Puuduvad ajaloolised andmed on null ja neid ei asendata kataloogi praeguste määradega. Summad jäävad kümnendstringideks.
grossMoneyData Kohustuslik

Brutosumma · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullKohustuslik

Netosumma · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullKohustuslik

Maksusumma · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"58.60","currency":"PLN","minor_units":2}

Lisaväljad: Ei

Tarne · Allahindlused

OrderDeliveryDiscountData · Summad ja maksumäärad pärinevad salvestatud tellimusest koos reaparandustega. Puuduvad ajaloolised andmed on null ja neid ei asendata kataloogi praeguste määradega. Summad jäävad kümnendstringideks.
amountMoneyData Kohustuslik

Brutosumma · Tarne · Allahindlused.

Näide: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

Näide: "saved-coupon"
codeString nullKohustuslik

Püsiv masinloetav kood.

Näide: "SAVE"
kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud
enum
["coupon", "promotion"]
Näide: "coupon"
nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Saved coupon"
sequenceTäisarv nullKohustuslik

Asukoht järjestatud kogumis.

Näide: 1
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 3

Lisaväljad: Ei

Hangi — Tellimused — Vastus

OrderDetailData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
created_atStringKohustuslik

Loomise aeg.

format: "date-time"
Näide: "2026-10-19T10:00:00Z"
customerCustomerData Kohustuslik

Selle ressursi juurde salvestatud klienditeave.

Näide: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Kohustuslik

Tarneviis ja seotud teave.

Näide: {"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 Kohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

Näide: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsMassiiv <OrderDiscountData > Kohustuslik

Allahindlused

Näide: [{"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}]
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (OrderDetailData).

Näide: "order-0000"
invoiceInvoiceData nullKohustuslik

Arveteave.

Näide: null
invoice_requestedTõeväärtusKohustuslik

Kas arvet sooviti.

Näide: false
lifecycle_stateOrderLifecycleState Kohustuslik

Ärilise elutsükli olek.

Näide: "placed"
linesMassiiv <OrderLineData > Kohustuslik

Tellimusridade hetktõmmised.

Näide: [{"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":[]}]
localeStringKohustuslik

Selle päringu jaoks valitud keel.

Näide: "pl"
market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

Näide: "market-pl"
numberStringKohustuslik

Kasutajale mõeldud tellimuse või pöördumise number.

Näide: "0001"
paymentPaymentData Kohustuslik

Tellimuse juurde salvestatud makseandmed.

Näide: {"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 nullKohustuslik

Väljastuspunkt

Näide: null
prices_include_taxTõeväärtusKohustuslik

Kas loetletud hinnad sisaldavad maksu.

Näide: true
shipping_addressAddressData nullKohustuslik

Tarneaadress.

Näide: null
shipping_discount_amountMoneyData Kohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

Näide: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Kohustuslik

Selle konkreetse toimingu lubatud olek.

Näide: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Kohustuslik

Summa enne vastuses näidatud lisakomponente.

Näide: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Kohustuslik

Maksuteave.

Näide: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Kohustuslik

Maksurühmad · source + tax_rate; unallocated_tax.

Näide: {"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_codeString nullKohustuslik

Maksuriik · Salvestatud tellimusandmed · ISO 3166-1 alpha-2; null.

Näide: "PL"
totalMoneyData Kohustuslik

Kogusumma.

Näide: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Kohustuslik

Kogusummad · net / tax / gross; Enne allahindlusi / Pärast allahindlusi.

Näide: {"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}}}

Lisaväljad: Ei

OrderFileData

OrderFileData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud. Pärast upload_id loomist saatke failid multipart/form-data kujul ja siduge need tootega. Allalaadimine nõuab Bearer-tokenit ja category õigust; vastus sisaldab faili baite ilma avaliku aadressi ja paroolita. Kui mode=period, valige days (1–3650) või senine months, mitte mõlemad. Tingimused salvestatakse ostul; tagasimakse eemaldab juurdepääsu ainult tagastatud tellimusrealt.
can_downloadTõeväärtusKohustuslik

Laadi alla (true / false)

Näide: true
categoryFileCategory Kohustuslik

Faili kategooria: internal / customer_document / digital

Näide: "digital"
filenameStringKohustuslik

Fail

Näide: "manual.pdf"
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

Näide: "example"
labelStringKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Manual"
line_idStringKohustuslik

Tellimusrea püsiv tunnus.

Näide: "example"
mime_typeStringKohustuslik

Meedia sisutüüp.

Näide: "application/pdf"
product_idStringKohustuslik

Toote identifikaator.

Näide: "example"
purchase_idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. · purchase_id

Näide: "00000000-0000-4000-8000-000000000001"
reasonStringKohustuslik

Muudatuse juurde salvestatud põhjus.

Näide: "paid"
sha256StringKohustuslik

SHA-256 (hex, 64)

Näide: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesTäisarvKohustuslik

Suurus baitides

minimum: 1maximum: 262144000
Näide: 46
source_file_idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. · source_file_id

Näide: "00000000-0000-4000-8000-000000000001"
source_version_idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. · source_version_id

Näide: "00000000-0000-4000-8000-000000000001"
source_version_numberTäisarvKohustuslik

Versioon

minimum: 1
Näide: 1
stateStringKohustuslik

Olek

Näide: "active"

Lisaväljad: Ei

OrderFileListData

OrderFileListData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud. Pärast upload_id loomist saatke failid multipart/form-data kujul ja siduge need tootega. Allalaadimine nõuab Bearer-tokenit ja category õigust; vastus sisaldab faili baite ilma avaliku aadressi ja paroolita. Kui mode=period, valige days (1–3650) või senine months, mitte mõlemad. Tingimused salvestatakse ostul; tagasimakse eemaldab juurdepääsu ainult tagastatud tellimusrealt.
filesMassiiv <OrderFileData > Kohustuslik

Toote failid

Näide: [{"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_pendingTõeväärtusKohustuslik

Juurdepääs tulevastele failidele pärast ostu · updates_pending

Näide: false

Lisaväljad: Ei

Pildi metaandmed ja URL

OrderImageData · Skeem · Andmeskeemid: Tellimused
altString nullKohustuslik

Pildi alternatiivtekst.

sourceStringValikuline

Salvestatud tegevuse allikas.

const: "current_catalog"
Vaikeväärtus: "current_catalog"
urlStringKohustuslik

Ressursi URL.

Lisaväljad: Ei

Ärilise elutsükli olek

OrderLifecycleState · Skeem · Andmeskeemid: Tellimused String
Piirangud
enum
["placed", "cancelled", "fulfilled", "returned"]

Lisaväljad: Jah

Tellimusridade hetktõmmised

OrderLineData · Skeem · Andmeskeemid: Tellimused
discount_amountMoneyData Kohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

Näide: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Kohustuslik

Brutosumma · Allahindlused; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullKohustuslik

Netosumma · Allahindlused; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullKohustuslik

Maksusumma · Allahindlused; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsMassiiv <OrderDiscountData > Kohustuslik

Allahindlused · net / tax / gross.

Näide: [{"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}]
identifiersObjektLisaväljad: StringKohustuslik

Toote tuvastuskoodid.

Näide: {}
imageOrderImageData nullKohustuslik

Pildi metaandmed ja URL.

Näide: null
line_idStringKohustuslik

Tellimusrea püsiv tunnus.

Näide: "saved-line-a"
manual_discountOrderManualDiscountData nullKohustuslik

Käsitsi allahindlus; null.

Näide: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Saved A"
original_totalMoneyData Kohustuslik

Kogusumma.

Näide: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Kohustuslik

Brutosumma · Tooted · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullKohustuslik

Netosumma · Tooted · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullKohustuslik

Maksusumma · Tooted · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"46.00","currency":"PLN","minor_units":2}
positionTäisarvKohustuslik

Asukoht järjestatud kogumis.

Näide: 1
product_idStringKohustuslik

Toote identifikaator.

Näide: "product-api"
quantityTäisarvKohustuslik

Ühikute arv.

Näide: 2
skuStringKohustuslik

Laoarvestusühiku kood.

Näide: "A"
taxMoneyData nullKohustuslik

Maksusumma · Üks ühik · Salvestatud tellimusandmed; tax ≠ unit_tax; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idString nullKohustuslik

Maksukategooria tunnus · Salvestatud tellimusandmed; null.

Näide: "standard"
tax_category_nameString nullKohustuslik

Maksukategooria salvestatud nimi; null.

Näide: "VAT 23%"
tax_rateString nullKohustuslik

tax_rate · Salvestatud tellimusandmed: "0.23" = 23%; "0" ≠ null.

Näide: "0.23"
totalMoneyData Kohustuslik

Kogusumma.

Näide: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Kohustuslik

Brutosumma · Tooted · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullKohustuslik

Netosumma · Tooted · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullKohustuslik

Maksusumma · Tooted · Pärast allahindlusi · Salvestatud tellimusandmed; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Kohustuslik

Brutosumma · Üks ühik · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullKohustuslik

Netosumma · Üks ühik · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Kohustuslik

Ühe ühiku hind.

Näide: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullKohustuslik

Maksusumma · Üks ühik · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idString nullKohustuslik

Tootevariandi identifikaator.

Näide: null
variant_optionsMassiiv <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Kohustuslik

Toote või hetktõmmisega seotud variandivalikud.

Näide: []

Lisaväljad: Ei

Käsitsi allahindlus

OrderManualDiscountData · Summad ja maksumäärad pärinevad salvestatud tellimusest koos reaparandustega. Puuduvad ajaloolised andmed on null ja neid ei asendata kataloogi praeguste määradega. Summad jäävad kümnendstringideks.
amountMoneyData Kohustuslik

Brutosumma · Käsitsi allahindlus · Salvestatud tellimusandmed.

Näide: {"amount":"12.30","currency":"PLN","minor_units":2}
kindStringKohustuslik

Allahindluse liik: percentage / fixed.

Piirangud
enum
["percentage", "fixed"]
Näide: "fixed"
valueStringKohustuslik

Seadistatud väärtus: percentage "10" = 10%; fixed = Brutosumma.

Näide: "12.30"

Lisaväljad: Ei

Selle konkreetse toimingu lubatud olek

OrderPaymentStatus · Skeem · Andmeskeemid: Tellimused String
Piirangud
enum
["unpaid", "paid", "failed", "refunded"]

Lisaväljad: Jah

OrderReleaseData

OrderReleaseData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud. Pärast upload_id loomist saatke failid multipart/form-data kujul ja siduge need tootega. Allalaadimine nõuab Bearer-tokenit ja category õigust; vastus sisaldab faili baite ilma avaliku aadressi ja paroolita. Kui mode=period, valige days (1–3650) või senine months, mitte mõlemad. Tingimused salvestatakse ostul; tagasimakse eemaldab juurdepääsu ainult tagastatud tellimusrealt.
access_reasonStringKohustuslik

Juurdepääs pärast ostu · Muudatuse juurde salvestatud põhjus.

Näide: "paid"
access_stateStringKohustuslik

Juurdepääs pärast ostu · Olek

Näide: "active"
current_releaseCurrentReleaseData nullKohustuslik

Digiväljalasked · current_release

Näide: null
grant_reasonStringKohustuslik

Juurdepääs pärast ostu · Muudatuse juurde salvestatud põhjus.

Näide: "purchase"
granted_atStringKohustuslik

Juurdepääs pärast ostu · UTC

format: "date-time"
Näide: "2026-01-01T12:00:00Z"
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

Näide: "example"
line_idStringKohustuslik

Tellimusrea püsiv tunnus.

Näide: "example"
manifest_sha256StringKohustuslik

Digiväljalasked · SHA-256

Näide: "1111111111111111111111111111111111111111111111111111111111111111"
product_idStringKohustuslik

Toote identifikaator.

Näide: "example"
published_atStringKohustuslik

Avalda väljalase · UTC

format: "date-time"
Näide: "2026-01-01T12:00:00Z"
purchase_idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. · purchase_id

Näide: "00000000-0000-4000-8000-000000000001"
release_idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. · release_id

Näide: "00000000-0000-4000-8000-000000000001"
release_sequenceTäisarvKohustuslik

Digiväljalasked · Asukoht järjestatud kogumis.

Näide: 1
update_daysTäisarv nullKohustuslik

Päevade arv (days; null)

Näide: 365
update_modeStringKohustuslik

Juurdepääs tulevastele failidele pärast ostu: none / period / unlimited

Näide: "period"
update_monthsTäisarv nullKohustuslik

Kuud (months; null)

Näide: null
updates_untilString nullKohustuslik

Juurdepääs tulevastele failidele pärast ostu · UTC

String:format: "date-time"
Näide: "2027-01-01T12:00:00Z"
version_labelStringKohustuslik

Versioon

Näide: "1.0"

Lisaväljad: Ei

OrderReleaseListData

OrderReleaseListData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud. Pärast upload_id loomist saatke failid multipart/form-data kujul ja siduge need tootega. Allalaadimine nõuab Bearer-tokenit ja category õigust; vastus sisaldab faili baite ilma avaliku aadressi ja paroolita. Kui mode=period, valige days (1–3650) või senine months, mitte mõlemad. Tingimused salvestatakse ostul; tagasimakse eemaldab juurdepääsu ainult tagastatud tellimusrealt.
releasesMassiiv <OrderReleaseData > Kohustuslik

Digiväljalasked

Näide: [{"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_pendingTõeväärtusKohustuslik

Juurdepääs tulevastele failidele pärast ostu · updates_pending

Näide: false

Lisaväljad: Ei

Selle konkreetse toimingu lubatud olek

OrderStatusData · Skeem · Andmeskeemid: Tellimused
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (OrderStatusData).

Näide: "status-0"
nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Status 0"
updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"
Näide: "2026-10-19T10:00:00Z"
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Loend · Olekud — Tellimused — Vastus

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
created_atStringKohustuslik

Loomise aeg.

format: "date-time"
Näide: "2026-01-01T12:00:00Z"
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Näide: "status-0"
is_initialTõeväärtusKohustuslik

Kas see on algolek.

Näide: true
nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "New"
positionTäisarvKohustuslik

Asukoht järjestatud kogumis.

Näide: 0

Lisaväljad: Ei

Loend · Olekud — Tellimused — Vastus

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
dataMassiiv <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Kohustuslik

Vastuse näide · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Näide: [{"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 Kohustuslik

Vastuse metaandmed.

Näide: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Muuda · Olek — Tellimused — Päringu sisu

OrderStatusUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807
Näide: 1
status_idStringKohustuslik

Vastavast olekusõnastikust saadud identifikaator.

Piirangud
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Näide: "status-1"

Lisaväljad: Ei

Loend — Tellimused — Vastus

OrderSummaryData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
created_atStringKohustuslik

Loomise aeg.

format: "date-time"
Näide: "2026-10-19T10:00:00Z"
customerCustomerData Kohustuslik

Selle ressursi juurde salvestatud klienditeave.

Näide: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Kohustuslik

Tarneviis ja seotud teave.

Näide: {"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 Kohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

Näide: {"amount":"24.60","currency":"PLN","minor_units":2}
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (OrderSummaryData).

Näide: "order-0000"
lifecycle_stateOrderLifecycleState Kohustuslik

Ärilise elutsükli olek.

Näide: "placed"
localeStringKohustuslik

Selle päringu jaoks valitud keel.

Näide: "pl"
market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

Näide: "market-pl"
numberStringKohustuslik

Kasutajale mõeldud tellimuse või pöördumise number.

Näide: "0001"
paymentPaymentData Kohustuslik

Tellimuse juurde salvestatud makseandmed.

Näide: {"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_taxTõeväärtusKohustuslik

Kas loetletud hinnad sisaldavad maksu.

Näide: true
shipping_discount_amountMoneyData Kohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

Näide: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Kohustuslik

Selle konkreetse toimingu lubatud olek.

Näide: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Kohustuslik

Summa enne vastuses näidatud lisakomponente.

Näide: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Kohustuslik

Maksuteave.

Näide: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeString nullKohustuslik

Maksuriik · Salvestatud tellimusandmed · ISO 3166-1 alpha-2; null.

Näide: "PL"
totalMoneyData Kohustuslik

Kogusumma.

Näide: {"amount":"329.40","currency":"PLN","minor_units":2}

Lisaväljad: Ei

Tellimus · Maksurühmad

OrderTaxBreakdownData · Summad ja maksumäärad pärinevad salvestatud tellimusest koos reaparandustega. Puuduvad ajaloolised andmed on null ja neid ei asendata kataloogi praeguste määradega. Summad jäävad kümnendstringideks.
groupsMassiiv <OrderTaxGroupData > Kohustuslik

Maksurühmad · source + tax_rate; Teadmata: null; teadaolev nullväärtus: 0.

Näide: [{"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 Kohustuslik

Jaotamata maks = order.tax − Σ groups.tax; ±.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}

Lisaväljad: Ei

Maksurühmad

OrderTaxGroupData · Summad ja maksumäärad pärinevad salvestatud tellimusest koos reaparandustega. Puuduvad ajaloolised andmed on null ja neid ei asendata kataloogi praeguste määradega. Summad jäävad kümnendstringideks.
grossMoneyData Kohustuslik

Brutosumma · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullKohustuslik

Netosumma · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceStringKohustuslik

Allikas: products (Tooted), shipping (Tarne).

Piirangud
enum
["products", "shipping"]
Näide: "products"
taxMoneyData nullKohustuslik

Maksusumma · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateString nullKohustuslik

tax_rate · Salvestatud tellimusandmed: "0.23" = 23%; "0" ≠ null.

Näide: "0.23"

Lisaväljad: Ei

Tellimus · Kogusummad

OrderTotalsData · Summad ja maksumäärad pärinevad salvestatud tellimusest koos reaparandustega. Puuduvad ajaloolised andmed on null ja neid ei asendata kataloogi praeguste määradega. Summad jäävad kümnendstringideks.
before_discountsOrderAmountBreakdownData Kohustuslik

Tellimus · Enne allahindlusi · net / tax / gross.

Näide: {"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 Kohustuslik

Allahindlused · net / tax / gross.

Näide: {"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 Kohustuslik

Tellimus · Pärast allahindlusi · net / tax / gross.

Näide: {"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 Kohustuslik

Tooted · Allahindlused · net / tax / gross.

Näide: {"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 Kohustuslik

Tooted · Pärast allahindlusi · net / tax / gross.

Näide: {"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 Kohustuslik

Tooted · Enne allahindlusi · net / tax / gross.

Näide: {"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 Kohustuslik

Tarne · Pärast allahindlusi · net / tax / gross.

Näide: {"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 Kohustuslik

Tarne · Enne allahindlusi · net / tax / gross.

Näide: {"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 Kohustuslik

Tarne · Allahindlused · net / tax / gross.

Näide: {"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}}

Lisaväljad: Ei

Toote või hetktõmmisega seotud variandivalikud

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Skeem · Andmeskeemid: Tellimused
nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

valueStringKohustuslik

Ümbritsevas skeemis kirjeldatud väärtus.

Lisaväljad: Ei

OrderDiscountData

OrderDiscountData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
amountMoneyData Kohustuslik

Brutosumma · Tooted · Allahindlused.

Näide: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

Näide: "saved-coupon"
codeString nullKohustuslik

Püsiv masinloetav kood.

Näide: "SAVE"
kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud
enum
["coupon", "promotion"]
Näide: "coupon"
nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Saved coupon"
sequenceTäisarv nullValikuline

Rakendamise järjekord; null.

Näide: 1
shipping_amountMoneyData nullValikuline

Brutosumma · Tarne · Allahindlused; null.

Näide: {"amount":"24.60","currency":"PLN","minor_units":2}
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 3

Lisaväljad: Ei

Tellimuse juurde salvestatud makseandmed

PaymentData · Skeem · Andmeskeemid: Tellimused
amountMoneyData Kohustuslik

payment.amount on tellimuse kogusumma. Makse olek ei määra tasutud, tagastatud ega tasumata summasid.

Näide: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentStringKohustuslik

Kirjele lisatud keskkonnateave.

Piirangud
enum
["live", "sandbox"]
Näide: "live"
method_codeString nullKohustuslik

Tarne- või makseviisi kood.

Näide: "payment-old"
method_nameString nullKohustuslik

Tarne- või makseviisi nimi.

Näide: "Historic method"
paid_atString nullKohustuslik

Kuupäev ja kellaaeg, mil makse märgiti tasutuks.

String:format: "date-time"
Näide: null
statusOrderPaymentStatus Kohustuslik

Selle konkreetse toimingu lubatud olek.

Näide: "unpaid"
updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"
Näide: "2026-10-19T10:00:00Z"
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 0

Lisaväljad: Ei

Muuda · Makse olek — Tellimused — Päringu sisu

PaymentStatusUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 0maximum: 9223372036854775807
Näide: 0
reasonStringKohustuslik

Muudatuse juurde salvestatud põhjus.

minLength: 1maxLength: 500
Näide: "Bank transfer confirmed"
statusPaymentStatus Kohustuslik

Selle konkreetse toimingu lubatud olek. unpaid: maksmata; paid: makstud; failed: makse ebaõnnestus; refunded: tagastatud.

Näide: "paid"

Lisaväljad: Ei

Selle konkreetse toimingu lubatud olek

PaymentStatus · Skeem · Andmeskeemid: Tellimused String
Piirangud
enum
["unpaid", "paid", "failed", "refunded"]

Lisaväljad: Jah

PickupPointAddressData

PickupPointAddressData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
address_line_1StringKohustuslik

Esimene aadressirida.

minLength: 1maxLength: 240
cityStringKohustuslik

Linn või asula.

minLength: 1maxLength: 160
postal_codeStringKohustuslik

Postiindeks.

minLength: 1maxLength: 32

Lisaväljad: Ei

PickupPointCoordinatesData

PickupPointCoordinatesData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
latitudeArvKohustuslik

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeArvKohustuslik

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Lisaväljad: Ei

PickupPointData

PickupPointData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
address_line1StringKohustuslik

Esimene aadressirida.

cityStringKohustuslik

Linn või asula.

codeStringKohustuslik

Püsiv masinloetav kood.

country_codeStringKohustuslik

Riigikood.

kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud
enum
["locker", "pickup_point"]
latitudeArv nullKohustuslik

WGS84 φ (°)

location_descriptionString nullKohustuslik

Kirjeldus valitud keeles.

longitudeArv nullKohustuslik

WGS84 λ (°)

nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

opening_hoursString nullKohustuslik

Opening hours

operatorStringKohustuslik

Ressursi nimi vastavas kontekstis.

postal_codeStringKohustuslik

Postiindeks.

Lisaväljad: Ei

PickupPointSummaryData

PickupPointSummaryData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
codeStringKohustuslik

Püsiv masinloetav kood.

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

Riigikood.

Piirangud
pattern
"^[A-Z]{2}$"
environmentStringKohustuslik

Kirjele lisatud keskkonnateave.

Piirangud
enum
["live", "sandbox"]
kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud
enum
["locker", "pickup_point"]
operatorStringKohustuslik

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 63

Lisaväljad: Ei

Selle ressursi juurde salvestatud klienditeave

RequestCustomerData · Skeem · Andmeskeemid: Tellimused
emailStringKohustuslik

E-posti aadress.

Näide: "customer@example.invalid"
nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Example"

Lisaväljad: Ei

Tarneviis ja seotud teave

ShippingData · Skeem · Andmeskeemid: Tellimused
amountMoneyData Kohustuslik

Tellimusse MoneyData kujul salvestatud tarne brutosumma. Hilisemad maksumuudatused seda ajaloolist summat ei muuda.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Kohustuslik

Saatmis- ja tarnekuupäevad. Tellimuste loend ja üksikasjad sisaldavad delivery.dates. Kuupäevad YYYY-MM-DD on kavandatud ega kinnita saatmist. Praegused kuupäevad on ülimuslikud; vanemad tellimused kasutavad salvestatud hinnangut. Kustutatud või teadmata väärtused on null. Üksikasjad sisaldavad ka kõiki tellimusridu ja tootepilte.

Näide: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
method_codeString nullKohustuslik

Tarne- või makseviisi kood.

Näide: "shipping-old"
method_nameString nullKohustuslik

Tarne- või makseviisi nimi.

Näide: "Historic carrier"
pickup_pointPickupPointSummaryData nullKohustuslik

Väljastuspunkt

Näide: null
recipient_modeStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Näide: "full_address"

Lisaväljad: Ei

ShippingDetailData

ShippingDetailData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
amountMoneyData Kohustuslik

Tellimusse MoneyData kujul salvestatud tarne brutosumma. Hilisemad maksumuudatused seda ajaloolist summat ei muuda.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Kohustuslik

Saatmis- ja tarnekuupäevad. Tellimuste loend ja üksikasjad sisaldavad delivery.dates. Kuupäevad YYYY-MM-DD on kavandatud ega kinnita saatmist. Praegused kuupäevad on ülimuslikud; vanemad tellimused kasutavad salvestatud hinnangut. Kustutatud või teadmata väärtused on null. Üksikasjad sisaldavad ka kõiki tellimusridu ja tootepilte.

Näide: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
discount_grossMoneyData Kohustuslik

Brutosumma · Allahindlused; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullKohustuslik

Netosumma · Allahindlused; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullKohustuslik

Maksusumma · Allahindlused; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsMassiiv <OrderDeliveryDiscountData > nullKohustuslik

Tarne · Allahindlused; []: 0; null: Teadmata: null; teadaolev nullväärtus: 0.

Näide: [{"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 Kohustuslik

Brutosumma · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeString nullKohustuslik

Tarne- või makseviisi kood.

Näide: "shipping-old"
method_nameString nullKohustuslik

Tarne- või makseviisi nimi.

Näide: "Historic carrier"
netMoneyData nullKohustuslik

Netosumma · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Kohustuslik

Brutosumma · Tarne · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullKohustuslik

Netosumma · Tarne · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullKohustuslik

Maksusumma · Tarne · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullKohustuslik

Väljastuspunkt

Näide: null
recipient_modeStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Näide: "full_address"
taxMoneyData nullKohustuslik

Maksusumma · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idString nullKohustuslik

Maksukategooria tunnus · Salvestatud tellimusandmed; null.

Näide: "standard"
tax_category_nameString nullKohustuslik

Maksukategooria salvestatud nimi; null.

Näide: "VAT 23%"
tax_rateString nullKohustuslik

tax_rate · Salvestatud tellimusandmed: "0.23" = 23%; "0" ≠ null.

Näide: "0.23"

Lisaväljad: Ei