Pereiti prie turinio
ShopentlyLearn
Lietuvių

Duomenų schemos: Užsakymai

Duomenų schemos: Užsakymai. API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

Duomenų schemos

Pristatymo adresas

AddressData · Schema · Duomenų schemos: Užsakymai
address_line_1Eilutė nullPrivalomas

Pirmoji adreso eilutė.

address_line_2Eilutė nullPrivalomas

Papildoma adreso informacija.

cityEilutė nullPrivalomas

Miestas arba gyvenvietė.

country_codeEilutė nullPrivalomas

Šalies kodas.

first_nameEilutė nullPrivalomas

Vardas.

house_numberEilutė nullPrivalomas

Pastato arba namo numeris.

last_nameEilutė nullPrivalomas

Pavardė.

phoneEilutė nullPrivalomas

Telefono numeris.

postal_codeEilutė nullPrivalomas

Pašto kodas.

regionEilutė nullPrivalomas

Administracinis regionas.

streetEilutė nullPrivalomas

Gatvės pavadinimas.

Papildomi laukai: Ne

ApiResponse_OrderFileListData_

ApiResponse_OrderFileListData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai. Sukūrę upload_id siųskite failus kaip multipart/form-data ir susiekite juos su produktu. Atsisiuntimui reikia Bearer žetono ir category leidimo; atsakyme pateikiami failo baitai be viešo adreso ar slaptažodžio. Kai mode=period, rinkitės days (1–3650) arba ankstesnį months, bet ne abu. Sąlygos išsaugomos perkant; grąžinus pinigus panaikinama prieiga tik prie grąžintos eilutės.
dataOrderFileListData Privalomas

Sėkmingo atsakymo duomenys.

