Skemi tad-data: Ordnijiet

Skemi tad-data: Ordnijiet. L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

Skemi tad-data

Indirizz tal-kunsinna

AddressData · Skema · Skemi tad-data: Ordnijiet

address_line_1String nullObbligatorju: L-ewwel linja tal-indirizz.
address_line_2String nullObbligatorju: Informazzjoni addizzjonali tal-indirizz.
cityString nullObbligatorju: Belt jew lokalità.
country_codeString nullObbligatorju: Kodiċi tal-pajjiż.
first_nameString nullObbligatorju: Isem.
house_numberString nullObbligatorju: Numru tal-bini jew tad-dar.
last_nameString nullObbligatorju: Kunjom.
phoneString nullObbligatorju: Numru tat-telefon.
postal_codeString nullObbligatorju: Kodiċi postali.
regionString nullObbligatorju: Reġjun amministrattiv.
streetString nullObbligatorju: Isem tat-triq.

Oqsma addizzjonali: Le

ApiResponse_OrderFileListData_

ApiResponse_OrderFileListData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna. Wara li toħloq upload_id, ibgħat il-fajls bħala multipart/form-data u għaqqadhom mal-prodott. It-tniżżil jeħtieġ token Bearer u permess għal category; it-tweġiba fiha l-bytes tal-fajl mingħajr indirizz pubbliku jew password. Għal mode=period agħżel days (1–3650) jew il-valur preċedenti months, qatt it-tnejn. Il-kundizzjonijiet jinżammu max-xiri; rifużjoni tneħħi l-aċċess biss mil-linja rifuża.

dataOrderFileListData Obbligatorju: Data ta’ tweġiba ta’ suċċess.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Oqsma addizzjonali: Le

ApiResponse_OrderReleaseListData_

ApiResponse_OrderReleaseListData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna. Wara li toħloq upload_id, ibgħat il-fajls bħala multipart/form-data u għaqqadhom mal-prodott. It-tniżżil jeħtieġ token Bearer u permess għal category; it-tweġiba fiha l-bytes tal-fajl mingħajr indirizz pubbliku jew password. Għal mode=period agħżel days (1–3650) jew il-valur preċedenti months, qatt it-tnejn. Il-kundizzjonijiet jinżammu max-xiri; rifużjoni tneħħi l-aċċess biss mil-linja rifuża.

dataOrderReleaseListData Obbligatorju: Data ta’ tweġiba ta’ suċċess.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Oqsma addizzjonali: Le

Elenka — Ordnijiet — Risposta

ApiResponse_list_OrderSummaryData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <OrderSummaryData > Obbligatorju: Eżempju ta’ tweġiba · ApiResponse_list_OrderSummaryData__.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Oqsma addizzjonali: Le

Ikseb — Ordnijiet — Risposta

ApiResponse_OrderDetailData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataOrderDetailData Obbligatorju: Eżempju ta’ tweġiba · OrderDetailData.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"request_id":"example-request"}

Oqsma addizzjonali: Le

CurrentReleaseData

CurrentReleaseData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna. Wara li toħloq upload_id, ibgħat il-fajls bħala multipart/form-data u għaqqadhom mal-prodott. It-tniżżil jeħtieġ token Bearer u permess għal category; it-tweġiba fiha l-bytes tal-fajl mingħajr indirizz pubbliku jew password. Għal mode=period agħżel days (1–3650) jew il-valur preċedenti months, qatt it-tnejn. Il-kundizzjonijiet jinżammu max-xiri; rifużjoni tneħħi l-aċċess biss mil-linja rifuża.

acquiredBooleanObbligatorju: Aċċess wara x-xiri (true / false)
changelogStringObbligatorju: Deskrizzjoni tal-bidliet
covered_by_purchaseBooleanObbligatorju: Aċċess wara x-xiri (true / false)
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti.
published_atStringObbligatorju: Ippubblika l-ħarġa · UTC

format: "date-time"
requires_new_purchaseBooleanObbligatorju: Ebda aċċess għal fajls miżjuda wara x-xiri · requires_new_purchase
sequenceNumru sħiħObbligatorju: Pożizzjoni fil-kollezzjoni ordnata.
version_labelStringObbligatorju: Verżjoni

Oqsma addizzjonali: Le

Informazzjoni tal-klijent irreġistrata għal din ir-riżorsa

CustomerData · Skema · Skemi tad-data: Ordnijiet

emailStringObbligatorju: Indirizz tal-email.

Eżempju: "customer@example.invalid"
first_nameString nullObbligatorju: Isem.

Eżempju: "Example"
last_nameString nullObbligatorju: Kunjom.

Eżempju: "Example"
phoneString nullObbligatorju: Numru tat-telefon.

Eżempju: null

Oqsma addizzjonali: Le

DeliveryContentDeletion

DeliveryContentDeletion · Ħassar il-kontenut b’mod permanenti u żomm l-istorja. Il-kodiċi ma jerġax jidħol fl-istokk għall-bejgħ.

expected_versionNumru sħiħObbligatorju: Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1

Eżempju: 1
reasonStringObbligatorju: Raġuni rreġistrata għall-bidla.

minLength: 1maxLength: 500

Eżempju: "Withdraw a revoked license"

Oqsma addizzjonali: Le

Dati tat-tluq u tal-kunsinna

