Схеми на данните: Поръчки

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 на съдържанието; не е публичен адрес за изтегляне.

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НизЗадължително

Идентификатор на пазара, върнат от endpoint за контекст.

Пример: "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НизЗадължително

Идентификатор на пазара, върнат от endpoint за контекст.

Пример: "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"

Допълнителни полета: Не