Схеми даних: Замовлення

address_line_1Рядок | nullОбов’язкове

Перший рядок адреси.

address_line_2Рядок | nullОбов’язкове

Додаткова інформація про адресу.

cityРядок | nullОбов’язкове

Місто або населений пункт.

country_codeРядок | nullОбов’язкове

Код країни.

first_nameРядок | nullОбов’язкове

Ім’я.

house_numberРядок | nullОбов’язкове

Номер будівлі або будинку.

last_nameРядок | nullОбов’язкове

Прізвище.

phoneРядок | nullОбов’язкове

Номер телефону.

postal_codeРядок | nullОбов’язкове

Поштовий індекс.

regionРядок | nullОбов’язкове

Адміністративний регіон.

streetРядок | nullОбов’язкове

Назва вулиці.

Додаткові поля: Ні

dataOrderFileListData Обов’язкове

Дані успішної відповіді.

Приклад: {"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 Обов’язкове

Метадані відповіді.

Приклад: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Додаткові поля: Ні

dataOrderReleaseListData Обов’язкове

Дані успішної відповіді.

Приклад: {"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 Обов’язкове

Метадані відповіді.

Приклад: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Додаткові поля: Ні

dataМасив <OrderSummaryData > Обов’язкове

Приклад відповіді · ApiResponse_list_OrderSummaryData__.

Приклад: [{"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 Обов’язкове

Метадані відповіді.

Приклад: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Додаткові поля: Ні

dataOrderDetailData Обов’язкове

Приклад відповіді · OrderDetailData.

Приклад: {"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 Обов’язкове

Метадані відповіді.

Приклад: {"request_id":"example-request"}

Додаткові поля: Ні

acquiredЛогічне значенняОбов’язкове

Доступ після покупки (true / false)

changelogРядокОбов’язкове

Опис змін

covered_by_purchaseЛогічне значенняОбов’язкове

Доступ після покупки (true / false)

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

published_atРядокОбов’язкове

Опублікувати випуск · UTC

format: "date-time"

requires_new_purchaseЛогічне значенняОбов’язкове

Без доступу до файлів, доданих після покупки · requires_new_purchase

sequenceЦіле числоОбов’язкове

Позиція у впорядкованому списку.

version_labelРядокОбов’язкове

Версія

Додаткові поля: Ні

emailРядокОбов’язкове

Адреса електронної пошти.

Приклад: "customer@example.invalid"

first_nameРядок | nullОбов’язкове

Ім’я.

Приклад: "Example"

last_nameРядок | nullОбов’язкове

Прізвище.

Приклад: "Example"

phoneРядок | nullОбов’язкове

Номер телефону.

Приклад: null

Додаткові поля: Ні

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1

Приклад: 1

reasonРядокОбов’язкове

Записана причина зміни.

minLength: 1maxLength: 500

Приклад: "Withdraw a revoked license"

Додаткові поля: Ні

dispatch_timezoneРядок | nullОбов’язкове

Часовий пояс відправлення (IANA; null).

Приклад: "Europe/Warsaw"

estimated_delivery_fromРядок | nullОбов’язкове

Початок очікуваної доставки (YYYY-MM-DD; null).

Рядок:format: "date"

Приклад: "2026-10-20"

estimated_delivery_toРядок | nullОбов’язкове

Кінець очікуваної доставки (YYYY-MM-DD; null).

Рядок:format: "date"

Приклад: "2026-10-21"

planned_dispatch_onРядок | nullОбов’язкове

Запланована дата відправлення (YYYY-MM-DD; null).

Рядок:format: "date"

Приклад: "2026-10-19"

Додаткові поля: Ні

expected_unit_versionЦіле числоОбов’язкове

Поточна версія вільної одиниці для заміни.

minimum: 1

Приклад: 1

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1

Приклад: 1

reasonРядокОбов’язкове

Записана причина зміни.

minLength: 1maxLength: 500

Приклад: "Replace an invalid activation code"

replacement_unit_idРядокОбов’язкове

ID наявної вільної одиниці для заміни.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000008"

Додаткові поля: Ні

addressPickupPointAddressData Обов’язкове

Адреса доставки.

codeРядокОбов’язкове

Стабільний машинозчитуваний код.

Обмеження

pattern

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

coordinatesPickupPointCoordinatesData | nullОбов’язкове

Значення, описане навколишньою схемою.

country_codeРядокОбов’язкове

Код країни.

Обмеження

pattern

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

environmentРядокОбов’язкове

Відомості про середовище, додані до запису.

Обмеження

enum

["live", "sandbox"]

kindРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

["locker", "pickup_point"]

location_descriptionРядок | nullОбов’язкове

Опис вибраною мовою.

Рядок:maxLength: 1000

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

minLength: 1maxLength: 160

opening_hoursРядок | nullОбов’язкове

Opening hours

Рядок:maxLength: 500

operatorРядокОбов’язкове

Назва ресурсу у відповідному контексті.

minLength: 1maxLength: 63

verified_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"

Додаткові поля: Ні

dataМасив <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > Обов’язкове

Дані успішної відповіді.

Приклад: [{"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 Обов’язкове

Метадані відповіді.

Приклад: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Додаткові поля: Ні

can_downloadЛогічне значенняОбов’язкове

Завантажити (true / false)

Приклад: true

content_stateРядокОбов’язкове

Стан вмісту: present / deleting / deleted.

Приклад: "present"

delete_due_atРядок | nullОбов’язкове

Заплановане видалення файлу; null вимикає його.

Рядок:format: "date-time"

Приклад: null

filenameРядок | nullОбов’язкове

Файл

Приклад: null

first_available_atРядок | nullОбов’язкове

Перше надання доступу покупці; заміна не починає строк заново.

Рядок:format: "date-time"

Приклад: "2026-11-03T12:00:00Z"

generationЦіле числоОбов’язкове

Покоління видачі; збільшується після заміни.

Приклад: 1

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000005"

kindРядок | nullОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Приклад: "code"

line_idРядокОбов’язкове

Сталий ідентифікатор позиції замовлення.

Приклад: "line-example"

order_idРядокОбов’язкове

Ідентифікатор пов’язаного замовлення.

Приклад: "order-example"

payload_idРядокОбов’язкове

ID вмісту; не є публічним URL завантаження.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000012"

product_idРядокОбов’язкове

Ідентифікатор товару.

Приклад: "example"

reasonРядокОбов’язкове

Записана причина зміни.

Приклад: ""

size_bytesЦіле число | nullОбов’язкове

Розмір у байтах

Приклад: null

stateРядокОбов’язкове

Статус

Приклад: "available"

unit_idРядокОбов’язкове

ID одного індивідуального коду або файлу.

format: "uuid"

Приклад: "00000000-0000-4000-8000-000000000011"

unit_ordinalЦіле числоОбов’язкове

Номер придбаної одиниці в позиції замовлення.

Приклад: 1

variant_idРядок | nullОбов’язкове

Ідентифікатор варіанта товару.

Приклад: null

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 2

Додаткові поля: Ні

address_line_1Рядок | nullОбов’язкове

Перший рядок адреси.

address_line_2Рядок | nullОбов’язкове

Додаткова інформація про адресу.

cityРядок | nullОбов’язкове

Місто або населений пункт.

company_nameРядок | nullОбов’язкове

Назва компанії.

country_codeРядок | nullОбов’язкове

Код країни.

house_numberРядок | nullОбов’язкове

Номер будівлі або будинку.

postal_codeРядок | nullОбов’язкове

Поштовий індекс.

regionРядок | nullОбов’язкове

Адміністративний регіон.

streetРядок | nullОбов’язкове

Назва вулиці.

tax_identifierРядок | nullОбов’язкове

Податковий ідентифікаційний номер.

tax_schemeРядок | nullОбов’язкове

Схема розрахунку податку.

Додаткові поля: Ні

grossMoneyData Обов’язкове

Сума з податком · Після знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"378.60","currency":"PLN","minor_units":2}

netMoneyData | nullОбов’язкове

Сума без податку · Після знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"320.00","currency":"PLN","minor_units":2}

taxMoneyData | nullОбов’язкове

Сума податку · Після знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"58.60","currency":"PLN","minor_units":2}

Додаткові поля: Ні

amountMoneyData Обов’язкове

Сума з податком · Доставка · Знижки.

Приклад: {"amount":"24.60","currency":"PLN","minor_units":2}

campaign_idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

Приклад: "saved-coupon"

codeРядок | nullОбов’язкове

Стабільний машинозчитуваний код.

Приклад: "SAVE"

kindРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

["coupon", "promotion"]

Приклад: "coupon"

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

Приклад: "Saved coupon"

sequenceЦіле число | nullОбов’язкове

Позиція у впорядкованому списку.

Приклад: 1

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 3

Додаткові поля: Ні

created_atРядокОбов’язкове

Час створення.

format: "date-time"

Приклад: "2026-10-19T10:00:00Z"

customerCustomerData Обов’язкове

Відомості про клієнта, записані для цього ресурсу.

Приклад: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}

deliveryShippingDetailData Обов’язкове

Спосіб доставки та пов’язані відомості.

Приклад: {"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 Обов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

Приклад: {"amount":"24.60","currency":"PLN","minor_units":2}

discountsМасив <OrderDiscountData > Обов’язкове

Знижки

Приклад: [{"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РядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (OrderDetailData).

Приклад: "order-0000"

invoiceInvoiceData | nullОбов’язкове

Відомості для рахунка-фактури.

Приклад: null

invoice_requestedЛогічне значенняОбов’язкове

Чи було запитано рахунок-фактуру.

Приклад: false

lifecycle_stateOrderLifecycleState Обов’язкове

Стан бізнесового життєвого циклу.

Приклад: "placed"

linesМасив <OrderLineData > Обов’язкове

Збережені знімки позицій замовлення.

Приклад: [{"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"

paymentPaymentData Обов’язкове

Відомості про оплату, записані для замовлення.

Приклад: {"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 | nullОбов’язкове

Пункт отримання

Приклад: null

prices_include_taxЛогічне значенняОбов’язкове

Чи включають наведені ціни податок.

Приклад: true

shipping_addressAddressData | nullОбов’язкове

Адреса доставки.

Приклад: null

shipping_discount_amountMoneyData Обов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

Приклад: {"amount":"24.60","currency":"PLN","minor_units":2}

statusOrderStatusData Обов’язкове

Статус, допустимий для цієї конкретної операції.

Приклад: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}

subtotalMoneyData Обов’язкове

Сума до додавання інших складових, наведених у відповіді.

Приклад: {"amount":"329.40","currency":"PLN","minor_units":2}

taxMoneyData Обов’язкове

Відомості про податок.

Приклад: {"amount":"49.40","currency":"PLN","minor_units":2}

tax_breakdownOrderTaxBreakdownData Обов’язкове

Податкові групи · source + tax_rate; unallocated_tax.

Приклад: {"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Рядок | nullОбов’язкове

Країна оподаткування · Збережені дані замовлення · ISO 3166-1 alpha-2; null.

Приклад: "PL"

totalMoneyData Обов’язкове

Загальна сума.

Приклад: {"amount":"329.40","currency":"PLN","minor_units":2}

totalsOrderTotalsData Обов’язкове

Підсумки · net / tax / gross; До знижок / Після знижок.

Приклад: {"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}}}

Додаткові поля: Ні

can_downloadЛогічне значенняОбов’язкове

Завантажити (true / false)

Приклад: true

categoryFileCategory Обов’язкове

Категорія файлу: internal / customer_document / digital

Приклад: "digital"

filenameРядокОбов’язкове

Файл

Приклад: "manual.pdf"

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

Приклад: "example"

labelРядокОбов’язкове

Назва ресурсу у відповідному контексті.

Приклад: "Manual"

line_idРядокОбов’язкове

Сталий ідентифікатор позиції замовлення.

Приклад: "example"

mime_typeРядокОбов’язкове

Тип вмісту медіафайлу.

Приклад: "application/pdf"

product_idРядокОбов’язкове

Ідентифікатор товару.

Приклад: "example"

purchase_idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. · purchase_id

Приклад: "00000000-0000-4000-8000-000000000001"

reasonРядокОбов’язкове

Записана причина зміни.

Приклад: "paid"

sha256РядокОбов’язкове

SHA-256 (hex, 64)

Приклад: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"

size_bytesЦіле числоОбов’язкове

Розмір у байтах

minimum: 1maximum: 262144000

Приклад: 46

source_file_idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. · source_file_id

Приклад: "00000000-0000-4000-8000-000000000001"

source_version_idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. · source_version_id

Приклад: "00000000-0000-4000-8000-000000000001"

source_version_numberЦіле числоОбов’язкове

Версія

minimum: 1

Приклад: 1

stateРядокОбов’язкове

Статус

Приклад: "active"

Додаткові поля: Ні

filesМасив <OrderFileData > Обов’язкове

Файли товару

Приклад: [{"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Логічне значенняОбов’язкове

Доступ до майбутніх файлів після покупки · updates_pending

Приклад: false

Додаткові поля: Ні

altРядок | nullОбов’язкове

Альтернативний текст зображення.

sourceРядокНеобов’язкове

Джерело записаної активності.

const: "current_catalog"

За замовчуванням: "current_catalog"

urlРядокОбов’язкове

URL ресурсу.

Додаткові поля: Ні

Додаткові поля: Так

discount_amountMoneyData Обов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

Приклад: {"amount":"24.60","currency":"PLN","minor_units":2}

discount_grossMoneyData Обов’язкове

Сума з податком · Знижки; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"24.60","currency":"PLN","minor_units":2}

discount_netMoneyData | nullОбов’язкове

Сума без податку · Знижки; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"20.00","currency":"PLN","minor_units":2}

discount_taxMoneyData | nullОбов’язкове

Сума податку · Знижки; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"4.60","currency":"PLN","minor_units":2}

discountsМасив <OrderDiscountData > Обов’язкове

Знижки · net / tax / gross.

Приклад: [{"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Об’єктДодаткові поля: РядокОбов’язкове

Ідентифікаційні коди товару.

Приклад: {}

imageOrderImageData | nullОбов’язкове

Метадані та URL зображення.

Приклад: null

line_idРядокОбов’язкове

Сталий ідентифікатор позиції замовлення.

Приклад: "saved-line-a"

manual_discountOrderManualDiscountData | nullОбов’язкове

Ручна знижка; null.

Приклад: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

Приклад: "Saved A"

original_totalMoneyData Обов’язкове

Загальна сума.

Приклад: {"amount":"246.00","currency":"PLN","minor_units":2}

original_total_grossMoneyData Обов’язкове

Сума з податком · Товари · До знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"246.00","currency":"PLN","minor_units":2}

original_total_netMoneyData | nullОбов’язкове

Сума без податку · Товари · До знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"200.00","currency":"PLN","minor_units":2}

original_total_taxMoneyData | nullОбов’язкове

Сума податку · Товари · До знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"46.00","currency":"PLN","minor_units":2}

positionЦіле числоОбов’язкове

Позиція у впорядкованому списку.

Приклад: 1

product_idРядокОбов’язкове

Ідентифікатор товару.

Приклад: "product-api"

quantityЦіле числоОбов’язкове

Кількість одиниць.

Приклад: 2

skuРядокОбов’язкове

Код складської облікової одиниці.

Приклад: "A"

taxMoneyData | nullОбов’язкове

Сума податку · Одна одиниця · Збережені дані замовлення; tax ≠ unit_tax; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"20.70","currency":"PLN","minor_units":2}

tax_category_idРядок | nullОбов’язкове

Ідентифікатор податкової категорії · Збережені дані замовлення; null.

Приклад: "standard"

tax_category_nameРядок | nullОбов’язкове

Збережена назва податкової категорії; null.

Приклад: "VAT 23%"

tax_rateРядок | nullОбов’язкове

tax_rate · Збережені дані замовлення: "0.23" = 23%; "0" ≠ null.

Приклад: "0.23"

totalMoneyData Обов’язкове

Загальна сума.

Приклад: {"amount":"221.40","currency":"PLN","minor_units":2}

total_grossMoneyData Обов’язкове

Сума з податком · Товари · Після знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"221.40","currency":"PLN","minor_units":2}

total_netMoneyData | nullОбов’язкове

Сума без податку · Товари · Після знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"180.00","currency":"PLN","minor_units":2}

total_taxMoneyData | nullОбов’язкове

Сума податку · Товари · Після знижок · Збережені дані замовлення; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"41.40","currency":"PLN","minor_units":2}

unit_grossMoneyData Обов’язкове

Сума з податком · Одна одиниця · До знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"123.00","currency":"PLN","minor_units":2}

unit_netMoneyData | nullОбов’язкове

Сума без податку · Одна одиниця · До знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"100.00","currency":"PLN","minor_units":2}

unit_priceMoneyData Обов’язкове

Ціна за одиницю.

Приклад: {"amount":"123.00","currency":"PLN","minor_units":2}

unit_taxMoneyData | nullОбов’язкове

Сума податку · Одна одиниця · До знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"23.00","currency":"PLN","minor_units":2}

variant_idРядок | nullОбов’язкове

Ідентифікатор варіанта товару.

Приклад: null

variant_optionsМасив <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Обов’язкове

Опції варіантів, пов’язані з товаром або знімком даних.

Приклад: []

Додаткові поля: Ні

amountMoneyData Обов’язкове

Сума з податком · Ручна знижка · Збережені дані замовлення.

Приклад: {"amount":"12.30","currency":"PLN","minor_units":2}

kindРядокОбов’язкове

Тип знижки: percentage / fixed.

Обмеження

enum

["percentage", "fixed"]

Приклад: "fixed"

valueРядокОбов’язкове

Задане значення: percentage "10" = 10%; fixed = Сума з податком.

Приклад: "12.30"

Додаткові поля: Ні

Додаткові поля: Так

access_reasonРядокОбов’язкове

Доступ після покупки · Записана причина зміни.

Приклад: "paid"

access_stateРядокОбов’язкове

Доступ після покупки · Статус

Приклад: "active"

current_releaseCurrentReleaseData | nullОбов’язкове

Цифрові випуски · current_release

Приклад: null

grant_reasonРядокОбов’язкове

Доступ після покупки · Записана причина зміни.

Приклад: "purchase"

granted_atРядокОбов’язкове

Доступ після покупки · UTC

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

Приклад: "example"

line_idРядокОбов’язкове

Сталий ідентифікатор позиції замовлення.

Приклад: "example"

manifest_sha256РядокОбов’язкове

Цифрові випуски · SHA-256

Приклад: "1111111111111111111111111111111111111111111111111111111111111111"

product_idРядокОбов’язкове

Ідентифікатор товару.

Приклад: "example"

published_atРядокОбов’язкове

Опублікувати випуск · UTC

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

purchase_idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. · purchase_id

Приклад: "00000000-0000-4000-8000-000000000001"

release_idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. · release_id

Приклад: "00000000-0000-4000-8000-000000000001"

release_sequenceЦіле числоОбов’язкове

Цифрові випуски · Позиція у впорядкованому списку.

Приклад: 1

update_daysЦіле число | nullОбов’язкове

Кількість днів (days; null)

Приклад: 365

update_modeРядокОбов’язкове

Доступ до майбутніх файлів після покупки: none / period / unlimited

Приклад: "period"

update_monthsЦіле число | nullОбов’язкове

Місяці (months; null)

Приклад: null

updates_untilРядок | nullОбов’язкове

Доступ до майбутніх файлів після покупки · UTC

Рядок:format: "date-time"

Приклад: "2027-01-01T12:00:00Z"

version_labelРядокОбов’язкове

Версія

Приклад: "1.0"

Додаткові поля: Ні

releasesМасив <OrderReleaseData > Обов’язкове

Цифрові випуски

Приклад: [{"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Логічне значенняОбов’язкове

Доступ до майбутніх файлів після покупки · updates_pending

Приклад: false

Додаткові поля: Ні

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (OrderStatusData).

Приклад: "status-0"

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

Приклад: "Status 0"

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"

Приклад: "2026-10-19T10:00:00Z"

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1

Додаткові поля: Ні

created_atРядокОбов’язкове

Час створення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Приклад: "status-0"

is_initialЛогічне значенняОбов’язкове

Чи є цей статус початковим.

Приклад: true

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

Приклад: "New"

positionЦіле числоОбов’язкове

Позиція у впорядкованому списку.

Приклад: 0

Додаткові поля: Ні

dataМасив <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Обов’язкове

Приклад відповіді · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Приклад: [{"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 Обов’язкове

Метадані відповіді.

Приклад: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Додаткові поля: Ні

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 1

status_idРядокОбов’язкове

Ідентифікатор із відповідного довідника статусів.

Обмеження

pattern

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

Приклад: "status-1"

Додаткові поля: Ні

created_atРядокОбов’язкове

Час створення.

format: "date-time"

Приклад: "2026-10-19T10:00:00Z"

customerCustomerData Обов’язкове

Відомості про клієнта, записані для цього ресурсу.

Приклад: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}

deliveryShippingData Обов’язкове

Спосіб доставки та пов’язані відомості.

Приклад: {"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 Обов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

Приклад: {"amount":"24.60","currency":"PLN","minor_units":2}

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (OrderSummaryData).

Приклад: "order-0000"

lifecycle_stateOrderLifecycleState Обов’язкове

Стан бізнесового життєвого циклу.

Приклад: "placed"

localeРядокОбов’язкове

Мова, вибрана для цього запиту.

Приклад: "pl"

market_idРядокОбов’язкове

Ідентифікатор ринку, повернутий кінцевою точкою контексту.

Приклад: "market-pl"

numberРядокОбов’язкове

Зрозумілий користувачу номер замовлення або звернення.

Приклад: "0001"

paymentPaymentData Обов’язкове

Відомості про оплату, записані для замовлення.

Приклад: {"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_amountMoneyData Обов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

Приклад: {"amount":"24.60","currency":"PLN","minor_units":2}

statusOrderStatusData Обов’язкове

Статус, допустимий для цієї конкретної операції.

Приклад: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}

subtotalMoneyData Обов’язкове

Сума до додавання інших складових, наведених у відповіді.

Приклад: {"amount":"329.40","currency":"PLN","minor_units":2}

taxMoneyData Обов’язкове

Відомості про податок.

Приклад: {"amount":"49.40","currency":"PLN","minor_units":2}

tax_country_codeРядок | nullОбов’язкове

Країна оподаткування · Збережені дані замовлення · ISO 3166-1 alpha-2; null.

Приклад: "PL"

totalMoneyData Обов’язкове

Загальна сума.

Приклад: {"amount":"329.40","currency":"PLN","minor_units":2}

Додаткові поля: Ні

groupsМасив <OrderTaxGroupData > Обов’язкове

Податкові групи · source + tax_rate; Невідомо: null; відомий нуль: 0.

Приклад: [{"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 Обов’язкове

Нерозподілений податок = order.tax − Σ groups.tax; ±.

Приклад: {"amount":"0.00","currency":"PLN","minor_units":2}

Додаткові поля: Ні

grossMoneyData Обов’язкове

Сума з податком · Після знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"221.40","currency":"PLN","minor_units":2}

netMoneyData | nullОбов’язкове

Сума без податку · Після знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"180.00","currency":"PLN","minor_units":2}

sourceРядокОбов’язкове

Джерело: products (Товари), shipping (Доставка).

Обмеження

enum

["products", "shipping"]

Приклад: "products"

taxMoneyData | nullОбов’язкове

Сума податку · Після знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"41.40","currency":"PLN","minor_units":2}

tax_rateРядок | nullОбов’язкове

tax_rate · Збережені дані замовлення: "0.23" = 23%; "0" ≠ null.

Приклад: "0.23"

Додаткові поля: Ні

before_discountsOrderAmountBreakdownData Обов’язкове

Замовлення · До знижок · net / tax / gross.

Приклад: {"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 Обов’язкове

Знижки · net / tax / gross.

Приклад: {"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 Обов’язкове

Замовлення · Після знижок · net / tax / gross.

Приклад: {"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 Обов’язкове

Товари · Знижки · net / tax / gross.

Приклад: {"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 Обов’язкове

Товари · Після знижок · net / tax / gross.

Приклад: {"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 Обов’язкове

Товари · До знижок · net / tax / gross.

Приклад: {"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 Обов’язкове

Доставка · Після знижок · net / tax / gross.

Приклад: {"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 Обов’язкове

Доставка · До знижок · net / tax / gross.

Приклад: {"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 Обов’язкове

Доставка · Знижки · net / tax / gross.

Приклад: {"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}}

Додаткові поля: Ні

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

valueРядокОбов’язкове

Значення, описане навколишньою схемою.

Додаткові поля: Ні

amountMoneyData Обов’язкове

Сума з податком · Товари · Знижки.

Приклад: {"amount":"12.30","currency":"PLN","minor_units":2}

campaign_idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

Приклад: "saved-coupon"

codeРядок | nullОбов’язкове

Стабільний машинозчитуваний код.

Приклад: "SAVE"

kindРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

["coupon", "promotion"]

Приклад: "coupon"

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

Приклад: "Saved coupon"

sequenceЦіле число | nullНеобов’язкове

Порядок застосування; null.

Приклад: 1

shipping_amountMoneyData | nullНеобов’язкове

Сума з податком · Доставка · Знижки; null.

Приклад: {"amount":"24.60","currency":"PLN","minor_units":2}

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 3

Додаткові поля: Ні

amountMoneyData Обов’язкове

payment.amount — загальна сума замовлення. Статус оплати не визначає сплачені, повернуті чи несплачені суми.

Приклад: {"amount":"329.40","currency":"PLN","minor_units":2}

environmentРядокОбов’язкове

Відомості про середовище, додані до запису.

Обмеження

enum

["live", "sandbox"]

Приклад: "live"

method_codeРядок | nullОбов’язкове

Код способу доставки або оплати.

Приклад: "payment-old"

method_nameРядок | nullОбов’язкове

Назва способу доставки або оплати.

Приклад: "Historic method"

paid_atРядок | nullОбов’язкове

Дата й час позначення оплати як сплаченої.

Рядок:format: "date-time"

Приклад: null

statusOrderPaymentStatus Обов’язкове

Статус, допустимий для цієї конкретної операції.

Приклад: "unpaid"

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"

Приклад: "2026-10-19T10:00:00Z"

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 0

Додаткові поля: Ні

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 0maximum: 9223372036854775807

Приклад: 0

reasonРядокОбов’язкове

Записана причина зміни.

minLength: 1maxLength: 500

Приклад: "Bank transfer confirmed"

statusPaymentStatus Обов’язкове

Статус, допустимий для цієї конкретної операції. unpaid: не оплачено; paid: оплачено; failed: помилка оплати; refunded: повернено.

Приклад: "paid"

Додаткові поля: Ні

Додаткові поля: Так

address_line_1РядокОбов’язкове

Перший рядок адреси.

minLength: 1maxLength: 240

cityРядокОбов’язкове

Місто або населений пункт.

minLength: 1maxLength: 160

postal_codeРядокОбов’язкове

Поштовий індекс.

minLength: 1maxLength: 32

Додаткові поля: Ні

latitudeЧислоОбов’язкове

WGS84 φ (°)

minimum: -90.0maximum: 90.0

longitudeЧислоОбов’язкове

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Додаткові поля: Ні

address_line1РядокОбов’язкове

Перший рядок адреси.

cityРядокОбов’язкове

Місто або населений пункт.

codeРядокОбов’язкове

Стабільний машинозчитуваний код.

country_codeРядокОбов’язкове

Код країни.

kindРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

["locker", "pickup_point"]

latitudeЧисло | nullОбов’язкове

WGS84 φ (°)

location_descriptionРядок | nullОбов’язкове

Опис вибраною мовою.

longitudeЧисло | nullОбов’язкове

WGS84 λ (°)

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

opening_hoursРядок | nullОбов’язкове

Opening hours

operatorРядокОбов’язкове

Назва ресурсу у відповідному контексті.

postal_codeРядокОбов’язкове

Поштовий індекс.

Додаткові поля: Ні

codeРядокОбов’язкове

Стабільний машинозчитуваний код.

Обмеження

pattern

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

country_codeРядокОбов’язкове

Код країни.

Обмеження

pattern

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

environmentРядокОбов’язкове

Відомості про середовище, додані до запису.

Обмеження

enum

["live", "sandbox"]

kindРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

["locker", "pickup_point"]

operatorРядокОбов’язкове

Назва ресурсу у відповідному контексті.

minLength: 1maxLength: 63

Додаткові поля: Ні

emailРядокОбов’язкове

Адреса електронної пошти.

Приклад: "customer@example.invalid"

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

Приклад: "Example"

Додаткові поля: Ні

amountMoneyData Обов’язкове

Сума доставки з податком, збережена в замовленні як MoneyData. Подальші зміни податку не змінюють цю історичну суму.

Приклад: {"amount":"0.00","currency":"PLN","minor_units":2}

datesDeliveryDatesData Обов’язкове

Дати відправлення й доставки. Список і деталі замовлення містять delivery.dates. Заплановані дати YYYY-MM-DD не підтверджують відправлення. Поточні дати мають пріоритет; для старих замовлень використовується збережена оцінка. Очищені або невідомі значення — null. Деталі також містять усі позиції та зображення товарів.

Приклад: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

method_codeРядок | nullОбов’язкове

Код способу доставки або оплати.

Приклад: "shipping-old"

method_nameРядок | nullОбов’язкове

Назва способу доставки або оплати.

Приклад: "Historic carrier"

pickup_pointPickupPointSummaryData | nullОбов’язкове

Пункт отримання

Приклад: null

recipient_modeРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

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

Приклад: "full_address"

Додаткові поля: Ні

amountMoneyData Обов’язкове

Сума доставки з податком, збережена в замовленні як MoneyData. Подальші зміни податку не змінюють цю історичну суму.

Приклад: {"amount":"0.00","currency":"PLN","minor_units":2}

datesDeliveryDatesData Обов’язкове

Дати відправлення й доставки. Список і деталі замовлення містять delivery.dates. Заплановані дати YYYY-MM-DD не підтверджують відправлення. Поточні дати мають пріоритет; для старих замовлень використовується збережена оцінка. Очищені або невідомі значення — null. Деталі також містять усі позиції та зображення товарів.

Приклад: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

discount_grossMoneyData Обов’язкове

Сума з податком · Знижки; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"24.60","currency":"PLN","minor_units":2}

discount_netMoneyData | nullОбов’язкове

Сума без податку · Знижки; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"20.00","currency":"PLN","minor_units":2}

discount_taxMoneyData | nullОбов’язкове

Сума податку · Знижки; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"4.60","currency":"PLN","minor_units":2}

discountsМасив <OrderDeliveryDiscountData > | nullОбов’язкове

Доставка · Знижки; []: 0; null: Невідомо: null; відомий нуль: 0.

Приклад: [{"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 Обов’язкове

Сума з податком · Після знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"0.00","currency":"PLN","minor_units":2}

method_codeРядок | nullОбов’язкове

Код способу доставки або оплати.

Приклад: "shipping-old"

method_nameРядок | nullОбов’язкове

Назва способу доставки або оплати.

Приклад: "Historic carrier"

netMoneyData | nullОбов’язкове

Сума без податку · Після знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"0.00","currency":"PLN","minor_units":2}

original_grossMoneyData Обов’язкове

Сума з податком · Доставка · До знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"24.60","currency":"PLN","minor_units":2}

original_netMoneyData | nullОбов’язкове

Сума без податку · Доставка · До знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"20.00","currency":"PLN","minor_units":2}

original_taxMoneyData | nullОбов’язкове

Сума податку · Доставка · До знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"4.60","currency":"PLN","minor_units":2}

pickup_pointDeliveryPickupPointData | nullОбов’язкове

Пункт отримання

Приклад: null

recipient_modeРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження

enum

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

Приклад: "full_address"

taxMoneyData | nullОбов’язкове

Сума податку · Після знижок; Невідомо: null; відомий нуль: 0.

Приклад: {"amount":"0.00","currency":"PLN","minor_units":2}

tax_category_idРядок | nullОбов’язкове

Ідентифікатор податкової категорії · Збережені дані замовлення; null.

Приклад: "standard"

tax_category_nameРядок | nullОбов’язкове

Збережена назва податкової категорії; null.

Приклад: "VAT 23%"

tax_rateРядок | nullОбов’язкове

tax_rate · Збережені дані замовлення: "0.23" = 23%; "0" ≠ null.

Приклад: "0.23"

Додаткові поля: Ні