DeliveryDatesData · Il-lista u d-dettalji tal-ordnijiet jinkludu delivery.dates. Id-dati YYYY-MM-DD huma ppjanati u ma jikkonfermawx it-tluq. Id-dati attwali jieħdu preċedenza; ordnijiet qodma jużaw l-istima ssejvjata. Valuri mħassra jew mhux magħrufa huma null. Id-dettalji jinkludu wkoll il-linji kollha u l-immaġnijiet tal-prodotti.

dispatch_timezoneString nullObbligatorju: Żona tal-ħin tat-tluq (IANA; null).

Eżempju: "Europe/Warsaw"
estimated_delivery_fromString nullObbligatorju: Bidu tal-kunsinna stmata (YYYY-MM-DD; null).

String:format: "date"

Eżempju: "2026-10-20"
estimated_delivery_toString nullObbligatorju: Tmiem tal-kunsinna stmata (YYYY-MM-DD; null).

String:format: "date"

Eżempju: "2026-10-21"
planned_dispatch_onString nullObbligatorju: Data ppjanata tat-tluq (YYYY-MM-DD; null).

String:format: "date"

Eżempju: "2026-10-19"

Oqsma addizzjonali: Le

DeliveryReplacement

DeliveryReplacement · Agħżel unità ħielsa eżistenti. Is-sostituzzjoni ma terġax tibda l-perjodu taż-żamma.

expected_unit_versionNumru sħiħObbligatorju: Verżjoni attwali tal-unità ħielsa ta’ sostituzzjoni.

minimum: 1

Eżempju: 1
expected_versionNumru sħiħObbligatorju: Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1

Eżempju: 1
reasonStringObbligatorju: Raġuni rreġistrata għall-bidla.

minLength: 1maxLength: 500

Eżempju: "Replace an invalid activation code"
replacement_unit_idStringObbligatorju: ID ta’ unità ħielsa eżistenti għal sostituzzjoni.

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000008"

Oqsma addizzjonali: Le

DeliveryPickupPointData

DeliveryPickupPointData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

addressPickupPointAddressData Obbligatorju

Indirizz tal-kunsinna.

codeStringObbligatorju

Kodiċi stabbli li jista’ jinqara minn magna.

Restrizzjonijiet

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

coordinatesPickupPointCoordinatesData nullObbligatorju

Valur deskritt mill-iskema ta’ madwaru.

country_codeStringObbligatorju

Kodiċi tal-pajjiż.

Restrizzjonijiet

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

environmentStringObbligatorju

Informazzjoni tal-ambjent mehmuża mar-rekord.

Restrizzjonijiet

enum: ["live", "sandbox"]

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["locker", "pickup_point"]

location_descriptionString nullObbligatorju

Deskrizzjoni fil-lingwa magħżula.

String:maxLength: 1000

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

minLength: 1maxLength: 160

opening_hoursString nullObbligatorju

Opening hours

String:maxLength: 500

operatorStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

minLength: 1maxLength: 63

verified_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Oqsma addizzjonali: Le

ApiResponse[list[DeliveryData]]

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · Aqra unitajiet allokati mingħajr kodiċijiet. Rifużjoni tneħħi l-aċċess biss mil-linji affettwati.

dataArray <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > Obbligatorju: Data ta’ tweġiba ta’ suċċess.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Oqsma addizzjonali: Le

DeliveryData

shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · Aqra unitajiet allokati mingħajr kodiċijiet. Rifużjoni tneħħi l-aċċess biss mil-linji affettwati.

can_downloadBooleanObbligatorju: Niżżel (true / false)

Eżempju: true
content_stateStringObbligatorju: Stat tal-kontenut: present / deleting / deleted.

Eżempju: "present"
delete_due_atString nullObbligatorju: Tħassir skedat tal-fajl; null jiddiżattivah.

String:format: "date-time"

Eżempju: null
filenameString nullObbligatorju: Fajl

Eżempju: null
first_available_atString nullObbligatorju: L-ewwel aċċess għal dan ix-xiri; is-sostituzzjoni ma terġax tibda t-terminu.

String:format: "date-time"

Eżempju: "2026-11-03T12:00:00Z"
generationNumru sħiħObbligatorju: Ġenerazzjoni tal-allokazzjoni; tiżdied mas-sostituzzjoni.

Eżempju: 1
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti.

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000005"
kindString nullObbligatorju: Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Eżempju: "code"
line_idStringObbligatorju: Identifikatur stabbli tal-linja tal-ordni.

Eżempju: "line-example"
order_idStringObbligatorju: Identifikatur tal-ordni relatata.

Eżempju: "order-example"
payload_idStringObbligatorju: ID tal-kontenut; mhuwiex URL pubbliku għat-tniżżil.

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000012"
product_idStringObbligatorju: Identifikatur tal-prodott.

Eżempju: "example"
reasonStringObbligatorju: Raġuni rreġistrata għall-bidla.

Eżempju: ""
size_bytesNumru sħiħ nullObbligatorju: Daqs f’bytes

Eżempju: null
stateStringObbligatorju: Stat

Eżempju: "available"
unit_idStringObbligatorju: ID ta’ kodiċi jew fajl individwali.

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000011"
unit_ordinalNumru sħiħObbligatorju: Numru tal-unità mixtrija fil-linja tal-ordni.

Eżempju: 1
variant_idString nullObbligatorju: Identifikatur tal-varjant tal-prodott.

Eżempju: null
versionNumru sħiħObbligatorju: Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 2

Oqsma addizzjonali: Le

Informazzjoni tal-fattura

InvoiceData · Skema · Skemi tad-data: Ordnijiet