Pavyzdys: {"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 Privalomas

Atsakymo metaduomenys.

Pavyzdys: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Papildomi laukai: Ne

ApiResponse_OrderReleaseListData_

ApiResponse_OrderReleaseListData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai. Sukūrę upload_id siųskite failus kaip multipart/form-data ir susiekite juos su produktu. Atsisiuntimui reikia Bearer žetono ir category leidimo; atsakyme pateikiami failo baitai be viešo adreso ar slaptažodžio. Kai mode=period, rinkitės days (1–3650) arba ankstesnį months, bet ne abu. Sąlygos išsaugomos perkant; grąžinus pinigus panaikinama prieiga tik prie grąžintos eilutės.
dataOrderReleaseListData Privalomas

Sėkmingo atsakymo duomenys.

Pavyzdys: {"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 Privalomas

Atsakymo metaduomenys.

Pavyzdys: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Papildomi laukai: Ne

Sąrašas — Užsakymai — Atsakymas

ApiResponse_list_OrderSummaryData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
dataMasyvas <OrderSummaryData > Privalomas

Atsakymo pavyzdys · ApiResponse_list_OrderSummaryData__.

Pavyzdys: [{"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 Privalomas

Atsakymo metaduomenys.

Pavyzdys: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildomi laukai: Ne

Gauti — Užsakymai — Atsakymas

ApiResponse_OrderDetailData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
dataOrderDetailData Privalomas

Atsakymo pavyzdys · OrderDetailData.

Pavyzdys: {"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 Privalomas

Atsakymo metaduomenys.

Pavyzdys: {"request_id":"example-request"}

Papildomi laukai: Ne

CurrentReleaseData

CurrentReleaseData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai. Sukūrę upload_id siųskite failus kaip multipart/form-data ir susiekite juos su produktu. Atsisiuntimui reikia Bearer žetono ir category leidimo; atsakyme pateikiami failo baitai be viešo adreso ar slaptažodžio. Kai mode=period, rinkitės days (1–3650) arba ankstesnį months, bet ne abu. Sąlygos išsaugomos perkant; grąžinus pinigus panaikinama prieiga tik prie grąžintos eilutės.
acquiredLoginė reikšmėPrivalomas

Prieiga po pirkimo (true / false)

changelogEilutėPrivalomas

Pakeitimų aprašymas

covered_by_purchaseLoginė reikšmėPrivalomas

Prieiga po pirkimo (true / false)

idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.

published_atEilutėPrivalomas

Paskelbti leidimą · UTC

format: "date-time"
requires_new_purchaseLoginė reikšmėPrivalomas

Nėra prieigos prie po pirkimo pridėtų failų · requires_new_purchase

sequenceSveikasis skaičiusPrivalomas

Pozicija surikiuotame rinkinyje.

version_labelEilutėPrivalomas

Versija

Papildomi laukai: Ne

Šiam ištekliui užregistruota kliento informacija

CustomerData · Schema · Duomenų schemos: Užsakymai
emailEilutėPrivalomas

El. pašto adresas.

Pavyzdys: "customer@example.invalid"
first_nameEilutė nullPrivalomas

Vardas.

Pavyzdys: "Example"
last_nameEilutė nullPrivalomas

Pavardė.

Pavyzdys: "Example"
phoneEilutė nullPrivalomas

Telefono numeris.

Pavyzdys: null

Papildomi laukai: Ne

DeliveryContentDeletion

DeliveryContentDeletion · Visam laikui ištrinkite turinį, išsaugodami istoriją. Kodas negrįžta į parduodamas atsargas.
expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1
Pavyzdys: 1
reasonEilutėPrivalomas

Užregistruota pakeitimo priežastis.

minLength: 1maxLength: 500
Pavyzdys: "Withdraw a revoked license"

Papildomi laukai: Ne

Išsiuntimo ir pristatymo datos

DeliveryDatesData · Užsakymų sąraše ir išsamioje informacijoje yra delivery.dates. YYYY-MM-DD datos yra planuojamos ir nepatvirtina išsiuntimo. Dabartinės datos turi pirmenybę; senesni užsakymai naudoja išsaugotą prognozę. Išvalytos arba nežinomos reikšmės yra null. Išsamioje informacijoje taip pat yra visos eilutės ir produktų vaizdai.
dispatch_timezoneEilutė nullPrivalomas

Išsiuntimo laiko juosta (IANA; null).

Pavyzdys: "Europe/Warsaw"
estimated_delivery_fromEilutė nullPrivalomas

Numatomo pristatymo pradžia (YYYY-MM-DD; null).

Eilutė:format: "date"
Pavyzdys: "2026-10-20"
estimated_delivery_toEilutė nullPrivalomas

Numatomo pristatymo pabaiga (YYYY-MM-DD; null).

Eilutė:format: "date"
Pavyzdys: "2026-10-21"
planned_dispatch_onEilutė nullPrivalomas

Planuojama išsiuntimo data (YYYY-MM-DD; null).

Eilutė:format: "date"
Pavyzdys: "2026-10-19"

Papildomi laukai: Ne

DeliveryReplacement

DeliveryReplacement · Pasirinkite esamą laisvą vienetą. Pakeitimas nepradeda saugojimo termino iš naujo.
expected_unit_versionSveikasis skaičiusPrivalomas

Dabartinė laisvo pakaitinio vieneto versija.

minimum: 1
Pavyzdys: 1
expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1
Pavyzdys: 1
reasonEilutėPrivalomas

Užregistruota pakeitimo priežastis.

minLength: 1maxLength: 500
Pavyzdys: "Replace an invalid activation code"
replacement_unit_idEilutėPrivalomas

Esamo laisvo pakaitinio vieneto ID.

format: "uuid"
Pavyzdys: "00000000-0000-4000-8000-000000000008"

Papildomi laukai: Ne

DeliveryPickupPointData

DeliveryPickupPointData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
addressPickupPointAddressData Privalomas

Pristatymo adresas.

codeEilutėPrivalomas

Stabilus kompiuterio skaitomas kodas.

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

Aplinkine schema aprašyta reikšmė.

country_codeEilutėPrivalomas

Šalies kodas.

Apribojimai
pattern
"^[A-Z]{2}$"
environmentEilutėPrivalomas

Prie įrašo pridėta aplinkos informacija.

Apribojimai
enum
["live", "sandbox"]
kindEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai
enum
["locker", "pickup_point"]
location_descriptionEilutė nullPrivalomas

Aprašymas pasirinkta kalba.

Eilutė:maxLength: 1000
nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

minLength: 1maxLength: 160
opening_hoursEilutė nullPrivalomas

Opening hours

Eilutė:maxLength: 500
operatorEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

minLength: 1maxLength: 63
verified_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

Papildomi laukai: Ne

ApiResponse[list[DeliveryData]]

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · Peržiūrėkite priskirtus vienetus be kodų. Pinigų grąžinimas panaikina prieigą tik atitinkamoms pozicijoms.
dataMasyvas <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > Privalomas

Sėkmingo atsakymo duomenys.

Pavyzdys: [{"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 Privalomas

Atsakymo metaduomenys.

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

Papildomi laukai: Ne

DeliveryData

shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · Peržiūrėkite priskirtus vienetus be kodų. Pinigų grąžinimas panaikina prieigą tik atitinkamoms pozicijoms.
can_downloadLoginė reikšmėPrivalomas

Atsisiųsti (true / false)

Pavyzdys: true
content_stateEilutėPrivalomas

Turinio būsena: present / deleting / deleted.

Pavyzdys: "present"
delete_due_atEilutė nullPrivalomas

Suplanuotas failo ištrynimas; null jį išjungia.

Eilutė:format: "date-time"
Pavyzdys: null
filenameEilutė nullPrivalomas

Failas

Pavyzdys: null
first_available_atEilutė nullPrivalomas

Pirmoji pirkimo prieiga; pakeitimas termino nepradeda iš naujo.

Eilutė:format: "date-time"
Pavyzdys: "2026-11-03T12:00:00Z"
generationSveikasis skaičiusPrivalomas

Priskyrimo karta; didėja pakeitus.

Pavyzdys: 1
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.

format: "uuid"
Pavyzdys: "00000000-0000-4000-8000-000000000005"
kindEilutė nullPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Pavyzdys: "code"
line_idEilutėPrivalomas

Pastovus užsakymo eilutės identifikatorius.

Pavyzdys: "line-example"
order_idEilutėPrivalomas

Susijusio užsakymo identifikatorius.

Pavyzdys: "order-example"
payload_idEilutėPrivalomas

Turinio ID; ne viešas atsisiuntimo URL.

format: "uuid"
Pavyzdys: "00000000-0000-4000-8000-000000000012"
product_idEilutėPrivalomas

Produkto identifikatorius.

Pavyzdys: "example"
reasonEilutėPrivalomas

Užregistruota pakeitimo priežastis.

Pavyzdys: ""
size_bytesSveikasis skaičius nullPrivalomas

Dydis baitais

Pavyzdys: null
stateEilutėPrivalomas

Būsena

Pavyzdys: "available"
unit_idEilutėPrivalomas

Vieno individualaus kodo arba failo ID.

format: "uuid"
Pavyzdys: "00000000-0000-4000-8000-000000000011"
unit_ordinalSveikasis skaičiusPrivalomas

Įsigyto vieneto numeris užsakymo eilutėje.

Pavyzdys: 1
variant_idEilutė nullPrivalomas

Produkto varianto identifikatorius.

Pavyzdys: null
versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 2

Papildomi laukai: Ne

Sąskaitos faktūros informacija

InvoiceData · Schema · Duomenų schemos: Užsakymai
address_line_1Eilutė nullPrivalomas

Pirmoji adreso eilutė.

address_line_2Eilutė nullPrivalomas

Papildoma adreso informacija.

cityEilutė nullPrivalomas

Miestas arba gyvenvietė.

company_nameEilutė nullPrivalomas

Įmonės pavadinimas.

country_codeEilutė nullPrivalomas

Šalies kodas.

house_numberEilutė nullPrivalomas

Pastato arba namo numeris.

postal_codeEilutė nullPrivalomas

Pašto kodas.

regionEilutė nullPrivalomas

Administracinis regionas.

streetEilutė nullPrivalomas

Gatvės pavadinimas.

tax_identifierEilutė nullPrivalomas

Mokesčių mokėtojo identifikavimo numeris.

tax_schemeEilutė nullPrivalomas

Mokesčių skaičiavimo schema.

Papildomi laukai: Ne

Grynoji suma / Mokesčio suma / Bendroji suma

OrderAmountBreakdownData · Sumos ir tarifai gaunami iš išsaugoto užsakymo, įskaitant eilučių pataisas. Trūkstami istoriniai duomenys yra null ir nepakeičiami dabartiniais katalogo tarifais. Sumos lieka dešimtainėmis eilutėmis.
grossMoneyData Privalomas

Bendroji suma · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullPrivalomas

Grynoji suma · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullPrivalomas

Mokesčio suma · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"58.60","currency":"PLN","minor_units":2}

Papildomi laukai: Ne

Pristatymas · Nuolaidos

OrderDeliveryDiscountData · Sumos ir tarifai gaunami iš išsaugoto užsakymo, įskaitant eilučių pataisas. Trūkstami istoriniai duomenys yra null ir nepakeičiami dabartiniais katalogo tarifais. Sumos lieka dešimtainėmis eilutėmis.
amountMoneyData Privalomas

Bendroji suma · Pristatymas · Nuolaidos.

Pavyzdys: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.

Pavyzdys: "saved-coupon"
codeEilutė nullPrivalomas

Stabilus kompiuterio skaitomas kodas.

Pavyzdys: "SAVE"
kindEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai
enum
["coupon", "promotion"]
Pavyzdys: "coupon"
nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Saved coupon"
sequenceSveikasis skaičius nullPrivalomas

Pozicija surikiuotame rinkinyje.

Pavyzdys: 1
versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 3

Papildomi laukai: Ne

Gauti — Užsakymai — Atsakymas

OrderDetailData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"
Pavyzdys: "2026-10-19T10:00:00Z"
customerCustomerData Privalomas

Šiam ištekliui užregistruota kliento informacija.

Pavyzdys: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Privalomas

Pristatymo būdas ir susijusi informacija.

Pavyzdys: {"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 Privalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

Pavyzdys: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsMasyvas <OrderDiscountData > Privalomas

Nuolaidos

Pavyzdys: [{"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}]
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (OrderDetailData).

Pavyzdys: "order-0000"
invoiceInvoiceData nullPrivalomas

Sąskaitos faktūros informacija.

Pavyzdys: null
invoice_requestedLoginė reikšmėPrivalomas

Ar prašoma sąskaitos faktūros.

Pavyzdys: false
lifecycle_stateOrderLifecycleState Privalomas

Verslo gyvavimo ciklo būsena.

Pavyzdys: "placed"
linesMasyvas <OrderLineData > Privalomas

Užsakymo eilučių momentinės kopijos.

Pavyzdys: [{"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":[]}]
localeEilutėPrivalomas

Šiai užklausai pasirinkta kalba.

Pavyzdys: "pl"
market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

Pavyzdys: "market-pl"
numberEilutėPrivalomas

Žmogui rodomas užsakymo arba prašymo numeris.

Pavyzdys: "0001"
paymentPaymentData Privalomas

Užsakymui užregistruoti mokėjimo duomenys.

Pavyzdys: {"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 nullPrivalomas

Atsiėmimo vieta

Pavyzdys: null
prices_include_taxLoginė reikšmėPrivalomas

Ar nurodytos kainos apima mokesčius.

Pavyzdys: true
shipping_addressAddressData nullPrivalomas

Pristatymo adresas.

Pavyzdys: null
shipping_discount_amountMoneyData Privalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

Pavyzdys: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Privalomas

Šios konkrečios operacijos priimama būsena.

Pavyzdys: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Privalomas

Suma prieš papildomus atsakyme parodytus komponentus.

Pavyzdys: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Privalomas

Mokesčių informacija.

Pavyzdys: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Privalomas

Mokesčių grupės · source + tax_rate; unallocated_tax.

Pavyzdys: {"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_codeEilutė nullPrivalomas

Apmokestinimo šalis · Išsaugoti užsakymo duomenys · ISO 3166-1 alpha-2; null.

Pavyzdys: "PL"
totalMoneyData Privalomas

Bendra suma.

Pavyzdys: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Privalomas

Suvestinės · net / tax / gross; Prieš nuolaidas / Po nuolaidų.

Pavyzdys: {"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}}}

Papildomi laukai: Ne

OrderFileData

OrderFileData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai. Sukūrę upload_id siųskite failus kaip multipart/form-data ir susiekite juos su produktu. Atsisiuntimui reikia Bearer žetono ir category leidimo; atsakyme pateikiami failo baitai be viešo adreso ar slaptažodžio. Kai mode=period, rinkitės days (1–3650) arba ankstesnį months, bet ne abu. Sąlygos išsaugomos perkant; grąžinus pinigus panaikinama prieiga tik prie grąžintos eilutės.
can_downloadLoginė reikšmėPrivalomas

Atsisiųsti (true / false)

Pavyzdys: true
categoryFileCategory Privalomas

Failo kategorija: internal / customer_document / digital

Pavyzdys: "digital"
filenameEilutėPrivalomas

Failas

Pavyzdys: "manual.pdf"
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.

Pavyzdys: "example"
labelEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Manual"
line_idEilutėPrivalomas

Pastovus užsakymo eilutės identifikatorius.

Pavyzdys: "example"
mime_typeEilutėPrivalomas

Medijos turinio tipas.

Pavyzdys: "application/pdf"
product_idEilutėPrivalomas

Produkto identifikatorius.

Pavyzdys: "example"
purchase_idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. · purchase_id

Pavyzdys: "00000000-0000-4000-8000-000000000001"
reasonEilutėPrivalomas

Užregistruota pakeitimo priežastis.

Pavyzdys: "paid"
sha256EilutėPrivalomas

SHA-256 (hex, 64)

Pavyzdys: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesSveikasis skaičiusPrivalomas

Dydis baitais

minimum: 1maximum: 262144000
Pavyzdys: 46
source_file_idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. · source_file_id

Pavyzdys: "00000000-0000-4000-8000-000000000001"
source_version_idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. · source_version_id

Pavyzdys: "00000000-0000-4000-8000-000000000001"
source_version_numberSveikasis skaičiusPrivalomas

Versija

minimum: 1
Pavyzdys: 1
stateEilutėPrivalomas

Būsena

Pavyzdys: "active"

Papildomi laukai: Ne

OrderFileListData

OrderFileListData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai. Sukūrę upload_id siųskite failus kaip multipart/form-data ir susiekite juos su produktu. Atsisiuntimui reikia Bearer žetono ir category leidimo; atsakyme pateikiami failo baitai be viešo adreso ar slaptažodžio. Kai mode=period, rinkitės days (1–3650) arba ankstesnį months, bet ne abu. Sąlygos išsaugomos perkant; grąžinus pinigus panaikinama prieiga tik prie grąžintos eilutės.
filesMasyvas <OrderFileData > Privalomas

Produkto failai

Pavyzdys: [{"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_pendingLoginė reikšmėPrivalomas

Prieiga prie būsimų failų po pirkimo · updates_pending

Pavyzdys: false

Papildomi laukai: Ne

Paveikslėlio metaduomenys ir URL

OrderImageData · Schema · Duomenų schemos: Užsakymai
altEilutė nullPrivalomas

Alternatyvus paveikslėlio tekstas.

sourceEilutėNeprivalomas

Užregistruotos veiklos šaltinis.

const: "current_catalog"
Numatytoji reikšmė: "current_catalog"
urlEilutėPrivalomas

Ištekliaus URL.

Papildomi laukai: Ne

Verslo gyvavimo ciklo būsena

OrderLifecycleState · Schema · Duomenų schemos: Užsakymai Eilutė
Apribojimai
enum
["placed", "cancelled", "fulfilled", "returned"]

Papildomi laukai: Taip

Užsakymo eilučių momentinės kopijos

OrderLineData · Schema · Duomenų schemos: Užsakymai
discount_amountMoneyData Privalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

Pavyzdys: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Privalomas

Bendroji suma · Nuolaidos; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullPrivalomas

Grynoji suma · Nuolaidos; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullPrivalomas

Mokesčio suma · Nuolaidos; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsMasyvas <OrderDiscountData > Privalomas

Nuolaidos · net / tax / gross.

Pavyzdys: [{"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}]
identifiersObjektasPapildomi laukai: EilutėPrivalomas

Produkto identifikavimo kodai.

Pavyzdys: {}
imageOrderImageData nullPrivalomas

Paveikslėlio metaduomenys ir URL.

Pavyzdys: null
line_idEilutėPrivalomas

Pastovus užsakymo eilutės identifikatorius.

Pavyzdys: "saved-line-a"
manual_discountOrderManualDiscountData nullPrivalomas

Rankinė nuolaida; null.

Pavyzdys: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Saved A"
original_totalMoneyData Privalomas

Bendra suma.

Pavyzdys: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Privalomas

Bendroji suma · Produktai · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullPrivalomas

Grynoji suma · Produktai · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullPrivalomas

Mokesčio suma · Produktai · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"46.00","currency":"PLN","minor_units":2}
positionSveikasis skaičiusPrivalomas

Pozicija surikiuotame rinkinyje.

Pavyzdys: 1
product_idEilutėPrivalomas

Produkto identifikatorius.

Pavyzdys: "product-api"
quantitySveikasis skaičiusPrivalomas

Vienetų skaičius.

Pavyzdys: 2
skuEilutėPrivalomas

Atsargų apskaitos vieneto kodas.

Pavyzdys: "A"
taxMoneyData nullPrivalomas

Mokesčio suma · Vienas vienetas · Išsaugoti užsakymo duomenys; tax ≠ unit_tax; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idEilutė nullPrivalomas

Mokesčių kategorijos identifikatorius · Išsaugoti užsakymo duomenys; null.

Pavyzdys: "standard"
tax_category_nameEilutė nullPrivalomas

Išsaugotas mokesčių kategorijos pavadinimas; null.

Pavyzdys: "VAT 23%"
tax_rateEilutė nullPrivalomas

tax_rate · Išsaugoti užsakymo duomenys: "0.23" = 23%; "0" ≠ null.

Pavyzdys: "0.23"
totalMoneyData Privalomas

Bendra suma.

Pavyzdys: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Privalomas

Bendroji suma · Produktai · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullPrivalomas

Grynoji suma · Produktai · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullPrivalomas

Mokesčio suma · Produktai · Po nuolaidų · Išsaugoti užsakymo duomenys; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Privalomas

Bendroji suma · Vienas vienetas · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullPrivalomas

Grynoji suma · Vienas vienetas · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Privalomas

Vieneto kaina.

Pavyzdys: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullPrivalomas

Mokesčio suma · Vienas vienetas · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idEilutė nullPrivalomas

Produkto varianto identifikatorius.

Pavyzdys: null
variant_optionsMasyvas <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Privalomas

Su produktu arba momentine kopija susijusios varianto parinktys.

Pavyzdys: []

Papildomi laukai: Ne

Rankinė nuolaida

OrderManualDiscountData · Sumos ir tarifai gaunami iš išsaugoto užsakymo, įskaitant eilučių pataisas. Trūkstami istoriniai duomenys yra null ir nepakeičiami dabartiniais katalogo tarifais. Sumos lieka dešimtainėmis eilutėmis.
amountMoneyData Privalomas

Bendroji suma · Rankinė nuolaida · Išsaugoti užsakymo duomenys.

Pavyzdys: {"amount":"12.30","currency":"PLN","minor_units":2}
kindEilutėPrivalomas

Nuolaidos tipas: percentage / fixed.

Apribojimai
enum
["percentage", "fixed"]
Pavyzdys: "fixed"
valueEilutėPrivalomas

Nustatyta vertė: percentage "10" = 10%; fixed = Bendroji suma.

Pavyzdys: "12.30"

Papildomi laukai: Ne

Šios konkrečios operacijos priimama būsena

OrderPaymentStatus · Schema · Duomenų schemos: Užsakymai Eilutė
Apribojimai
enum
["unpaid", "paid", "failed", "refunded"]

Papildomi laukai: Taip

OrderReleaseData

OrderReleaseData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai. Sukūrę upload_id siųskite failus kaip multipart/form-data ir susiekite juos su produktu. Atsisiuntimui reikia Bearer žetono ir category leidimo; atsakyme pateikiami failo baitai be viešo adreso ar slaptažodžio. Kai mode=period, rinkitės days (1–3650) arba ankstesnį months, bet ne abu. Sąlygos išsaugomos perkant; grąžinus pinigus panaikinama prieiga tik prie grąžintos eilutės.
access_reasonEilutėPrivalomas

Prieiga po pirkimo · Užregistruota pakeitimo priežastis.

Pavyzdys: "paid"
access_stateEilutėPrivalomas

Prieiga po pirkimo · Būsena

Pavyzdys: "active"
current_releaseCurrentReleaseData nullPrivalomas

Skaitmeniniai leidimai · current_release

Pavyzdys: null
grant_reasonEilutėPrivalomas

Prieiga po pirkimo · Užregistruota pakeitimo priežastis.

Pavyzdys: "purchase"
granted_atEilutėPrivalomas

Prieiga po pirkimo · UTC

format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.

Pavyzdys: "example"
line_idEilutėPrivalomas

Pastovus užsakymo eilutės identifikatorius.

Pavyzdys: "example"
manifest_sha256EilutėPrivalomas

Skaitmeniniai leidimai · SHA-256

Pavyzdys: "1111111111111111111111111111111111111111111111111111111111111111"
product_idEilutėPrivalomas

Produkto identifikatorius.

Pavyzdys: "example"
published_atEilutėPrivalomas

Paskelbti leidimą · UTC

format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
purchase_idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. · purchase_id

Pavyzdys: "00000000-0000-4000-8000-000000000001"
release_idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. · release_id

Pavyzdys: "00000000-0000-4000-8000-000000000001"
release_sequenceSveikasis skaičiusPrivalomas

Skaitmeniniai leidimai · Pozicija surikiuotame rinkinyje.

Pavyzdys: 1
update_daysSveikasis skaičius nullPrivalomas

Dienų skaičius (days; null)

Pavyzdys: 365
update_modeEilutėPrivalomas

Prieiga prie būsimų failų po pirkimo: none / period / unlimited

Pavyzdys: "period"
update_monthsSveikasis skaičius nullPrivalomas

Mėnesiai (months; null)

Pavyzdys: null
updates_untilEilutė nullPrivalomas

Prieiga prie būsimų failų po pirkimo · UTC

Eilutė:format: "date-time"
Pavyzdys: "2027-01-01T12:00:00Z"
version_labelEilutėPrivalomas

Versija

Pavyzdys: "1.0"

Papildomi laukai: Ne

OrderReleaseListData

OrderReleaseListData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai. Sukūrę upload_id siųskite failus kaip multipart/form-data ir susiekite juos su produktu. Atsisiuntimui reikia Bearer žetono ir category leidimo; atsakyme pateikiami failo baitai be viešo adreso ar slaptažodžio. Kai mode=period, rinkitės days (1–3650) arba ankstesnį months, bet ne abu. Sąlygos išsaugomos perkant; grąžinus pinigus panaikinama prieiga tik prie grąžintos eilutės.
releasesMasyvas <OrderReleaseData > Privalomas

Skaitmeniniai leidimai

Pavyzdys: [{"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_pendingLoginė reikšmėPrivalomas

Prieiga prie būsimų failų po pirkimo · updates_pending

Pavyzdys: false

Papildomi laukai: Ne

Šios konkrečios operacijos priimama būsena

OrderStatusData · Schema · Duomenų schemos: Užsakymai
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (OrderStatusData).

Pavyzdys: "status-0"
nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Status 0"
updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"
Pavyzdys: "2026-10-19T10:00:00Z"
versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Sąrašas · Būsenos — Užsakymai — Atsakymas

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Pavyzdys: "status-0"
is_initialLoginė reikšmėPrivalomas

Ar tai pradinė būsena.

Pavyzdys: true
nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "New"
positionSveikasis skaičiusPrivalomas

Pozicija surikiuotame rinkinyje.

Pavyzdys: 0

Papildomi laukai: Ne

Sąrašas · Būsenos — Užsakymai — Atsakymas

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
dataMasyvas <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Privalomas

Atsakymo pavyzdys · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Pavyzdys: [{"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 Privalomas

Atsakymo metaduomenys.

Pavyzdys: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildomi laukai: Ne

Atnaujinti · Būsena — Užsakymai — Užklausos turinys

OrderStatusUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807
Pavyzdys: 1
status_idEilutėPrivalomas

Iš atitinkamo būsenų žinyno gautas identifikatorius.

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

Papildomi laukai: Ne

Sąrašas — Užsakymai — Atsakymas

OrderSummaryData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"
Pavyzdys: "2026-10-19T10:00:00Z"
customerCustomerData Privalomas

Šiam ištekliui užregistruota kliento informacija.

Pavyzdys: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Privalomas

Pristatymo būdas ir susijusi informacija.

Pavyzdys: {"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 Privalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

Pavyzdys: {"amount":"24.60","currency":"PLN","minor_units":2}
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (OrderSummaryData).

Pavyzdys: "order-0000"
lifecycle_stateOrderLifecycleState Privalomas

Verslo gyvavimo ciklo būsena.

Pavyzdys: "placed"
localeEilutėPrivalomas

Šiai užklausai pasirinkta kalba.

Pavyzdys: "pl"
market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

Pavyzdys: "market-pl"
numberEilutėPrivalomas

Žmogui rodomas užsakymo arba prašymo numeris.

Pavyzdys: "0001"
paymentPaymentData Privalomas

Užsakymui užregistruoti mokėjimo duomenys.

Pavyzdys: {"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_taxLoginė reikšmėPrivalomas

Ar nurodytos kainos apima mokesčius.

Pavyzdys: true
shipping_discount_amountMoneyData Privalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

Pavyzdys: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Privalomas

Šios konkrečios operacijos priimama būsena.

Pavyzdys: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Privalomas

Suma prieš papildomus atsakyme parodytus komponentus.

Pavyzdys: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Privalomas

Mokesčių informacija.

Pavyzdys: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeEilutė nullPrivalomas

Apmokestinimo šalis · Išsaugoti užsakymo duomenys · ISO 3166-1 alpha-2; null.

Pavyzdys: "PL"
totalMoneyData Privalomas

Bendra suma.

Pavyzdys: {"amount":"329.40","currency":"PLN","minor_units":2}

Papildomi laukai: Ne

Užsakymas · Mokesčių grupės

OrderTaxBreakdownData · Sumos ir tarifai gaunami iš išsaugoto užsakymo, įskaitant eilučių pataisas. Trūkstami istoriniai duomenys yra null ir nepakeičiami dabartiniais katalogo tarifais. Sumos lieka dešimtainėmis eilutėmis.
groupsMasyvas <OrderTaxGroupData > Privalomas

Mokesčių grupės · source + tax_rate; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: [{"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 Privalomas

Nepriskirtas mokestis = order.tax − Σ groups.tax; ±.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2}

Papildomi laukai: Ne

Mokesčių grupės

OrderTaxGroupData · Sumos ir tarifai gaunami iš išsaugoto užsakymo, įskaitant eilučių pataisas. Trūkstami istoriniai duomenys yra null ir nepakeičiami dabartiniais katalogo tarifais. Sumos lieka dešimtainėmis eilutėmis.
grossMoneyData Privalomas

Bendroji suma · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullPrivalomas

Grynoji suma · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceEilutėPrivalomas

Šaltinis: products (Produktai), shipping (Pristatymas).

Apribojimai
enum
["products", "shipping"]
Pavyzdys: "products"
taxMoneyData nullPrivalomas

Mokesčio suma · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateEilutė nullPrivalomas

tax_rate · Išsaugoti užsakymo duomenys: "0.23" = 23%; "0" ≠ null.

Pavyzdys: "0.23"

Papildomi laukai: Ne

Užsakymas · Suvestinės

OrderTotalsData · Sumos ir tarifai gaunami iš išsaugoto užsakymo, įskaitant eilučių pataisas. Trūkstami istoriniai duomenys yra null ir nepakeičiami dabartiniais katalogo tarifais. Sumos lieka dešimtainėmis eilutėmis.
before_discountsOrderAmountBreakdownData Privalomas

Užsakymas · Prieš nuolaidas · net / tax / gross.

Pavyzdys: {"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 Privalomas

Nuolaidos · net / tax / gross.

Pavyzdys: {"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 Privalomas

Užsakymas · Po nuolaidų · net / tax / gross.

Pavyzdys: {"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 Privalomas

Produktai · Nuolaidos · net / tax / gross.

Pavyzdys: {"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 Privalomas

Produktai · Po nuolaidų · net / tax / gross.

Pavyzdys: {"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 Privalomas

Produktai · Prieš nuolaidas · net / tax / gross.

Pavyzdys: {"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 Privalomas

Pristatymas · Po nuolaidų · net / tax / gross.

Pavyzdys: {"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 Privalomas

Pristatymas · Prieš nuolaidas · net / tax / gross.

Pavyzdys: {"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 Privalomas

Pristatymas · Nuolaidos · net / tax / gross.

Pavyzdys: {"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}}

Papildomi laukai: Ne

Su produktu arba momentine kopija susijusios varianto parinktys

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Schema · Duomenų schemos: Užsakymai
nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

valueEilutėPrivalomas

Aplinkine schema aprašyta reikšmė.

Papildomi laukai: Ne

OrderDiscountData

OrderDiscountData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
amountMoneyData Privalomas

Bendroji suma · Produktai · Nuolaidos.

Pavyzdys: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.

Pavyzdys: "saved-coupon"
codeEilutė nullPrivalomas

Stabilus kompiuterio skaitomas kodas.

Pavyzdys: "SAVE"
kindEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai
enum
["coupon", "promotion"]
Pavyzdys: "coupon"
nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Saved coupon"
sequenceSveikasis skaičius nullNeprivalomas

Taikymo tvarka; null.

Pavyzdys: 1
shipping_amountMoneyData nullNeprivalomas

Bendroji suma · Pristatymas · Nuolaidos; null.

Pavyzdys: {"amount":"24.60","currency":"PLN","minor_units":2}
versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 3

Papildomi laukai: Ne

Užsakymui užregistruoti mokėjimo duomenys

PaymentData · Schema · Duomenų schemos: Užsakymai
amountMoneyData Privalomas

payment.amount yra užsakymo bendra suma. Mokėjimo būsena nenustato sumokėtų, grąžintų ar nesumokėtų sumų.

Pavyzdys: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentEilutėPrivalomas

Prie įrašo pridėta aplinkos informacija.

Apribojimai
enum
["live", "sandbox"]
Pavyzdys: "live"
method_codeEilutė nullPrivalomas

Pristatymo arba mokėjimo būdo kodas.

Pavyzdys: "payment-old"
method_nameEilutė nullPrivalomas

Pristatymo arba mokėjimo būdo pavadinimas.

Pavyzdys: "Historic method"
paid_atEilutė nullPrivalomas

Data ir laikas, kai mokėjimas pažymėtas kaip apmokėtas.

Eilutė:format: "date-time"
Pavyzdys: null
statusOrderPaymentStatus Privalomas

Šios konkrečios operacijos priimama būsena.

Pavyzdys: "unpaid"
updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"
Pavyzdys: "2026-10-19T10:00:00Z"
versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 0

Papildomi laukai: Ne

Atnaujinti · Mokėjimo būsena — Užsakymai — Užklausos turinys

PaymentStatusUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 0maximum: 9223372036854775807
Pavyzdys: 0
reasonEilutėPrivalomas

Užregistruota pakeitimo priežastis.

minLength: 1maxLength: 500
Pavyzdys: "Bank transfer confirmed"
statusPaymentStatus Privalomas

Šios konkrečios operacijos priimama būsena. unpaid: neapmokėta; paid: apmokėta; failed: mokėjimas nepavyko; refunded: grąžinta.

Pavyzdys: "paid"

Papildomi laukai: Ne

Šios konkrečios operacijos priimama būsena

PaymentStatus · Schema · Duomenų schemos: Užsakymai Eilutė
Apribojimai
enum
["unpaid", "paid", "failed", "refunded"]

Papildomi laukai: Taip

PickupPointAddressData

PickupPointAddressData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
address_line_1EilutėPrivalomas

Pirmoji adreso eilutė.

minLength: 1maxLength: 240
cityEilutėPrivalomas

Miestas arba gyvenvietė.

minLength: 1maxLength: 160
postal_codeEilutėPrivalomas

Pašto kodas.

minLength: 1maxLength: 32

Papildomi laukai: Ne

PickupPointCoordinatesData

PickupPointCoordinatesData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
latitudeSkaičiusPrivalomas

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeSkaičiusPrivalomas

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Papildomi laukai: Ne

PickupPointData

PickupPointData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
address_line1EilutėPrivalomas

Pirmoji adreso eilutė.

cityEilutėPrivalomas

Miestas arba gyvenvietė.

codeEilutėPrivalomas

Stabilus kompiuterio skaitomas kodas.

country_codeEilutėPrivalomas

Šalies kodas.

kindEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai
enum
["locker", "pickup_point"]
latitudeSkaičius nullPrivalomas

WGS84 φ (°)

location_descriptionEilutė nullPrivalomas

Aprašymas pasirinkta kalba.

longitudeSkaičius nullPrivalomas

WGS84 λ (°)

nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

opening_hoursEilutė nullPrivalomas

Opening hours

operatorEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

postal_codeEilutėPrivalomas

Pašto kodas.

Papildomi laukai: Ne

PickupPointSummaryData

PickupPointSummaryData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
codeEilutėPrivalomas

Stabilus kompiuterio skaitomas kodas.

Apribojimai
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeEilutėPrivalomas

Šalies kodas.

Apribojimai
pattern
"^[A-Z]{2}$"
environmentEilutėPrivalomas

Prie įrašo pridėta aplinkos informacija.

Apribojimai
enum
["live", "sandbox"]
kindEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai
enum
["locker", "pickup_point"]
operatorEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

minLength: 1maxLength: 63

Papildomi laukai: Ne

Šiam ištekliui užregistruota kliento informacija

RequestCustomerData · Schema · Duomenų schemos: Užsakymai
emailEilutėPrivalomas

El. pašto adresas.

Pavyzdys: "customer@example.invalid"
nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Example"

Papildomi laukai: Ne

Pristatymo būdas ir susijusi informacija

ShippingData · Schema · Duomenų schemos: Užsakymai
amountMoneyData Privalomas

Užsakyme kaip MoneyData įrašyta pristatymo suma su mokesčiais. Vėlesni mokesčių pakeitimai šios istorinės sumos nekeičia.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Privalomas

Išsiuntimo ir pristatymo datos. Užsakymų sąraše ir išsamioje informacijoje yra delivery.dates. YYYY-MM-DD datos yra planuojamos ir nepatvirtina išsiuntimo. Dabartinės datos turi pirmenybę; senesni užsakymai naudoja išsaugotą prognozę. Išvalytos arba nežinomos reikšmės yra null. Išsamioje informacijoje taip pat yra visos eilutės ir produktų vaizdai.

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

Pristatymo arba mokėjimo būdo kodas.

Pavyzdys: "shipping-old"
method_nameEilutė nullPrivalomas

Pristatymo arba mokėjimo būdo pavadinimas.

Pavyzdys: "Historic carrier"
pickup_pointPickupPointSummaryData nullPrivalomas

Atsiėmimo vieta

Pavyzdys: null
recipient_modeEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

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

Papildomi laukai: Ne

ShippingDetailData

ShippingDetailData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
amountMoneyData Privalomas

Užsakyme kaip MoneyData įrašyta pristatymo suma su mokesčiais. Vėlesni mokesčių pakeitimai šios istorinės sumos nekeičia.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Privalomas

Išsiuntimo ir pristatymo datos. Užsakymų sąraše ir išsamioje informacijoje yra delivery.dates. YYYY-MM-DD datos yra planuojamos ir nepatvirtina išsiuntimo. Dabartinės datos turi pirmenybę; senesni užsakymai naudoja išsaugotą prognozę. Išvalytos arba nežinomos reikšmės yra null. Išsamioje informacijoje taip pat yra visos eilutės ir produktų vaizdai.

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

Bendroji suma · Nuolaidos; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullPrivalomas

Grynoji suma · Nuolaidos; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullPrivalomas

Mokesčio suma · Nuolaidos; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsMasyvas <OrderDeliveryDiscountData > nullPrivalomas

Pristatymas · Nuolaidos; []: 0; null: Nežinoma: null; žinomas nulis: 0.

Pavyzdys: [{"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 Privalomas

Bendroji suma · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeEilutė nullPrivalomas

Pristatymo arba mokėjimo būdo kodas.

Pavyzdys: "shipping-old"
method_nameEilutė nullPrivalomas

Pristatymo arba mokėjimo būdo pavadinimas.

Pavyzdys: "Historic carrier"
netMoneyData nullPrivalomas

Grynoji suma · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Privalomas

Bendroji suma · Pristatymas · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullPrivalomas

Grynoji suma · Pristatymas · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullPrivalomas

Mokesčio suma · Pristatymas · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullPrivalomas

Atsiėmimo vieta

Pavyzdys: null
recipient_modeEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Pavyzdys: "full_address"
taxMoneyData nullPrivalomas

Mokesčio suma · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idEilutė nullPrivalomas

Mokesčių kategorijos identifikatorius · Išsaugoti užsakymo duomenys; null.

Pavyzdys: "standard"
tax_category_nameEilutė nullPrivalomas

Išsaugotas mokesčių kategorijos pavadinimas; null.

Pavyzdys: "VAT 23%"
tax_rateEilutė nullPrivalomas

tax_rate · Išsaugoti užsakymo duomenys: "0.23" = 23%; "0" ≠ null.

Pavyzdys: "0.23"

Papildomi laukai: Ne