Order models

Order models for lists, details, items, delivery and payment status. Check field types and the payloads accepted by status updates.

Data schemas

Delivery address

AddressData · Schema · Order models

address_line_1String nullRequired: First address line.
address_line_2String nullRequired: Additional address information.
cityString nullRequired: City or locality.
country_codeString nullRequired: Country code.
first_nameString nullRequired: Given name.
house_numberString nullRequired: Building or house number.
last_nameString nullRequired: Family name.
phoneString nullRequired: Telephone number.
postal_codeString nullRequired: Postal code.
regionString nullRequired: Administrative region.
streetString nullRequired: Street name.

Additional fields: No

ApiResponse_OrderFileListData_

ApiResponse_OrderFileListData_ · Fields, types and constraints of data accepted or returned by the API. Upload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. For mode=period choose days (1–3650) or the existing months, never both. Purchase terms are recorded at purchase; a refund revokes access only for the refunded line.

dataOrderFileListData Required: Successful response payload.

Example: {"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 Required: Response metadata.

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

Additional fields: No

ApiResponse_OrderReleaseListData_

ApiResponse_OrderReleaseListData_ · Fields, types and constraints of data accepted or returned by the API. Upload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. For mode=period choose days (1–3650) or the existing months, never both. Purchase terms are recorded at purchase; a refund revokes access only for the refunded line.

dataOrderReleaseListData Required: Successful response payload.

Example: {"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 Required: Response metadata.

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

Additional fields: No

List orders — Response

ApiResponse_list_OrderSummaryData__ · Fields, types and constraints of data accepted or returned by the API.

dataArray <OrderSummaryData > Required: Response example · ApiResponse_list_OrderSummaryData__.

Example: [{"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 Required: Response metadata.

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

Additional fields: No

Get an order — Response

ApiResponse_OrderDetailData_ · Fields, types and constraints of data accepted or returned by the API.

dataOrderDetailData Required: Response example · OrderDetailData.

Example: {"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 Required: Response metadata.

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

Additional fields: No

CurrentReleaseData

CurrentReleaseData · Fields, types and constraints of data accepted or returned by the API. Upload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. For mode=period choose days (1–3650) or the existing months, never both. Purchase terms are recorded at purchase; a refund revokes access only for the refunded line.

acquiredBooleanRequired: Access after purchase (true / false)
changelogStringRequired: Release notes
covered_by_purchaseBooleanRequired: Access after purchase (true / false)
idStringRequired: Resource identifier; preserve it as returned.
published_atStringRequired: Publish release · UTC

format: "date-time"
requires_new_purchaseBooleanRequired: No access to files added after purchase · requires_new_purchase
sequenceIntegerRequired: Position in the ordered collection.
version_labelStringRequired: Version

Additional fields: No

Customer information recorded for this resource

CustomerData · Schema · Order models

emailStringRequired: Email address.

Example: "customer@example.invalid"
first_nameString nullRequired: Given name.

Example: "Example"
last_nameString nullRequired: Family name.

Example: "Example"
phoneString nullRequired: Telephone number.

Example: null

Additional fields: No

DeliveryContentDeletion

DeliveryContentDeletion · Request to erase an issued code or file while preserving its allocation history.

expected_versionIntegerRequired: Version read before the write; a mismatch rejects the update.

minimum: 1

Example: 1
reasonStringRequired: Reason recorded for the change.

minLength: 1maxLength: 500

Example: "Withdraw a revoked license"

Additional fields: No

Dispatch and delivery dates

DeliveryDatesData · Order lists and details include delivery.dates. YYYY-MM-DD dates are planned and do not confirm shipment. Current dates take precedence; older orders use the recorded estimate. Cleared or unknown values are null. Details also include all order lines and product images.

dispatch_timezoneString nullRequired: Dispatch timezone (IANA; null).

Example: "Europe/Warsaw"
estimated_delivery_fromString nullRequired: Estimated delivery start (YYYY-MM-DD; null).

String:format: "date"

Example: "2026-10-20"
estimated_delivery_toString nullRequired: Estimated delivery end (YYYY-MM-DD; null).

String:format: "date"

Example: "2026-10-21"
planned_dispatch_onString nullRequired: Planned dispatch date (YYYY-MM-DD; null).

String:format: "date"

Example: "2026-10-19"

Additional fields: No

DeliveryReplacement

DeliveryReplacement · Request to replace an order allocation with an existing available unit.

expected_unit_versionIntegerRequired: Current version of the available replacement unit.

minimum: 1

Example: 1
expected_versionIntegerRequired: Version read before the write; a mismatch rejects the update.

minimum: 1

Example: 1
reasonStringRequired: Reason recorded for the change.

minLength: 1maxLength: 500

Example: "Replace an invalid activation code"
replacement_unit_idStringRequired: ID of an existing free unit selected to replace the order allocation.

format: "uuid"

Example: "00000000-0000-4000-8000-000000000008"

Additional fields: No

DeliveryPickupPointData

DeliveryPickupPointData · Fields, types and constraints of data accepted or returned by the API.

addressPickupPointAddressData Required

Delivery address.

codeStringRequired

Stable machine-readable code.

Constraints

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

coordinatesPickupPointCoordinatesData nullRequired

Value described by the surrounding schema.

country_codeStringRequired

Country code.

Constraints

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

environmentStringRequired

Environment information attached to the record.

Constraints

enum: ["live", "sandbox"]

kindStringRequired

Variant of the data structure described by its allowed values.

Constraints

enum: ["locker", "pickup_point"]

location_descriptionString nullRequired

Description in the selected language.

String:maxLength: 1000

nameStringRequired

Resource name in the relevant context.

minLength: 1maxLength: 160

opening_hoursString nullRequired

Opening hours

String:maxLength: 500

operatorStringRequired

Resource name in the relevant context.

minLength: 1maxLength: 63

verified_atStringRequired

Most recent update time.

format: "date-time"

Additional fields: No

ApiResponse[list[DeliveryData]]

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · Paginated digital allocations for one order; codes require a separate content request.

dataArray <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > Required: Successful response payload.

Example: [{"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 Required: Response metadata.

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

Additional fields: No

DeliveryData

shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · One digital allocation for a specific order line and purchased unit, including current download availability.

can_downloadBooleanRequired: Download (true / false)

Example: true
content_stateStringRequired: Payload state: present, deleting or deleted. A history row may remain after deletion.

Example: "present"
delete_due_atString nullRequired: Scheduled file deletion time, or null when automatic deletion is disabled.

String:format: "date-time"

Example: null
filenameString nullRequired: File

Example: null
first_available_atString nullRequired: First time this purchase received access. Replacement does not restart the retention period.

String:format: "date-time"

Example: "2026-11-03T12:00:00Z"
generationIntegerRequired: Allocation generation. A replacement creates a new generation and preserves the old one in history.

Example: 1
idStringRequired: Resource identifier; preserve it as returned.

format: "uuid"

Example: "00000000-0000-4000-8000-000000000005"
kindString nullRequired: Variant of the data structure described by its allowed values.

Example: "code"
line_idStringRequired: Stable order line identifier.

Example: "line-example"
order_idStringRequired: Related order identifier.

Example: "order-example"
payload_idStringRequired: ID of the exact code or file content revision. It is not a public download URL.

format: "uuid"

Example: "00000000-0000-4000-8000-000000000012"
product_idStringRequired: Product identifier.

Example: "example"
reasonStringRequired: Reason recorded for the change.

Example: ""
size_bytesInteger nullRequired: Size in bytes

Example: null
stateStringRequired: Status

Example: "available"
unit_idStringRequired: ID of one individual code or file in the product pool.

format: "uuid"

Example: "00000000-0000-4000-8000-000000000011"
unit_ordinalIntegerRequired: Unit position within the purchased order line quantity.

Example: 1
variant_idString nullRequired: Product variant identifier.

Example: null
versionIntegerRequired: Resource version used for concurrency control.

Example: 2

Additional fields: No

Invoice information

InvoiceData · Schema · Order models

address_line_1String nullRequired: First address line.
address_line_2String nullRequired: Additional address information.
cityString nullRequired: City or locality.
company_nameString nullRequired: Company name.
country_codeString nullRequired: Country code.
house_numberString nullRequired: Building or house number.
postal_codeString nullRequired: Postal code.
regionString nullRequired: Administrative region.
streetString nullRequired: Street name.
tax_identifierString nullRequired: Tax identification number.
tax_schemeString nullRequired: Tax calculation scheme.

Additional fields: No

Net amount / Tax amount / Gross amount

OrderAmountBreakdownData · Amounts and tax rates come from the saved order, including item corrections. Missing history is null and is never replaced with current catalog tax rates. Monetary values remain decimal strings.

grossMoneyData Required: Gross amount · After discounts; Unknown: null; known zero: 0.

Example: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullRequired: Net amount · After discounts; Unknown: null; known zero: 0.

Example: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullRequired: Tax amount · After discounts; Unknown: null; known zero: 0.

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

Additional fields: No

Shipping · Discounts

OrderDeliveryDiscountData · Amounts and tax rates come from the saved order, including item corrections. Missing history is null and is never replaced with current catalog tax rates. Monetary values remain decimal strings.

amountMoneyData Required

Gross amount · Shipping · Discounts.

Example: {"amount":"24.60","currency":"PLN","minor_units":2}

campaign_idStringRequired

Resource identifier; preserve it as returned.

Example: "saved-coupon"

codeString nullRequired

Stable machine-readable code.

Example: "SAVE"

kindStringRequired

Variant of the data structure described by its allowed values.

Constraints

enum: ["coupon", "promotion"]

Example: "coupon"

nameStringRequired

Resource name in the relevant context.

Example: "Saved coupon"

sequenceInteger nullRequired

Position in the ordered collection.

Example: 1

versionIntegerRequired

Resource version used for concurrency control.

Example: 3

Additional fields: No

Get an order — Response

OrderDetailData · Fields, types and constraints of data accepted or returned by the API.

created_atStringRequired: Creation time.

format: "date-time"

Example: "2026-10-19T10:00:00Z"
customerCustomerData Required: Customer information recorded for this resource.

Example: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Required: Delivery method and associated information.

Example: {"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 Required: Decimal amount encoded as a JSON string; null only where allowed.

Example: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Required: Discounts

Example: [{"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}]
idStringRequired: Resource identifier; preserve it as returned. (OrderDetailData).

Example: "order-0000"
invoiceInvoiceData nullRequired: Invoice information.

Example: null
invoice_requestedBooleanRequired: Whether an invoice was requested.

Example: false
lifecycle_stateOrderLifecycleState Required: Business lifecycle state.

Example: "placed"
linesArray <OrderLineData > Required: Order line snapshots.

Example: [{"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":[]}]
localeStringRequired: Language selected for this request.

Example: "pl"
market_idStringRequired: Market identifier returned by the context endpoint.

Example: "market-pl"
numberStringRequired: Human-facing order or request number.

Example: "0001"
paymentPaymentData Required: Payment details recorded for the order.

Example: {"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 nullRequired: Pickup point

Example: null
prices_include_taxBooleanRequired: Whether listed prices include tax.

Example: true
shipping_addressAddressData nullRequired: Delivery address.

Example: null
shipping_discount_amountMoneyData Required: Decimal amount encoded as a JSON string; null only where allowed.

Example: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Required: Status accepted by this specific operation.

Example: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Required: Amount before the additional components shown in the response.

Example: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Required: Tax information.

Example: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Required: Tax groups · source + tax_rate; unallocated_tax.

Example: {"groups":[{"gross":{"amount":"221.40","currency":"PLN","minor_units":2},"net":{"amount":"180.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"41.40","currency":"PLN","minor_units":2},"tax_rate":"0.23"},{"gross":{"amount":"108.00","currency":"PLN","minor_units":2},"net":{"amount":"100.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"8.00","currency":"PLN","minor_units":2},"tax_rate":"0.08"},{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"source":"shipping","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_rate":"0.23"}],"unallocated_tax":{"amount":"0.00","currency":"PLN","minor_units":2}}
tax_country_codeString nullRequired: Tax country · Recorded order snapshot · ISO 3166-1 alpha-2; null.

Example: "PL"
totalMoneyData Required: Total amount.

Example: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Required: Totals · net / tax / gross; Before discounts / After discounts.

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

Additional fields: No

OrderFileData

OrderFileData · Fields, types and constraints of data accepted or returned by the API. Upload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. For mode=period choose days (1–3650) or the existing months, never both. Purchase terms are recorded at purchase; a refund revokes access only for the refunded line.

can_downloadBooleanRequired: Download (true / false)

Example: true
categoryFileCategory Required: File category: internal / customer_document / digital

Example: "digital"
filenameStringRequired: File

Example: "manual.pdf"
idStringRequired: Resource identifier; preserve it as returned.

Example: "example"
labelStringRequired: Resource name in the relevant context.

Example: "Manual"
line_idStringRequired: Stable order line identifier.

Example: "example"
mime_typeStringRequired: Media content type.

Example: "application/pdf"
product_idStringRequired: Product identifier.

Example: "example"
purchase_idStringRequired: Resource identifier; preserve it as returned. · purchase_id

Example: "00000000-0000-4000-8000-000000000001"
reasonStringRequired: Reason recorded for the change.

Example: "paid"
sha256StringRequired: SHA-256 (hex, 64)

Example: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesIntegerRequired: Size in bytes

minimum: 1maximum: 262144000

Example: 46
source_file_idStringRequired: Resource identifier; preserve it as returned. · source_file_id

Example: "00000000-0000-4000-8000-000000000001"
source_version_idStringRequired: Resource identifier; preserve it as returned. · source_version_id

Example: "00000000-0000-4000-8000-000000000001"
source_version_numberIntegerRequired: Version

minimum: 1

Example: 1
stateStringRequired: Status

Example: "active"

Additional fields: No

OrderFileListData

OrderFileListData · Fields, types and constraints of data accepted or returned by the API. Upload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. For mode=period choose days (1–3650) or the existing months, never both. Purchase terms are recorded at purchase; a refund revokes access only for the refunded line.

filesArray <OrderFileData > Required: Product files

Example: [{"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_pendingBooleanRequired: Access to future files after purchase · updates_pending

Example: false

Additional fields: No

Image metadata and URL

OrderImageData · Schema · Order models

altString nullRequired: Alternative text for an image.
sourceStringOptional: Source of the recorded activity.

const: "current_catalog"

Default: "current_catalog"
urlStringRequired: Resource URL.

Additional fields: No

Business lifecycle state

OrderLifecycleState · Schema · Order models

String

Constraints

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

Additional fields: Yes

Order line snapshots

OrderLineData · Schema · Order models

discount_amountMoneyData Required: Decimal amount encoded as a JSON string; null only where allowed.

Example: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Required: Gross amount · Discounts; Unknown: null; known zero: 0.

Example: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullRequired: Net amount · Discounts; Unknown: null; known zero: 0.

Example: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullRequired: Tax amount · Discounts; Unknown: null; known zero: 0.

Example: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsArray <OrderDiscountData > Required: Discounts · net / tax / gross.

Example: [{"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}]
identifiersObjectAdditional fields: StringRequired: Product identification codes.

Example: {}
imageOrderImageData nullRequired: Image metadata and URL.

Example: null
line_idStringRequired: Stable order line identifier.

Example: "saved-line-a"
manual_discountOrderManualDiscountData nullRequired: Manual discount; null.

Example: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameStringRequired: Resource name in the relevant context.

Example: "Saved A"
original_totalMoneyData Required: Total amount.

Example: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Required: Gross amount · Products · Before discounts; Unknown: null; known zero: 0.

Example: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullRequired: Net amount · Products · Before discounts; Unknown: null; known zero: 0.

Example: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullRequired: Tax amount · Products · Before discounts; Unknown: null; known zero: 0.

Example: {"amount":"46.00","currency":"PLN","minor_units":2}
positionIntegerRequired: Position in the ordered collection.

Example: 1
product_idStringRequired: Product identifier.

Example: "product-api"
quantityIntegerRequired: Number of units.

Example: 2
skuStringRequired: Stock keeping unit code.

Example: "A"
taxMoneyData nullRequired: Tax amount · One unit · Recorded order snapshot; tax ≠ unit_tax; Unknown: null; known zero: 0.

Example: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idString nullRequired: Tax category identifier · Recorded order snapshot; null.

Example: "standard"
tax_category_nameString nullRequired: Recorded tax category name; null.

Example: "VAT 23%"
tax_rateString nullRequired: tax_rate · Recorded order snapshot: "0.23" = 23%; "0" ≠ null.

Example: "0.23"
totalMoneyData Required: Total amount.

Example: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Required: Gross amount · Products · After discounts; Unknown: null; known zero: 0.

Example: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullRequired: Net amount · Products · After discounts; Unknown: null; known zero: 0.

Example: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullRequired: Tax amount · Products · After discounts · Recorded order snapshot; Unknown: null; known zero: 0.

Example: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Required: Gross amount · One unit · Before discounts; Unknown: null; known zero: 0.

Example: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullRequired: Net amount · One unit · Before discounts; Unknown: null; known zero: 0.

Example: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Required: Price for one unit.

Example: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullRequired: Tax amount · One unit · Before discounts; Unknown: null; known zero: 0.

Example: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idString nullRequired: Product variant identifier.

Example: null
variant_optionsArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Required: Variant options associated with the product or snapshot.

Example: []

Additional fields: No

Manual discount

OrderManualDiscountData · Amounts and tax rates come from the saved order, including item corrections. Missing history is null and is never replaced with current catalog tax rates. Monetary values remain decimal strings.

amountMoneyData Required

Gross amount · Manual discount · Recorded order snapshot.

Example: {"amount":"12.30","currency":"PLN","minor_units":2}

kindStringRequired

Discount kind: percentage / fixed.

Constraints

enum: ["percentage", "fixed"]

Example: "fixed"

valueStringRequired

Configured value: percentage "10" = 10%; fixed = Gross amount.

Example: "12.30"

Additional fields: No

Status accepted by this specific operation

OrderPaymentStatus · Schema · Order models

String

Constraints

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

Additional fields: Yes

OrderReleaseData

OrderReleaseData · Fields, types and constraints of data accepted or returned by the API. Upload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. For mode=period choose days (1–3650) or the existing months, never both. Purchase terms are recorded at purchase; a refund revokes access only for the refunded line.

access_reasonStringRequired: Access after purchase · Reason recorded for the change.

Example: "paid"
access_stateStringRequired: Access after purchase · Status

Example: "active"
current_releaseCurrentReleaseData nullRequired: Digital releases · current_release

Example: null
grant_reasonStringRequired: Access after purchase · Reason recorded for the change.

Example: "purchase"
granted_atStringRequired: Access after purchase · UTC

format: "date-time"

Example: "2026-01-01T12:00:00Z"
idStringRequired: Resource identifier; preserve it as returned.

Example: "example"
line_idStringRequired: Stable order line identifier.

Example: "example"
manifest_sha256StringRequired: Digital releases · SHA-256

Example: "1111111111111111111111111111111111111111111111111111111111111111"
product_idStringRequired: Product identifier.

Example: "example"
published_atStringRequired: Publish release · UTC

format: "date-time"

Example: "2026-01-01T12:00:00Z"
purchase_idStringRequired: Resource identifier; preserve it as returned. · purchase_id

Example: "00000000-0000-4000-8000-000000000001"
release_idStringRequired: Resource identifier; preserve it as returned. · release_id

Example: "00000000-0000-4000-8000-000000000001"
release_sequenceIntegerRequired: Digital releases · Position in the ordered collection.

Example: 1
update_daysInteger nullRequired: Number of days (days; null)

Example: 365
update_modeStringRequired: Access to future files after purchase: none / period / unlimited

Example: "period"
update_monthsInteger nullRequired: Months (months; null)

Example: null
updates_untilString nullRequired: Access to future files after purchase · UTC

String:format: "date-time"

Example: "2027-01-01T12:00:00Z"
version_labelStringRequired: Version

Example: "1.0"

Additional fields: No

OrderReleaseListData

OrderReleaseListData · Fields, types and constraints of data accepted or returned by the API. Upload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. For mode=period choose days (1–3650) or the existing months, never both. Purchase terms are recorded at purchase; a refund revokes access only for the refunded line.

releasesArray <OrderReleaseData > Required: Digital releases

Example: [{"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_pendingBooleanRequired: Access to future files after purchase · updates_pending

Example: false

Additional fields: No

Status accepted by this specific operation

OrderStatusData · Schema · Order models

idStringRequired: Resource identifier; preserve it as returned. (OrderStatusData).

Example: "status-0"
nameStringRequired: Resource name in the relevant context.

Example: "Status 0"
updated_atStringRequired: Most recent update time.

format: "date-time"

Example: "2026-10-19T10:00:00Z"
versionIntegerRequired: Resource version used for concurrency control.

Example: 1

Additional fields: No

List order statuses — Response

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Fields, types and constraints of data accepted or returned by the API.

created_atStringRequired: Creation time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"
idStringRequired: Resource identifier; preserve it as returned. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Example: "status-0"
is_initialBooleanRequired: Whether this is the initial status.

Example: true
nameStringRequired: Resource name in the relevant context.

Example: "New"
positionIntegerRequired: Position in the ordered collection.

Example: 0

Additional fields: No

List order statuses — Response

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Fields, types and constraints of data accepted or returned by the API.

dataArray <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Required: Response example · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Example: [{"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 Required: Response metadata.

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

Additional fields: No

Update order status — Request body

OrderStatusUpdate · Fields, types and constraints of data accepted or returned by the API.

expected_versionIntegerRequired

Version read before the write; a mismatch rejects the update.

minimum: 1maximum: 9223372036854775807

Example: 1

status_idStringRequired

Identifier obtained from the relevant status dictionary.

Constraints

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

Example: "status-1"

Additional fields: No

List orders — Response

OrderSummaryData · Fields, types and constraints of data accepted or returned by the API.

created_atStringRequired: Creation time.

format: "date-time"

Example: "2026-10-19T10:00:00Z"
customerCustomerData Required: Customer information recorded for this resource.

Example: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Required: Delivery method and associated information.

Example: {"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 Required: Decimal amount encoded as a JSON string; null only where allowed.

Example: {"amount":"24.60","currency":"PLN","minor_units":2}
idStringRequired: Resource identifier; preserve it as returned. (OrderSummaryData).

Example: "order-0000"
lifecycle_stateOrderLifecycleState Required: Business lifecycle state.

Example: "placed"
localeStringRequired: Language selected for this request.

Example: "pl"
market_idStringRequired: Market identifier returned by the context endpoint.

Example: "market-pl"
numberStringRequired: Human-facing order or request number.

Example: "0001"
paymentPaymentData Required: Payment details recorded for the order.

Example: {"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_taxBooleanRequired: Whether listed prices include tax.

Example: true
shipping_discount_amountMoneyData Required: Decimal amount encoded as a JSON string; null only where allowed.

Example: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Required: Status accepted by this specific operation.

Example: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Required: Amount before the additional components shown in the response.

Example: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Required: Tax information.

Example: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeString nullRequired: Tax country · Recorded order snapshot · ISO 3166-1 alpha-2; null.

Example: "PL"
totalMoneyData Required: Total amount.

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

Additional fields: No

Order · Tax groups

OrderTaxBreakdownData · Amounts and tax rates come from the saved order, including item corrections. Missing history is null and is never replaced with current catalog tax rates. Monetary values remain decimal strings.

groupsArray <OrderTaxGroupData > Required: Tax groups · source + tax_rate; Unknown: null; known zero: 0.

Example: [{"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 Required: Unallocated tax = order.tax − Σ groups.tax; ±.

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

Additional fields: No

Tax groups

OrderTaxGroupData · Amounts and tax rates come from the saved order, including item corrections. Missing history is null and is never replaced with current catalog tax rates. Monetary values remain decimal strings.

grossMoneyData Required

Gross amount · After discounts; Unknown: null; known zero: 0.

Example: {"amount":"221.40","currency":"PLN","minor_units":2}

netMoneyData nullRequired

Net amount · After discounts; Unknown: null; known zero: 0.

Example: {"amount":"180.00","currency":"PLN","minor_units":2}

sourceStringRequired

Source: products (Products), shipping (Shipping).

Constraints

enum: ["products", "shipping"]

Example: "products"

taxMoneyData nullRequired

Tax amount · After discounts; Unknown: null; known zero: 0.

Example: {"amount":"41.40","currency":"PLN","minor_units":2}

tax_rateString nullRequired

tax_rate · Recorded order snapshot: "0.23" = 23%; "0" ≠ null.

Example: "0.23"

Additional fields: No

Order · Totals

OrderTotalsData · Amounts and tax rates come from the saved order, including item corrections. Missing history is null and is never replaced with current catalog tax rates. Monetary values remain decimal strings.

before_discountsOrderAmountBreakdownData Required: Order · Before discounts · net / tax / gross.

Example: {"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 Required: Discounts · net / tax / gross.

Example: {"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 Required: Order · After discounts · net / tax / gross.

Example: {"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 Required: Products · Discounts · net / tax / gross.

Example: {"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 Required: Products · After discounts · net / tax / gross.

Example: {"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 Required: Products · Before discounts · net / tax / gross.

Example: {"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 Required: Shipping · After discounts · net / tax / gross.

Example: {"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 Required: Shipping · Before discounts · net / tax / gross.

Example: {"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 Required: Shipping · Discounts · net / tax / gross.

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

Additional fields: No

Variant options associated with the product or snapshot

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Schema · Order models

nameStringRequired: Resource name in the relevant context.
valueStringRequired: Value described by the surrounding schema.

Additional fields: No

OrderDiscountData

OrderDiscountData · Fields, types and constraints of data accepted or returned by the API.

amountMoneyData Required

Gross amount · Products · Discounts.

Example: {"amount":"12.30","currency":"PLN","minor_units":2}

campaign_idStringRequired

Resource identifier; preserve it as returned.

Example: "saved-coupon"

codeString nullRequired

Stable machine-readable code.

Example: "SAVE"

kindStringRequired

Variant of the data structure described by its allowed values.

Constraints

enum: ["coupon", "promotion"]

Example: "coupon"

nameStringRequired

Resource name in the relevant context.

Example: "Saved coupon"

sequenceInteger nullOptional

Application sequence; null.

Example: 1

shipping_amountMoneyData nullOptional

Gross amount · Shipping · Discounts; null.

Example: {"amount":"24.60","currency":"PLN","minor_units":2}

versionIntegerRequired

Resource version used for concurrency control.

Example: 3

Additional fields: No

Payment details recorded for the order

PaymentData · Schema · Order models

amountMoneyData Required

payment.amount is the order total. Payment status does not establish amounts paid, refunded or outstanding.

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

environmentStringRequired

Environment information attached to the record.

Constraints

enum: ["live", "sandbox"]

Example: "live"

method_codeString nullRequired

Delivery or payment method code.

Example: "payment-old"

method_nameString nullRequired

Delivery or payment method name.

Example: "Historic method"

paid_atString nullRequired

Date and time the payment was marked paid.

String:format: "date-time"

Example: null

statusOrderPaymentStatus Required

Status accepted by this specific operation.

Example: "unpaid"

updated_atStringRequired

Most recent update time.

format: "date-time"

Example: "2026-10-19T10:00:00Z"

versionIntegerRequired

Resource version used for concurrency control.

Example: 0

Additional fields: No

Update order payment status — Request body

PaymentStatusUpdate · Fields, types and constraints of data accepted or returned by the API.

expected_versionIntegerRequired: Version read before the write; a mismatch rejects the update.

minimum: 0maximum: 9223372036854775807

Example: 0
reasonStringRequired: Reason recorded for the change.

minLength: 1maxLength: 500

Example: "Bank transfer confirmed"
statusPaymentStatus Required: Status accepted by this specific operation. unpaid: unpaid; paid: paid; failed: payment failed; refunded: refunded.

Example: "paid"

Additional fields: No

Status accepted by this specific operation

PaymentStatus · Schema · Order models

String

Constraints

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

Additional fields: Yes

PickupPointAddressData

PickupPointAddressData · Fields, types and constraints of data accepted or returned by the API.

address_line_1StringRequired: First address line.

minLength: 1maxLength: 240
cityStringRequired: City or locality.

minLength: 1maxLength: 160
postal_codeStringRequired: Postal code.

minLength: 1maxLength: 32

Additional fields: No

PickupPointCoordinatesData

PickupPointCoordinatesData · Fields, types and constraints of data accepted or returned by the API.

latitudeNumberRequired: WGS84 φ (°)

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

minimum: -180.0maximum: 180.0

Additional fields: No

PickupPointData

PickupPointData · Fields, types and constraints of data accepted or returned by the API.

address_line1StringRequired

First address line.

cityStringRequired

City or locality.

codeStringRequired

Stable machine-readable code.

country_codeStringRequired

Country code.

kindStringRequired

Variant of the data structure described by its allowed values.

Constraints

enum: ["locker", "pickup_point"]

latitudeNumber nullRequired

WGS84 φ (°)

location_descriptionString nullRequired

Description in the selected language.

longitudeNumber nullRequired

WGS84 λ (°)

nameStringRequired

Resource name in the relevant context.

opening_hoursString nullRequired

Opening hours

operatorStringRequired

Resource name in the relevant context.

postal_codeStringRequired

Postal code.

Additional fields: No

PickupPointSummaryData

PickupPointSummaryData · Fields, types and constraints of data accepted or returned by the API.

codeStringRequired

Stable machine-readable code.

Constraints

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

country_codeStringRequired

Country code.

Constraints

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

environmentStringRequired

Environment information attached to the record.

Constraints

enum: ["live", "sandbox"]

kindStringRequired

Variant of the data structure described by its allowed values.

Constraints

enum: ["locker", "pickup_point"]

operatorStringRequired

Resource name in the relevant context.

minLength: 1maxLength: 63

Additional fields: No

Customer information recorded for this resource

RequestCustomerData · Schema · Order models

emailStringRequired: Email address.

Example: "customer@example.invalid"
nameStringRequired: Resource name in the relevant context.

Example: "Example"

Additional fields: No

Delivery method and associated information

ShippingData · Schema · Order models

amountMoneyData Required

Gross shipping amount recorded on the order as MoneyData. Later tax changes do not change this historical amount.

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

datesDeliveryDatesData Required

Dispatch and delivery dates. Order lists and details include delivery.dates. YYYY-MM-DD dates are planned and do not confirm shipment. Current dates take precedence; older orders use the recorded estimate. Cleared or unknown values are null. Details also include all order lines and product images.

Example:

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

method_codeString nullRequired

Delivery or payment method code.

Example: "shipping-old"

method_nameString nullRequired

Delivery or payment method name.

Example: "Historic carrier"

pickup_pointPickupPointSummaryData nullRequired

Pickup point

Example: null

recipient_modeStringRequired

Variant of the data structure described by its allowed values.

Constraints

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

Example: "full_address"

Additional fields: No

ShippingDetailData

ShippingDetailData · Fields, types and constraints of data accepted or returned by the API.

amountMoneyData Required

Gross shipping amount recorded on the order as MoneyData. Later tax changes do not change this historical amount.

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

datesDeliveryDatesData Required

Example:

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

discount_grossMoneyData Required

Gross amount · Discounts; Unknown: null; known zero: 0.

Example: {"amount":"24.60","currency":"PLN","minor_units":2}

discount_netMoneyData nullRequired

Net amount · Discounts; Unknown: null; known zero: 0.

Example: {"amount":"20.00","currency":"PLN","minor_units":2}

discount_taxMoneyData nullRequired

Tax amount · Discounts; Unknown: null; known zero: 0.

Example: {"amount":"4.60","currency":"PLN","minor_units":2}

discountsArray <OrderDeliveryDiscountData > nullRequired

Shipping · Discounts; []: 0; null: Unknown: null; known zero: 0.

Example:

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

Gross amount · After discounts; Unknown: null; known zero: 0.

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

method_codeString nullRequired

Delivery or payment method code.

Example: "shipping-old"

method_nameString nullRequired

Delivery or payment method name.

Example: "Historic carrier"

netMoneyData nullRequired

Net amount · After discounts; Unknown: null; known zero: 0.

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

original_grossMoneyData Required

Gross amount · Shipping · Before discounts; Unknown: null; known zero: 0.

Example: {"amount":"24.60","currency":"PLN","minor_units":2}

original_netMoneyData nullRequired

Net amount · Shipping · Before discounts; Unknown: null; known zero: 0.

Example: {"amount":"20.00","currency":"PLN","minor_units":2}

original_taxMoneyData nullRequired

Tax amount · Shipping · Before discounts; Unknown: null; known zero: 0.

Example: {"amount":"4.60","currency":"PLN","minor_units":2}

pickup_pointDeliveryPickupPointData nullRequired

Pickup point

Example: null

recipient_modeStringRequired

Variant of the data structure described by its allowed values.

Constraints

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

Example: "full_address"

taxMoneyData nullRequired

Tax amount · After discounts; Unknown: null; known zero: 0.

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

tax_category_idString nullRequired

Tax category identifier · Recorded order snapshot; null.

Example: "standard"

tax_category_nameString nullRequired

Recorded tax category name; null.

Example: "VAT 23%"

tax_rateString nullRequired

tax_rate · Recorded order snapshot: "0.23" = 23%; "0" ≠ null.

Example: "0.23"

Additional fields: No