address_line_1String nullObbligatorju: L-ewwel linja tal-indirizz.
address_line_2String nullObbligatorju: Informazzjoni addizzjonali tal-indirizz.
cityString nullObbligatorju: Belt jew lokalità.
company_nameString nullObbligatorju: Isem tal-kumpanija.
country_codeString nullObbligatorju: Kodiċi tal-pajjiż.
house_numberString nullObbligatorju: Numru tal-bini jew tad-dar.
postal_codeString nullObbligatorju: Kodiċi postali.
regionString nullObbligatorju: Reġjun amministrattiv.
streetString nullObbligatorju: Isem tat-triq.
tax_identifierString nullObbligatorju: Numru ta’ identifikazzjoni tat-taxxa.
tax_schemeString nullObbligatorju: Skema tal-kalkolu tat-taxxa.

Oqsma addizzjonali: Le

Ammont nett / Ammont tat-taxxa / Ammont gross

OrderAmountBreakdownData · L-ammonti u r-rati jiġu mill-ordni maħżuna, inklużi l-korrezzjonijiet tal-linji. Id-dejta storika nieqsa hija null u ma tinbidilx bir-rati attwali tal-katalgu. L-ammonti jibqgħu strings deċimali.

grossMoneyData Obbligatorju: Ammont gross · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullObbligatorju: Ammont nett · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullObbligatorju: Ammont tat-taxxa · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"58.60","currency":"PLN","minor_units":2}

Oqsma addizzjonali: Le

Kunsinna · Skontijiet

OrderDeliveryDiscountData · L-ammonti u r-rati jiġu mill-ordni maħżuna, inklużi l-korrezzjonijiet tal-linji. Id-dejta storika nieqsa hija null u ma tinbidilx bir-rati attwali tal-katalgu. L-ammonti jibqgħu strings deċimali.

amountMoneyData Obbligatorju

Ammont gross · Kunsinna · Skontijiet.

Eżempju: {"amount":"24.60","currency":"PLN","minor_units":2}

campaign_idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti.

Eżempju: "saved-coupon"

codeString nullObbligatorju

Kodiċi stabbli li jista’ jinqara minn magna.

Eżempju: "SAVE"

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["coupon", "promotion"]

Eżempju: "coupon"

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Saved coupon"

sequenceNumru sħiħ nullObbligatorju

Pożizzjoni fil-kollezzjoni ordnata.

Eżempju: 1

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 3

Oqsma addizzjonali: Le

Ikseb — Ordnijiet — Risposta

OrderDetailData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

created_atStringObbligatorju: Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-10-19T10:00:00Z"
customerCustomerData Obbligatorju: Informazzjoni tal-klijent irreġistrata għal din ir-riżorsa.

Eżempju: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Obbligatorju: Metodu tal-kunsinna u informazzjoni assoċjata.

Eżempju: {"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 Obbligatorju: Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

Eżempju: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Obbligatorju: Skontijiet

Eżempju: [{"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}]
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. (OrderDetailData).

Eżempju: "order-0000"
invoiceInvoiceData nullObbligatorju: Informazzjoni tal-fattura.

Eżempju: null
invoice_requestedBooleanObbligatorju: Jekk intalbitx fattura.

Eżempju: false
lifecycle_stateOrderLifecycleState Obbligatorju: Stat taċ-ċiklu tal-ħajja tan-negozju.

Eżempju: "placed"
linesArray <OrderLineData > Obbligatorju: Kopji tal-linji tal-ordni kif kienu fil-mument tal-ordni.

Eżempju: [{"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":[]}]
localeStringObbligatorju: Lingwa magħżula għal din it-talba.

Eżempju: "pl"
market_idStringObbligatorju: Identifikatur tas-suq mogħti mill-endpoint tal-kuntest.

Eżempju: "market-pl"
numberStringObbligatorju: Numru tal-ordni jew tat-talba muri lill-bniedem.

Eżempju: "0001"
paymentPaymentData Obbligatorju: Dettalji tal-ħlas irreġistrati għall-ordni.

Eżempju: {"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 nullObbligatorju: Punt tal-ġbir

Eżempju: null
prices_include_taxBooleanObbligatorju: Jekk il-prezzijiet elenkati jinkludux it-taxxa.

Eżempju: true
shipping_addressAddressData nullObbligatorju: Indirizz tal-kunsinna.

Eżempju: null
shipping_discount_amountMoneyData Obbligatorju: Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

Eżempju: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obbligatorju: Status aċċettat minn din l-operazzjoni speċifika.

Eżempju: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obbligatorju: Ammont qabel il-komponenti addizzjonali murija fit-tweġiba.

Eżempju: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obbligatorju: Informazzjoni tat-taxxa.

Eżempju: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Obbligatorju: Gruppi tat-taxxa · source + tax_rate; unallocated_tax.

Eżempju: {"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 nullObbligatorju: Pajjiż tat-taxxa · Dejta maħżuna tal-ordni · ISO 3166-1 alpha-2; null.

Eżempju: "PL"
totalMoneyData Obbligatorju: Ammont totali.

Eżempju: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Obbligatorju: Totali · net / tax / gross; Qabel l-iskontijiet / Wara l-iskontijiet.

Eżempju: {"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}}}

Oqsma addizzjonali: Le

OrderFileData

OrderFileData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna. Wara li toħloq upload_id, ibgħat il-fajls bħala multipart/form-data u għaqqadhom mal-prodott. It-tniżżil jeħtieġ token Bearer u permess għal category; it-tweġiba fiha l-bytes tal-fajl mingħajr indirizz pubbliku jew password. Għal mode=period agħżel days (1–3650) jew il-valur preċedenti months, qatt it-tnejn. Il-kundizzjonijiet jinżammu max-xiri; rifużjoni tneħħi l-aċċess biss mil-linja rifuża.

can_downloadBooleanObbligatorju: Niżżel (true / false)

Eżempju: true
categoryFileCategory Obbligatorju: Kategorija tal-fajl: internal / customer_document / digital

Eżempju: "digital"
filenameStringObbligatorju: Fajl

Eżempju: "manual.pdf"
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti.

Eżempju: "example"
labelStringObbligatorju: Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Manual"
line_idStringObbligatorju: Identifikatur stabbli tal-linja tal-ordni.

Eżempju: "example"
mime_typeStringObbligatorju: Tip tal-kontenut tal-midja.

Eżempju: "application/pdf"
product_idStringObbligatorju: Identifikatur tal-prodott.

Eżempju: "example"
purchase_idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. · purchase_id

Eżempju: "00000000-0000-4000-8000-000000000001"
reasonStringObbligatorju: Raġuni rreġistrata għall-bidla.

Eżempju: "paid"
sha256StringObbligatorju: SHA-256 (hex, 64)

Eżempju: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesNumru sħiħObbligatorju: Daqs f’bytes

minimum: 1maximum: 262144000

Eżempju: 46
source_file_idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. · source_file_id

Eżempju: "00000000-0000-4000-8000-000000000001"
source_version_idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. · source_version_id

Eżempju: "00000000-0000-4000-8000-000000000001"
source_version_numberNumru sħiħObbligatorju: Verżjoni

minimum: 1

Eżempju: 1
stateStringObbligatorju: Stat

Eżempju: "active"

Oqsma addizzjonali: Le

OrderFileListData

OrderFileListData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna. Wara li toħloq upload_id, ibgħat il-fajls bħala multipart/form-data u għaqqadhom mal-prodott. It-tniżżil jeħtieġ token Bearer u permess għal category; it-tweġiba fiha l-bytes tal-fajl mingħajr indirizz pubbliku jew password. Għal mode=period agħżel days (1–3650) jew il-valur preċedenti months, qatt it-tnejn. Il-kundizzjonijiet jinżammu max-xiri; rifużjoni tneħħi l-aċċess biss mil-linja rifuża.

filesArray <OrderFileData > Obbligatorju: Fajls tal-prodott

Eżempju: [{"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_pendingBooleanObbligatorju: Aċċess għal fajls futuri wara x-xiri · updates_pending

Eżempju: false

Oqsma addizzjonali: Le

Metadata u URL tal-istampa

OrderImageData · Skema · Skemi tad-data: Ordnijiet

altString nullObbligatorju: Test alternattiv għal stampa.
sourceStringMhux obbligatorju: Sors tal-attività rreġistrata.

const: "current_catalog"

Valur predefinit: "current_catalog"
urlStringObbligatorju: URL tar-riżorsa.

Oqsma addizzjonali: Le

Stat taċ-ċiklu tal-ħajja tan-negozju

OrderLifecycleState · Skema · Skemi tad-data: Ordnijiet

String

Restrizzjonijiet

enum: ["placed", "cancelled", "fulfilled", "returned"]

Oqsma addizzjonali: Iva

Kopji tal-linji tal-ordni kif kienu fil-mument tal-ordni

OrderLineData · Skema · Skemi tad-data: Ordnijiet

discount_amountMoneyData Obbligatorju: Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

Eżempju: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Obbligatorju: Ammont gross · Skontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObbligatorju: Ammont nett · Skontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObbligatorju: Ammont tat-taxxa · Skontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Obbligatorju: Skontijiet · net / tax / gross.

Eżempju: [{"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}]
identifiersOġġettOqsma addizzjonali: StringObbligatorju: Kodiċijiet ta’ identifikazzjoni tal-prodott.

Eżempju: {}
imageOrderImageData nullObbligatorju: Metadata u URL tal-istampa.

Eżempju: null
line_idStringObbligatorju: Identifikatur stabbli tal-linja tal-ordni.

Eżempju: "saved-line-a"
manual_discountOrderManualDiscountData nullObbligatorju: Skont manwali; null.

Eżempju: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameStringObbligatorju: Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Saved A"
original_totalMoneyData Obbligatorju: Ammont totali.

Eżempju: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Obbligatorju: Ammont gross · Prodotti · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullObbligatorju: Ammont nett · Prodotti · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullObbligatorju: Ammont tat-taxxa · Prodotti · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"46.00","currency":"PLN","minor_units":2}
positionNumru sħiħObbligatorju: Pożizzjoni fil-kollezzjoni ordnata.

Eżempju: 1
product_idStringObbligatorju: Identifikatur tal-prodott.

Eżempju: "product-api"
quantityNumru sħiħObbligatorju: Numru ta’ unitajiet.

Eżempju: 2
skuStringObbligatorju: Kodiċi tal-unità ta’ ġestjoni tal-istokk.

Eżempju: "A"
taxMoneyData nullObbligatorju: Ammont tat-taxxa · Unità waħda · Dejta maħżuna tal-ordni; tax ≠ unit_tax; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idString nullObbligatorju: Identifikatur tal-kategorija tat-taxxa · Dejta maħżuna tal-ordni; null.

Eżempju: "standard"
tax_category_nameString nullObbligatorju: Isem maħżun tal-kategorija tat-taxxa; null.

Eżempju: "VAT 23%"
tax_rateString nullObbligatorju: tax_rate · Dejta maħżuna tal-ordni: "0.23" = 23%; "0" ≠ null.

Eżempju: "0.23"
totalMoneyData Obbligatorju: Ammont totali.

Eżempju: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Obbligatorju: Ammont gross · Prodotti · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullObbligatorju: Ammont nett · Prodotti · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullObbligatorju: Ammont tat-taxxa · Prodotti · Wara l-iskontijiet · Dejta maħżuna tal-ordni; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Obbligatorju: Ammont gross · Unità waħda · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullObbligatorju: Ammont nett · Unità waħda · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obbligatorju: Prezz għal unità waħda.

Eżempju: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullObbligatorju: Ammont tat-taxxa · Unità waħda · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idString nullObbligatorju: Identifikatur tal-varjant tal-prodott.

Eżempju: null
variant_optionsArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Obbligatorju: Għażliet tal-varjanti assoċjati mal-prodott jew mal-kopja tad-data f’ħin speċifiku.

Eżempju: []

Oqsma addizzjonali: Le

Skont manwali

OrderManualDiscountData · L-ammonti u r-rati jiġu mill-ordni maħżuna, inklużi l-korrezzjonijiet tal-linji. Id-dejta storika nieqsa hija null u ma tinbidilx bir-rati attwali tal-katalgu. L-ammonti jibqgħu strings deċimali.

amountMoneyData Obbligatorju

Ammont gross · Skont manwali · Dejta maħżuna tal-ordni.

Eżempju: {"amount":"12.30","currency":"PLN","minor_units":2}

kindStringObbligatorju

Tip ta’ skont: percentage / fixed.

Restrizzjonijiet

enum: ["percentage", "fixed"]

Eżempju: "fixed"

valueStringObbligatorju

Valur ikkonfigurat: percentage "10" = 10%; fixed = Ammont gross.

Eżempju: "12.30"

Oqsma addizzjonali: Le

Status aċċettat minn din l-operazzjoni speċifika

OrderPaymentStatus · Skema · Skemi tad-data: Ordnijiet

String

Restrizzjonijiet

enum: ["unpaid", "paid", "failed", "refunded"]

Oqsma addizzjonali: Iva

OrderReleaseData

OrderReleaseData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna. Wara li toħloq upload_id, ibgħat il-fajls bħala multipart/form-data u għaqqadhom mal-prodott. It-tniżżil jeħtieġ token Bearer u permess għal category; it-tweġiba fiha l-bytes tal-fajl mingħajr indirizz pubbliku jew password. Għal mode=period agħżel days (1–3650) jew il-valur preċedenti months, qatt it-tnejn. Il-kundizzjonijiet jinżammu max-xiri; rifużjoni tneħħi l-aċċess biss mil-linja rifuża.

access_reasonStringObbligatorju: Aċċess wara x-xiri · Raġuni rreġistrata għall-bidla.

Eżempju: "paid"
access_stateStringObbligatorju: Aċċess wara x-xiri · Stat

Eżempju: "active"
current_releaseCurrentReleaseData nullObbligatorju: Ħarġiet diġitali · current_release

Eżempju: null
grant_reasonStringObbligatorju: Aċċess wara x-xiri · Raġuni rreġistrata għall-bidla.

Eżempju: "purchase"
granted_atStringObbligatorju: Aċċess wara x-xiri · UTC

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti.

Eżempju: "example"
line_idStringObbligatorju: Identifikatur stabbli tal-linja tal-ordni.

Eżempju: "example"
manifest_sha256StringObbligatorju: Ħarġiet diġitali · SHA-256

Eżempju: "1111111111111111111111111111111111111111111111111111111111111111"
product_idStringObbligatorju: Identifikatur tal-prodott.

Eżempju: "example"
published_atStringObbligatorju: Ippubblika l-ħarġa · UTC

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"
purchase_idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. · purchase_id

Eżempju: "00000000-0000-4000-8000-000000000001"
release_idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. · release_id

Eżempju: "00000000-0000-4000-8000-000000000001"
release_sequenceNumru sħiħObbligatorju: Ħarġiet diġitali · Pożizzjoni fil-kollezzjoni ordnata.

Eżempju: 1
update_daysNumru sħiħ nullObbligatorju: Numru ta’ jiem (days; null)

Eżempju: 365
update_modeStringObbligatorju: Aċċess għal fajls futuri wara x-xiri: none / period / unlimited

Eżempju: "period"
update_monthsNumru sħiħ nullObbligatorju: Xhur (months; null)

Eżempju: null
updates_untilString nullObbligatorju: Aċċess għal fajls futuri wara x-xiri · UTC

String:format: "date-time"

Eżempju: "2027-01-01T12:00:00Z"
version_labelStringObbligatorju: Verżjoni

Eżempju: "1.0"

Oqsma addizzjonali: Le

OrderReleaseListData

OrderReleaseListData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna. Wara li toħloq upload_id, ibgħat il-fajls bħala multipart/form-data u għaqqadhom mal-prodott. It-tniżżil jeħtieġ token Bearer u permess għal category; it-tweġiba fiha l-bytes tal-fajl mingħajr indirizz pubbliku jew password. Għal mode=period agħżel days (1–3650) jew il-valur preċedenti months, qatt it-tnejn. Il-kundizzjonijiet jinżammu max-xiri; rifużjoni tneħħi l-aċċess biss mil-linja rifuża.

releasesArray <OrderReleaseData > Obbligatorju: Ħarġiet diġitali

Eżempju: [{"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_pendingBooleanObbligatorju: Aċċess għal fajls futuri wara x-xiri · updates_pending

Eżempju: false

Oqsma addizzjonali: Le

Status aċċettat minn din l-operazzjoni speċifika

OrderStatusData · Skema · Skemi tad-data: Ordnijiet

idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. (OrderStatusData).

Eżempju: "status-0"
nameStringObbligatorju: Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Status 0"
updated_atStringObbligatorju: Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-10-19T10:00:00Z"
versionNumru sħiħObbligatorju: Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Elenka · Stati — Ordnijiet — Risposta

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

created_atStringObbligatorju: Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Eżempju: "status-0"
is_initialBooleanObbligatorju: Jekk dan huwiex l-istatus inizjali.

Eżempju: true
nameStringObbligatorju: Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "New"
positionNumru sħiħObbligatorju: Pożizzjoni fil-kollezzjoni ordnata.

Eżempju: 0

Oqsma addizzjonali: Le

Elenka · Stati — Ordnijiet — Risposta

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Obbligatorju: Eżempju ta’ tweġiba · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Oqsma addizzjonali: Le

Aġġorna · Stat — Ordnijiet — Kontenut tat-talba

OrderStatusUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

status_idStringObbligatorju

Identifikatur miksub mid-dizzjunarju tal-istatus rilevanti.

Restrizzjonijiet

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Eżempju: "status-1"

Oqsma addizzjonali: Le

Elenka — Ordnijiet — Risposta

OrderSummaryData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

created_atStringObbligatorju: Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-10-19T10:00:00Z"
customerCustomerData Obbligatorju: Informazzjoni tal-klijent irreġistrata għal din ir-riżorsa.

Eżempju: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Obbligatorju: Metodu tal-kunsinna u informazzjoni assoċjata.

Eżempju: {"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 Obbligatorju: Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

Eżempju: {"amount":"24.60","currency":"PLN","minor_units":2}
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. (OrderSummaryData).

Eżempju: "order-0000"
lifecycle_stateOrderLifecycleState Obbligatorju: Stat taċ-ċiklu tal-ħajja tan-negozju.

Eżempju: "placed"
localeStringObbligatorju: Lingwa magħżula għal din it-talba.

Eżempju: "pl"
market_idStringObbligatorju: Identifikatur tas-suq mogħti mill-endpoint tal-kuntest.

Eżempju: "market-pl"
numberStringObbligatorju: Numru tal-ordni jew tat-talba muri lill-bniedem.

Eżempju: "0001"
paymentPaymentData Obbligatorju: Dettalji tal-ħlas irreġistrati għall-ordni.

Eżempju: {"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_taxBooleanObbligatorju: Jekk il-prezzijiet elenkati jinkludux it-taxxa.

Eżempju: true
shipping_discount_amountMoneyData Obbligatorju: Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

Eżempju: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obbligatorju: Status aċċettat minn din l-operazzjoni speċifika.

Eżempju: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obbligatorju: Ammont qabel il-komponenti addizzjonali murija fit-tweġiba.

Eżempju: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obbligatorju: Informazzjoni tat-taxxa.

Eżempju: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeString nullObbligatorju: Pajjiż tat-taxxa · Dejta maħżuna tal-ordni · ISO 3166-1 alpha-2; null.

Eżempju: "PL"
totalMoneyData Obbligatorju: Ammont totali.

Eżempju: {"amount":"329.40","currency":"PLN","minor_units":2}

Oqsma addizzjonali: Le

Ordni · Gruppi tat-taxxa

OrderTaxBreakdownData · L-ammonti u r-rati jiġu mill-ordni maħżuna, inklużi l-korrezzjonijiet tal-linji. Id-dejta storika nieqsa hija null u ma tinbidilx bir-rati attwali tal-katalgu. L-ammonti jibqgħu strings deċimali.

groupsArray <OrderTaxGroupData > Obbligatorju: Gruppi tat-taxxa · source + tax_rate; Mhux magħruf: null; żero magħruf: 0.

Eżempju: [{"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 Obbligatorju: Taxxa mhux allokata = order.tax − Σ groups.tax; ±.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}

Oqsma addizzjonali: Le

Gruppi tat-taxxa

OrderTaxGroupData · L-ammonti u r-rati jiġu mill-ordni maħżuna, inklużi l-korrezzjonijiet tal-linji. Id-dejta storika nieqsa hija null u ma tinbidilx bir-rati attwali tal-katalgu. L-ammonti jibqgħu strings deċimali.

grossMoneyData Obbligatorju

Ammont gross · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"221.40","currency":"PLN","minor_units":2}

netMoneyData nullObbligatorju

Ammont nett · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"180.00","currency":"PLN","minor_units":2}

sourceStringObbligatorju

Sors: products (Prodotti), shipping (Kunsinna).

Restrizzjonijiet

enum: ["products", "shipping"]

Eżempju: "products"

taxMoneyData nullObbligatorju

Ammont tat-taxxa · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"41.40","currency":"PLN","minor_units":2}

tax_rateString nullObbligatorju

tax_rate · Dejta maħżuna tal-ordni: "0.23" = 23%; "0" ≠ null.

Eżempju: "0.23"

Oqsma addizzjonali: Le

Ordni · Totali

OrderTotalsData · L-ammonti u r-rati jiġu mill-ordni maħżuna, inklużi l-korrezzjonijiet tal-linji. Id-dejta storika nieqsa hija null u ma tinbidilx bir-rati attwali tal-katalgu. L-ammonti jibqgħu strings deċimali.

before_discountsOrderAmountBreakdownData Obbligatorju: Ordni · Qabel l-iskontijiet · net / tax / gross.

Eżempju: {"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 Obbligatorju: Skontijiet · net / tax / gross.

Eżempju: {"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 Obbligatorju: Ordni · Wara l-iskontijiet · net / tax / gross.

Eżempju: {"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 Obbligatorju: Prodotti · Skontijiet · net / tax / gross.

Eżempju: {"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 Obbligatorju: Prodotti · Wara l-iskontijiet · net / tax / gross.

Eżempju: {"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 Obbligatorju: Prodotti · Qabel l-iskontijiet · net / tax / gross.

Eżempju: {"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 Obbligatorju: Kunsinna · Wara l-iskontijiet · net / tax / gross.

Eżempju: {"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 Obbligatorju: Kunsinna · Qabel l-iskontijiet · net / tax / gross.

Eżempju: {"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 Obbligatorju: Kunsinna · Skontijiet · net / tax / gross.

Eżempju: {"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}}

Oqsma addizzjonali: Le

Għażliet tal-varjanti assoċjati mal-prodott jew mal-kopja tad-data f’ħin speċifiku

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Skema · Skemi tad-data: Ordnijiet

nameStringObbligatorju: Isem tar-riżorsa fil-kuntest rilevanti.
valueStringObbligatorju: Valur deskritt mill-iskema ta’ madwaru.

Oqsma addizzjonali: Le

OrderDiscountData

OrderDiscountData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

amountMoneyData Obbligatorju

Ammont gross · Prodotti · Skontijiet.

Eżempju: {"amount":"12.30","currency":"PLN","minor_units":2}

campaign_idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti.

Eżempju: "saved-coupon"

codeString nullObbligatorju

Kodiċi stabbli li jista’ jinqara minn magna.

Eżempju: "SAVE"

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["coupon", "promotion"]

Eżempju: "coupon"

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Saved coupon"

sequenceNumru sħiħ nullMhux obbligatorju

Ordni tal-applikazzjoni; null.

Eżempju: 1

shipping_amountMoneyData nullMhux obbligatorju

Ammont gross · Kunsinna · Skontijiet; null.

Eżempju: {"amount":"24.60","currency":"PLN","minor_units":2}

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 3

Oqsma addizzjonali: Le

Dettalji tal-ħlas irreġistrati għall-ordni

PaymentData · Skema · Skemi tad-data: Ordnijiet

amountMoneyData Obbligatorju

payment.amount huwa t-total tal-ordni. L-istatus tal-ħlas ma jiddeterminax ammonti mħallsa, rimborżati jew dovuti.

Eżempju: {"amount":"329.40","currency":"PLN","minor_units":2}

environmentStringObbligatorju

Informazzjoni tal-ambjent mehmuża mar-rekord.

Restrizzjonijiet

enum: ["live", "sandbox"]

Eżempju: "live"

method_codeString nullObbligatorju

Kodiċi tal-metodu tal-kunsinna jew tal-ħlas.

Eżempju: "payment-old"

method_nameString nullObbligatorju

Isem tal-metodu tal-kunsinna jew tal-ħlas.

Eżempju: "Historic method"

paid_atString nullObbligatorju

Data u ħin meta l-ħlas ġie mmarkat bħala mħallas.

String:format: "date-time"

Eżempju: null

statusOrderPaymentStatus Obbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

Eżempju: "unpaid"

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-10-19T10:00:00Z"

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 0

Oqsma addizzjonali: Le

Aġġorna · Stat tal-ħlas — Ordnijiet — Kontenut tat-talba

PaymentStatusUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

expected_versionNumru sħiħObbligatorju: Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 0maximum: 9223372036854775807

Eżempju: 0
reasonStringObbligatorju: Raġuni rreġistrata għall-bidla.

minLength: 1maxLength: 500

Eżempju: "Bank transfer confirmed"
statusPaymentStatus Obbligatorju: Status aċċettat minn din l-operazzjoni speċifika. unpaid: mhux imħallas; paid: imħallas; failed: ħlas falla; refunded: rifuż.

Eżempju: "paid"

Oqsma addizzjonali: Le

Status aċċettat minn din l-operazzjoni speċifika

PaymentStatus · Skema · Skemi tad-data: Ordnijiet

String

Restrizzjonijiet

enum: ["unpaid", "paid", "failed", "refunded"]

Oqsma addizzjonali: Iva

PickupPointAddressData

PickupPointAddressData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

address_line_1StringObbligatorju: L-ewwel linja tal-indirizz.

minLength: 1maxLength: 240
cityStringObbligatorju: Belt jew lokalità.

minLength: 1maxLength: 160
postal_codeStringObbligatorju: Kodiċi postali.

minLength: 1maxLength: 32

Oqsma addizzjonali: Le

PickupPointCoordinatesData

PickupPointCoordinatesData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

latitudeNumruObbligatorju: WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeNumruObbligatorju: WGS84 λ (°)

minimum: -180.0maximum: 180.0

Oqsma addizzjonali: Le

PickupPointData

PickupPointData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

address_line1StringObbligatorju

L-ewwel linja tal-indirizz.

cityStringObbligatorju

Belt jew lokalità.

codeStringObbligatorju

Kodiċi stabbli li jista’ jinqara minn magna.

country_codeStringObbligatorju

Kodiċi tal-pajjiż.

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["locker", "pickup_point"]

latitudeNumru nullObbligatorju

WGS84 φ (°)

location_descriptionString nullObbligatorju

Deskrizzjoni fil-lingwa magħżula.

longitudeNumru nullObbligatorju

WGS84 λ (°)

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

opening_hoursString nullObbligatorju

Opening hours

operatorStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

postal_codeStringObbligatorju

Kodiċi postali.

Oqsma addizzjonali: Le

PickupPointSummaryData

PickupPointSummaryData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

codeStringObbligatorju

Kodiċi stabbli li jista’ jinqara minn magna.

Restrizzjonijiet

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

country_codeStringObbligatorju

Kodiċi tal-pajjiż.

Restrizzjonijiet

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

environmentStringObbligatorju

Informazzjoni tal-ambjent mehmuża mar-rekord.

Restrizzjonijiet

enum: ["live", "sandbox"]

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["locker", "pickup_point"]

operatorStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

minLength: 1maxLength: 63

Oqsma addizzjonali: Le

Informazzjoni tal-klijent irreġistrata għal din ir-riżorsa

RequestCustomerData · Skema · Skemi tad-data: Ordnijiet

emailStringObbligatorju: Indirizz tal-email.

Eżempju: "customer@example.invalid"
nameStringObbligatorju: Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"

Oqsma addizzjonali: Le

Metodu tal-kunsinna u informazzjoni assoċjata

ShippingData · Skema · Skemi tad-data: Ordnijiet

amountMoneyData Obbligatorju

Ammont gross tat-tbaħħir irreġistrat fl-ordni bħala MoneyData. Bidliet sussegwenti fit-taxxa ma jbiddlux dan l-ammont storiku.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}

datesDeliveryDatesData Obbligatorju

Dati tat-tluq u tal-kunsinna. Il-lista u d-dettalji tal-ordnijiet jinkludu delivery.dates. Id-dati YYYY-MM-DD huma ppjanati u ma jikkonfermawx it-tluq. Id-dati attwali jieħdu preċedenza; ordnijiet qodma jużaw l-istima ssejvjata. Valuri mħassra jew mhux magħrufa huma null. Id-dettalji jinkludu wkoll il-linji kollha u l-immaġnijiet tal-prodotti.

Eżempju:

{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

method_codeString nullObbligatorju

Kodiċi tal-metodu tal-kunsinna jew tal-ħlas.

Eżempju: "shipping-old"

method_nameString nullObbligatorju

Isem tal-metodu tal-kunsinna jew tal-ħlas.

Eżempju: "Historic carrier"

pickup_pointPickupPointSummaryData nullObbligatorju

Punt tal-ġbir

Eżempju: null

recipient_modeStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]

Eżempju: "full_address"

Oqsma addizzjonali: Le

ShippingDetailData

ShippingDetailData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

amountMoneyData Obbligatorju

Ammont gross tat-tbaħħir irreġistrat fl-ordni bħala MoneyData. Bidliet sussegwenti fit-taxxa ma jbiddlux dan l-ammont storiku.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}

datesDeliveryDatesData Obbligatorju

Eżempju:

{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

discount_grossMoneyData Obbligatorju

Ammont gross · Skontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"24.60","currency":"PLN","minor_units":2}

discount_netMoneyData nullObbligatorju

Ammont nett · Skontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"20.00","currency":"PLN","minor_units":2}

discount_taxMoneyData nullObbligatorju

Ammont tat-taxxa · Skontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"4.60","currency":"PLN","minor_units":2}

discountsArray <OrderDeliveryDiscountData > nullObbligatorju

Kunsinna · Skontijiet; []: 0; null: Mhux magħruf: null; żero magħruf: 0.

Eżempju:

[{"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 Obbligatorju

Ammont gross · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}

method_codeString nullObbligatorju

Kodiċi tal-metodu tal-kunsinna jew tal-ħlas.

Eżempju: "shipping-old"

method_nameString nullObbligatorju

Isem tal-metodu tal-kunsinna jew tal-ħlas.

Eżempju: "Historic carrier"

netMoneyData nullObbligatorju

Ammont nett · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}

original_grossMoneyData Obbligatorju

Ammont gross · Kunsinna · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"24.60","currency":"PLN","minor_units":2}

original_netMoneyData nullObbligatorju

Ammont nett · Kunsinna · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"20.00","currency":"PLN","minor_units":2}

original_taxMoneyData nullObbligatorju

Ammont tat-taxxa · Kunsinna · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"4.60","currency":"PLN","minor_units":2}

pickup_pointDeliveryPickupPointData nullObbligatorju

Punt tal-ġbir

Eżempju: null

recipient_modeStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]

Eżempju: "full_address"

taxMoneyData nullObbligatorju

Ammont tat-taxxa · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}

tax_category_idString nullObbligatorju

Identifikatur tal-kategorija tat-taxxa · Dejta maħżuna tal-ordni; null.

Eżempju: "standard"

tax_category_nameString nullObbligatorju

Isem maħżun tal-kategorija tat-taxxa; null.

Eżempju: "VAT 23%"

tax_rateString nullObbligatorju

tax_rate · Dejta maħżuna tal-ordni: "0.23" = 23%; "0" ≠ null.

Eżempju: "0.23"

Oqsma addizzjonali: Le