Léim ar ábhar
ShopentlyLearn
Gaeilge

Scéimeanna sonraí: Orduithe

Scéimeanna sonraí: Orduithe. Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

Scéimeanna sonraí

Seoladh seachadta

AddressData · Scéim · Scéimeanna sonraí: Orduithe
address_line_1Teaghrán nullRiachtanach

An chéad líne den seoladh.

address_line_2Teaghrán nullRiachtanach

Eolas breise faoin seoladh.

cityTeaghrán nullRiachtanach

Cathair nó ceantar.

country_codeTeaghrán nullRiachtanach

Cód tíre.

first_nameTeaghrán nullRiachtanach

Céadainm.

house_numberTeaghrán nullRiachtanach

Uimhir foirgnimh nó tí.

last_nameTeaghrán nullRiachtanach

Sloinne.

phoneTeaghrán nullRiachtanach

Uimhir theileafóin.

postal_codeTeaghrán nullRiachtanach

Cód poist.

regionTeaghrán nullRiachtanach

Réigiún riaracháin.

streetTeaghrán nullRiachtanach

Ainm sráide.

Réimsí breise: Níl

ApiResponse_OrderFileListData_

ApiResponse_OrderFileListData_ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
dataOrderFileListData Riachtanach

Sonraí freagra rathúil.

Sampla: {"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 Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

ApiResponse_OrderReleaseListData_

ApiResponse_OrderReleaseListData_ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
dataOrderReleaseListData Riachtanach

Sonraí freagra rathúil.

Sampla: {"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 Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

Liostaigh — Orduithe — Freagra

ApiResponse_list_OrderSummaryData__ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
dataEagar <OrderSummaryData > Riachtanach

Sampla freagra · ApiResponse_list_OrderSummaryData__.

Sampla: [{"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 Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

Faigh — Orduithe — Freagra

ApiResponse_OrderDetailData_ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
dataOrderDetailData Riachtanach

Sampla freagra · OrderDetailData.

Sampla: {"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 Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

CurrentReleaseData

CurrentReleaseData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
acquiredLuach BooleRiachtanach

Rochtain tar éis ceannaigh (true / false)

changelogTeaghránRiachtanach

Cur síos ar athruithe

covered_by_purchaseLuach BooleRiachtanach

Rochtain tar éis ceannaigh (true / false)

idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é.

published_atTeaghránRiachtanach

Foilsigh an eisiúint · UTC

format: "date-time"
requires_new_purchaseLuach BooleRiachtanach

Gan rochtain ar chomhaid a chuirtear leis tar éis ceannaigh · requires_new_purchase

sequenceSlánuimhirRiachtanach

Suíomh sa bhailiúchán ordaithe.

version_labelTeaghránRiachtanach

Leagan

Réimsí breise: Níl

Eolas custaiméara taifeadta don acmhainn seo

CustomerData · Scéim · Scéimeanna sonraí: Orduithe
emailTeaghránRiachtanach

Seoladh ríomhphoist.

Sampla: "customer@example.invalid"
first_nameTeaghrán nullRiachtanach

Céadainm.

Sampla: "Example"
last_nameTeaghrán nullRiachtanach

Sloinne.

Sampla: "Example"
phoneTeaghrán nullRiachtanach

Uimhir theileafóin.

Sampla: null

Réimsí breise: Níl

DeliveryContentDeletion

DeliveryContentDeletion · Scrios an t-ábhar go buan agus coinnigh an stair. Ní fhilleann an cód ar an stoc ar díol.
expected_versionSlánuimhirRiachtanach

Leagan a léadh roimh scríobh; diúltaítear don nuashonrú mura n-oireann sé.

minimum: 1
Sampla: 1
reasonTeaghránRiachtanach

Cúis taifeadta don athrú.

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

Réimsí breise: Níl

Dátaí seolta agus seachadta

DeliveryDatesData · Tá delivery.dates ar fáil sa liosta orduithe agus sna sonraí. Is dátaí pleanáilte iad YYYY-MM-DD agus ní dheimhníonn siad seoladh. Tá tosaíocht ag na dátaí reatha; úsáideann seanorduithe an meastachán sábháilte. Is null iad luachanna glanta nó anaithnide. Tá gach líne ordaithe agus íomhá táirge sna sonraí freisin.
dispatch_timezoneTeaghrán nullRiachtanach

Crios ama an tseolta (IANA; null).

Sampla: "Europe/Warsaw"
estimated_delivery_fromTeaghrán nullRiachtanach

Tús an tseachadta mheasta (YYYY-MM-DD; null).

Teaghrán:format: "date"
Sampla: "2026-10-20"
estimated_delivery_toTeaghrán nullRiachtanach

Deireadh an tseachadta mheasta (YYYY-MM-DD; null).

Teaghrán:format: "date"
Sampla: "2026-10-21"
planned_dispatch_onTeaghrán nullRiachtanach

Dáta seolta pleanáilte (YYYY-MM-DD; null).

Teaghrán:format: "date"
Sampla: "2026-10-19"

Réimsí breise: Níl

DeliveryReplacement

DeliveryReplacement · Roghnaigh aonad saor atá ann cheana. Ní thosaíonn an tréimhse choinneála arís de bharr ionadaithe.
expected_unit_versionSlánuimhirRiachtanach

Leagan reatha an aonaid shaoir ionaid.

minimum: 1
Sampla: 1
expected_versionSlánuimhirRiachtanach

Leagan a léadh roimh scríobh; diúltaítear don nuashonrú mura n-oireann sé.

minimum: 1
Sampla: 1
reasonTeaghránRiachtanach

Cúis taifeadta don athrú.

minLength: 1maxLength: 500
Sampla: "Replace an invalid activation code"
replacement_unit_idTeaghránRiachtanach

ID aonaid shaoir atá ann le húsáid mar ionad.

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

Réimsí breise: Níl

DeliveryPickupPointData

DeliveryPickupPointData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
addressPickupPointAddressData Riachtanach

Seoladh seachadta.

codeTeaghránRiachtanach

Cód cobhsaí atá inléite ag meaisín.

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

Luach a ndéanann an scéim máguaird cur síos air.

country_codeTeaghránRiachtanach

Cód tíre.

Srianta
pattern
"^[A-Z]{2}$"
environmentTeaghránRiachtanach

Eolas timpeallachta a ghabhann leis an taifead.

Srianta
enum
["live", "sandbox"]
kindTeaghránRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

Srianta
enum
["locker", "pickup_point"]
location_descriptionTeaghrán nullRiachtanach

Cur síos sa teanga roghnaithe.

Teaghrán:maxLength: 1000
nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

minLength: 1maxLength: 160
opening_hoursTeaghrán nullRiachtanach

Opening hours

Teaghrán:maxLength: 500
operatorTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

minLength: 1maxLength: 63
verified_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"

Réimsí breise: Níl

ApiResponse[list[DeliveryData]]

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · Léigh aonaid leithdháilte gan cóid. Ní bhaineann aisíocaíocht rochtain ach de na línte lena mbaineann.
dataEagar <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > Riachtanach

Sonraí freagra rathúil.

Sampla: [{"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 Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

DeliveryData

shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · Léigh aonaid leithdháilte gan cóid. Ní bhaineann aisíocaíocht rochtain ach de na línte lena mbaineann.
can_downloadLuach BooleRiachtanach

Íoslódáil (true / false)

Sampla: true
content_stateTeaghránRiachtanach

Stádas an ábhair: present / deleting / deleted.

Sampla: "present"
delete_due_atTeaghrán nullRiachtanach

Scriosadh comhaid sceidealaithe; díchumasaíonn null é.

Teaghrán:format: "date-time"
Sampla: null
filenameTeaghrán nullRiachtanach

Comhad

Sampla: null
first_available_atTeaghrán nullRiachtanach

An chéad rochtain don cheannach seo; ní atosaíonn ionadú an tréimhse.

Teaghrán:format: "date-time"
Sampla: "2026-11-03T12:00:00Z"
generationSlánuimhirRiachtanach

Glúin an leithdháilte; méadaíonn sí le hionadú.

Sampla: 1
idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é.

format: "uuid"
Sampla: "00000000-0000-4000-8000-000000000005"
kindTeaghrán nullRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

Sampla: "code"
line_idTeaghránRiachtanach

Aitheantóir seasta líne an ordaithe.

Sampla: "line-example"
order_idTeaghránRiachtanach

Aitheantóir ordaithe ghaolmhair.

Sampla: "order-example"
payload_idTeaghránRiachtanach

ID an ábhair; ní URL poiblí íoslódála é.

format: "uuid"
Sampla: "00000000-0000-4000-8000-000000000012"
product_idTeaghránRiachtanach

Aitheantóir táirge.

Sampla: "example"
reasonTeaghránRiachtanach

Cúis taifeadta don athrú.

Sampla: ""
size_bytesSlánuimhir nullRiachtanach

Méid i mbearta

Sampla: null
stateTeaghránRiachtanach

Stádas

Sampla: "available"
unit_idTeaghránRiachtanach

ID cóid nó comhaid aonair.

format: "uuid"
Sampla: "00000000-0000-4000-8000-000000000011"
unit_ordinalSlánuimhirRiachtanach

Uimhir an aonaid cheannaigh laistigh de líne an ordaithe.

Sampla: 1
variant_idTeaghrán nullRiachtanach

Aitheantóir athraithigh táirge.

Sampla: null
versionSlánuimhirRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

Sampla: 2

Réimsí breise: Níl

Eolas sonraisc

InvoiceData · Scéim · Scéimeanna sonraí: Orduithe
address_line_1Teaghrán nullRiachtanach

An chéad líne den seoladh.

address_line_2Teaghrán nullRiachtanach

Eolas breise faoin seoladh.

cityTeaghrán nullRiachtanach

Cathair nó ceantar.

company_nameTeaghrán nullRiachtanach

Ainm na cuideachta.

country_codeTeaghrán nullRiachtanach

Cód tíre.

house_numberTeaghrán nullRiachtanach

Uimhir foirgnimh nó tí.

postal_codeTeaghrán nullRiachtanach

Cód poist.

regionTeaghrán nullRiachtanach

Réigiún riaracháin.

streetTeaghrán nullRiachtanach

Ainm sráide.

tax_identifierTeaghrán nullRiachtanach

Uimhir aitheantais cánach.

tax_schemeTeaghrán nullRiachtanach

Scéim ríofa cánach.

Réimsí breise: Níl

Glanmhéid / Méid cánach / Ollmhéid

OrderAmountBreakdownData · Tagann na méideanna agus rátaí cánach ón ordú sábháilte, lena n-áirítear ceartúcháin línte. Is null iad sonraí stairiúla atá ar iarraidh agus ní chuirtear rátaí reatha an chatalóige ina n-áit. Fanann méideanna mar theaghráin dheachúlacha.
grossMoneyData Riachtanach

Ollmhéid · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullRiachtanach

Glanmhéid · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullRiachtanach

Méid cánach · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

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

Réimsí breise: Níl

Seachadadh · Lascainí

OrderDeliveryDiscountData · Tagann na méideanna agus rátaí cánach ón ordú sábháilte, lena n-áirítear ceartúcháin línte. Is null iad sonraí stairiúla atá ar iarraidh agus ní chuirtear rátaí reatha an chatalóige ina n-áit. Fanann méideanna mar theaghráin dheachúlacha.
amountMoneyData Riachtanach

Ollmhéid · Seachadadh · Lascainí.

Sampla: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é.

Sampla: "saved-coupon"
codeTeaghrán nullRiachtanach

Cód cobhsaí atá inléite ag meaisín.

Sampla: "SAVE"
kindTeaghránRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

Srianta
enum
["coupon", "promotion"]
Sampla: "coupon"
nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Saved coupon"
sequenceSlánuimhir nullRiachtanach

Suíomh sa bhailiúchán ordaithe.

Sampla: 1
versionSlánuimhirRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

Sampla: 3

Réimsí breise: Níl

Faigh — Orduithe — Freagra

OrderDetailData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
created_atTeaghránRiachtanach

Am cruthaithe.

format: "date-time"
Sampla: "2026-10-19T10:00:00Z"
customerCustomerData Riachtanach

Eolas custaiméara taifeadta don acmhainn seo.

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

Modh seachadta agus eolas gaolmhar.

Sampla: {"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 Riachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

Sampla: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsEagar <OrderDiscountData > Riachtanach

Lascainí

Sampla: [{"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}]
idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. (OrderDetailData).

Sampla: "order-0000"
invoiceInvoiceData nullRiachtanach

Eolas sonraisc.

Sampla: null
invoice_requestedLuach BooleRiachtanach

Ar iarradh sonrasc.

Sampla: false
lifecycle_stateOrderLifecycleState Riachtanach

Staid shaolré ghnó.

Sampla: "placed"
linesEagar <OrderLineData > Riachtanach

Cóipeanna de shonraí línte ordaithe tráth an ordaithe.

Sampla: [{"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":[]}]
localeTeaghránRiachtanach

Teanga roghnaithe don iarratas seo.

Sampla: "pl"
market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

Sampla: "market-pl"
numberTeaghránRiachtanach

Uimhir ordaithe nó iarratais atá le léamh ag duine.

Sampla: "0001"
paymentPaymentData Riachtanach

Sonraí íocaíochta taifeadta don ordú.

Sampla: {"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 nullRiachtanach

Pointe bailithe

Sampla: null
prices_include_taxLuach BooleRiachtanach

An bhfuil cáin sna praghsanna liostaithe.

Sampla: true
shipping_addressAddressData nullRiachtanach

Seoladh seachadta.

Sampla: null
shipping_discount_amountMoneyData Riachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

Sampla: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Riachtanach

Stádas a ghlacann an oibríocht áirithe seo.

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

Suim roimh na comhpháirteanna breise a thaispeántar sa fhreagra.

Sampla: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Riachtanach

Eolas cánach.

Sampla: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Riachtanach

Grúpaí cánach · source + tax_rate; unallocated_tax.

Sampla: {"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_codeTeaghrán nullRiachtanach

Tír chánach · Sonraí sábháilte an ordaithe · ISO 3166-1 alpha-2; null.

Sampla: "PL"
totalMoneyData Riachtanach

Suim iomlán.

Sampla: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Riachtanach

Iomláin · net / tax / gross; Roimh lascainí / Tar éis lascainí.

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

Réimsí breise: Níl

OrderFileData

OrderFileData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
can_downloadLuach BooleRiachtanach

Íoslódáil (true / false)

Sampla: true
categoryFileCategory Riachtanach

Catagóir comhaid: internal / customer_document / digital

Sampla: "digital"
filenameTeaghránRiachtanach

Comhad

Sampla: "manual.pdf"
idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é.

Sampla: "example"
labelTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Manual"
line_idTeaghránRiachtanach

Aitheantóir seasta líne an ordaithe.

Sampla: "example"
mime_typeTeaghránRiachtanach

Cineál ábhair meán.

Sampla: "application/pdf"
product_idTeaghránRiachtanach

Aitheantóir táirge.

Sampla: "example"
purchase_idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. · purchase_id

Sampla: "00000000-0000-4000-8000-000000000001"
reasonTeaghránRiachtanach

Cúis taifeadta don athrú.

Sampla: "paid"
sha256TeaghránRiachtanach

SHA-256 (hex, 64)

Sampla: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesSlánuimhirRiachtanach

Méid i mbearta

minimum: 1maximum: 262144000
Sampla: 46
source_file_idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. · source_file_id

Sampla: "00000000-0000-4000-8000-000000000001"
source_version_idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. · source_version_id

Sampla: "00000000-0000-4000-8000-000000000001"
source_version_numberSlánuimhirRiachtanach

Leagan

minimum: 1
Sampla: 1
stateTeaghránRiachtanach

Stádas

Sampla: "active"

Réimsí breise: Níl

OrderFileListData

OrderFileListData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
filesEagar <OrderFileData > Riachtanach

Comhaid táirge

Sampla: [{"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_pendingLuach BooleRiachtanach

Rochtain ar chomhaid amach anseo tar éis ceannaigh · updates_pending

Sampla: false

Réimsí breise: Níl

Meiteashonraí agus URL íomhá

OrderImageData · Scéim · Scéimeanna sonraí: Orduithe
altTeaghrán nullRiachtanach

Téacs malartach d'íomhá.

sourceTeaghránRoghnach

Foinse na gníomhaíochta taifeadta.

const: "current_catalog"
Réamhshocrú: "current_catalog"
urlTeaghránRiachtanach

URL na hacmhainne.

Réimsí breise: Níl

Staid shaolré ghnó

OrderLifecycleState · Scéim · Scéimeanna sonraí: Orduithe Teaghrán
Srianta
enum
["placed", "cancelled", "fulfilled", "returned"]

Réimsí breise: Tá

Cóipeanna de shonraí línte ordaithe tráth an ordaithe

OrderLineData · Scéim · Scéimeanna sonraí: Orduithe
discount_amountMoneyData Riachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

Sampla: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Riachtanach

Ollmhéid · Lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullRiachtanach

Glanmhéid · Lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullRiachtanach

Méid cánach · Lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsEagar <OrderDiscountData > Riachtanach

Lascainí · net / tax / gross.

Sampla: [{"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}]
identifiersOibiachtRéimsí breise: TeaghránRiachtanach

Cóid aitheantais táirge.

Sampla: {}
imageOrderImageData nullRiachtanach

Meiteashonraí agus URL íomhá.

Sampla: null
line_idTeaghránRiachtanach

Aitheantóir seasta líne an ordaithe.

Sampla: "saved-line-a"
manual_discountOrderManualDiscountData nullRiachtanach

Lascaine láimhe; null.

Sampla: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Saved A"
original_totalMoneyData Riachtanach

Suim iomlán.

Sampla: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Riachtanach

Ollmhéid · Táirgí · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullRiachtanach

Glanmhéid · Táirgí · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullRiachtanach

Méid cánach · Táirgí · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"46.00","currency":"PLN","minor_units":2}
positionSlánuimhirRiachtanach

Suíomh sa bhailiúchán ordaithe.

Sampla: 1
product_idTeaghránRiachtanach

Aitheantóir táirge.

Sampla: "product-api"
quantitySlánuimhirRiachtanach

Líon aonad.

Sampla: 2
skuTeaghránRiachtanach

Cód aonaid coimeádta stoic.

Sampla: "A"
taxMoneyData nullRiachtanach

Méid cánach · Aonad amháin · Sonraí sábháilte an ordaithe; tax ≠ unit_tax; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idTeaghrán nullRiachtanach

Aitheantóir na catagóire cánach · Sonraí sábháilte an ordaithe; null.

Sampla: "standard"
tax_category_nameTeaghrán nullRiachtanach

Ainm sábháilte na catagóire cánach; null.

Sampla: "VAT 23%"
tax_rateTeaghrán nullRiachtanach

tax_rate · Sonraí sábháilte an ordaithe: "0.23" = 23%; "0" ≠ null.

Sampla: "0.23"
totalMoneyData Riachtanach

Suim iomlán.

Sampla: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Riachtanach

Ollmhéid · Táirgí · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullRiachtanach

Glanmhéid · Táirgí · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullRiachtanach

Méid cánach · Táirgí · Tar éis lascainí · Sonraí sábháilte an ordaithe; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Riachtanach

Ollmhéid · Aonad amháin · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullRiachtanach

Glanmhéid · Aonad amháin · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Riachtanach

Praghas aonaid.

Sampla: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullRiachtanach

Méid cánach · Aonad amháin · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idTeaghrán nullRiachtanach

Aitheantóir athraithigh táirge.

Sampla: null
variant_optionsEagar <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Riachtanach

Roghanna athraitheach a bhaineann leis an táirge nó leis an léargas sonraí.

Sampla: []

Réimsí breise: Níl

Lascaine láimhe

OrderManualDiscountData · Tagann na méideanna agus rátaí cánach ón ordú sábháilte, lena n-áirítear ceartúcháin línte. Is null iad sonraí stairiúla atá ar iarraidh agus ní chuirtear rátaí reatha an chatalóige ina n-áit. Fanann méideanna mar theaghráin dheachúlacha.
amountMoneyData Riachtanach

Ollmhéid · Lascaine láimhe · Sonraí sábháilte an ordaithe.

Sampla: {"amount":"12.30","currency":"PLN","minor_units":2}
kindTeaghránRiachtanach

Cineál lascaine: percentage / fixed.

Srianta
enum
["percentage", "fixed"]
Sampla: "fixed"
valueTeaghránRiachtanach

Luach cumraithe: percentage "10" = 10%; fixed = Ollmhéid.

Sampla: "12.30"

Réimsí breise: Níl

Stádas a ghlacann an oibríocht áirithe seo

OrderPaymentStatus · Scéim · Scéimeanna sonraí: Orduithe Teaghrán
Srianta
enum
["unpaid", "paid", "failed", "refunded"]

Réimsí breise: Tá

OrderReleaseData

OrderReleaseData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
access_reasonTeaghránRiachtanach

Rochtain tar éis ceannaigh · Cúis taifeadta don athrú.

Sampla: "paid"
access_stateTeaghránRiachtanach

Rochtain tar éis ceannaigh · Stádas

Sampla: "active"
current_releaseCurrentReleaseData nullRiachtanach

Eisiúintí digiteacha · current_release

Sampla: null
grant_reasonTeaghránRiachtanach

Rochtain tar éis ceannaigh · Cúis taifeadta don athrú.

Sampla: "purchase"
granted_atTeaghránRiachtanach

Rochtain tar éis ceannaigh · UTC

format: "date-time"
Sampla: "2026-01-01T12:00:00Z"
idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é.

Sampla: "example"
line_idTeaghránRiachtanach

Aitheantóir seasta líne an ordaithe.

Sampla: "example"
manifest_sha256TeaghránRiachtanach

Eisiúintí digiteacha · SHA-256

Sampla: "1111111111111111111111111111111111111111111111111111111111111111"
product_idTeaghránRiachtanach

Aitheantóir táirge.

Sampla: "example"
published_atTeaghránRiachtanach

Foilsigh an eisiúint · UTC

format: "date-time"
Sampla: "2026-01-01T12:00:00Z"
purchase_idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. · purchase_id

Sampla: "00000000-0000-4000-8000-000000000001"
release_idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. · release_id

Sampla: "00000000-0000-4000-8000-000000000001"
release_sequenceSlánuimhirRiachtanach

Eisiúintí digiteacha · Suíomh sa bhailiúchán ordaithe.

Sampla: 1
update_daysSlánuimhir nullRiachtanach

Líon laethanta (days; null)

Sampla: 365
update_modeTeaghránRiachtanach

Rochtain ar chomhaid amach anseo tar éis ceannaigh: none / period / unlimited

Sampla: "period"
update_monthsSlánuimhir nullRiachtanach

Míonna (months; null)

Sampla: null
updates_untilTeaghrán nullRiachtanach

Rochtain ar chomhaid amach anseo tar éis ceannaigh · UTC

Teaghrán:format: "date-time"
Sampla: "2027-01-01T12:00:00Z"
version_labelTeaghránRiachtanach

Leagan

Sampla: "1.0"

Réimsí breise: Níl

OrderReleaseListData

OrderReleaseListData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais. Tar éis upload_id a chruthú, uaslódáil na comhaid mar multipart/form-data agus ceangail leis an táirge iad. Teastaíonn comhartha Bearer agus cead do category chun íoslódáil; bíonn bearta an chomhaid sa fhreagra, gan seoladh poiblí ná pasfhocal. Le mode=period, roghnaigh days (1–3650) nó an seanluach months, ní an dá cheann. Sábháiltear na coinníollacha tráth an cheannaigh; ní bhaineann aisíocaíocht rochtain ach den líne aisíoctha.
releasesEagar <OrderReleaseData > Riachtanach

Eisiúintí digiteacha

Sampla: [{"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_pendingLuach BooleRiachtanach

Rochtain ar chomhaid amach anseo tar éis ceannaigh · updates_pending

Sampla: false

Réimsí breise: Níl

Stádas a ghlacann an oibríocht áirithe seo

OrderStatusData · Scéim · Scéimeanna sonraí: Orduithe
idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. (OrderStatusData).

Sampla: "status-0"
nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Status 0"
updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"
Sampla: "2026-10-19T10:00:00Z"
versionSlánuimhirRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

Sampla: 1

Réimsí breise: Níl

Liostaigh · Stádais — Orduithe — Freagra

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
created_atTeaghránRiachtanach

Am cruthaithe.

format: "date-time"
Sampla: "2026-01-01T12:00:00Z"
idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Sampla: "status-0"
is_initialLuach BooleRiachtanach

An é seo an stádas tosaigh.

Sampla: true
nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "New"
positionSlánuimhirRiachtanach

Suíomh sa bhailiúchán ordaithe.

Sampla: 0

Réimsí breise: Níl

Liostaigh · Stádais — Orduithe — Freagra

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
dataEagar <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Riachtanach

Sampla freagra · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Sampla: [{"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 Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

Nuashonraigh · Stádas — Orduithe — Corp an iarratais

OrderStatusUpdate · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
expected_versionSlánuimhirRiachtanach

Leagan a léadh roimh scríobh; diúltaítear don nuashonrú mura n-oireann sé.

minimum: 1maximum: 9223372036854775807
Sampla: 1
status_idTeaghránRiachtanach

Aitheantóir ón bhfoclóir stádais cuí.

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

Réimsí breise: Níl

Liostaigh — Orduithe — Freagra

OrderSummaryData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
created_atTeaghránRiachtanach

Am cruthaithe.

format: "date-time"
Sampla: "2026-10-19T10:00:00Z"
customerCustomerData Riachtanach

Eolas custaiméara taifeadta don acmhainn seo.

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

Modh seachadta agus eolas gaolmhar.

Sampla: {"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 Riachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

Sampla: {"amount":"24.60","currency":"PLN","minor_units":2}
idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. (OrderSummaryData).

Sampla: "order-0000"
lifecycle_stateOrderLifecycleState Riachtanach

Staid shaolré ghnó.

Sampla: "placed"
localeTeaghránRiachtanach

Teanga roghnaithe don iarratas seo.

Sampla: "pl"
market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

Sampla: "market-pl"
numberTeaghránRiachtanach

Uimhir ordaithe nó iarratais atá le léamh ag duine.

Sampla: "0001"
paymentPaymentData Riachtanach

Sonraí íocaíochta taifeadta don ordú.

Sampla: {"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_taxLuach BooleRiachtanach

An bhfuil cáin sna praghsanna liostaithe.

Sampla: true
shipping_discount_amountMoneyData Riachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

Sampla: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Riachtanach

Stádas a ghlacann an oibríocht áirithe seo.

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

Suim roimh na comhpháirteanna breise a thaispeántar sa fhreagra.

Sampla: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Riachtanach

Eolas cánach.

Sampla: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeTeaghrán nullRiachtanach

Tír chánach · Sonraí sábháilte an ordaithe · ISO 3166-1 alpha-2; null.

Sampla: "PL"
totalMoneyData Riachtanach

Suim iomlán.

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

Réimsí breise: Níl

Ordú · Grúpaí cánach

OrderTaxBreakdownData · Tagann na méideanna agus rátaí cánach ón ordú sábháilte, lena n-áirítear ceartúcháin línte. Is null iad sonraí stairiúla atá ar iarraidh agus ní chuirtear rátaí reatha an chatalóige ina n-áit. Fanann méideanna mar theaghráin dheachúlacha.
groupsEagar <OrderTaxGroupData > Riachtanach

Grúpaí cánach · source + tax_rate; Anaithnid: null; náid aitheanta: 0.

Sampla: [{"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 Riachtanach

Cáin neamh-leithdháilte = order.tax − Σ groups.tax; ±.

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

Réimsí breise: Níl

Grúpaí cánach

OrderTaxGroupData · Tagann na méideanna agus rátaí cánach ón ordú sábháilte, lena n-áirítear ceartúcháin línte. Is null iad sonraí stairiúla atá ar iarraidh agus ní chuirtear rátaí reatha an chatalóige ina n-áit. Fanann méideanna mar theaghráin dheachúlacha.
grossMoneyData Riachtanach

Ollmhéid · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullRiachtanach

Glanmhéid · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceTeaghránRiachtanach

Foinse: products (Táirgí), shipping (Seachadadh).

Srianta
enum
["products", "shipping"]
Sampla: "products"
taxMoneyData nullRiachtanach

Méid cánach · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateTeaghrán nullRiachtanach

tax_rate · Sonraí sábháilte an ordaithe: "0.23" = 23%; "0" ≠ null.

Sampla: "0.23"

Réimsí breise: Níl

Ordú · Iomláin

OrderTotalsData · Tagann na méideanna agus rátaí cánach ón ordú sábháilte, lena n-áirítear ceartúcháin línte. Is null iad sonraí stairiúla atá ar iarraidh agus ní chuirtear rátaí reatha an chatalóige ina n-áit. Fanann méideanna mar theaghráin dheachúlacha.
before_discountsOrderAmountBreakdownData Riachtanach

Ordú · Roimh lascainí · net / tax / gross.

Sampla: {"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 Riachtanach

Lascainí · net / tax / gross.

Sampla: {"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 Riachtanach

Ordú · Tar éis lascainí · net / tax / gross.

Sampla: {"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 Riachtanach

Táirgí · Lascainí · net / tax / gross.

Sampla: {"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 Riachtanach

Táirgí · Tar éis lascainí · net / tax / gross.

Sampla: {"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 Riachtanach

Táirgí · Roimh lascainí · net / tax / gross.

Sampla: {"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 Riachtanach

Seachadadh · Tar éis lascainí · net / tax / gross.

Sampla: {"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 Riachtanach

Seachadadh · Roimh lascainí · net / tax / gross.

Sampla: {"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 Riachtanach

Seachadadh · Lascainí · net / tax / gross.

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

Réimsí breise: Níl

Roghanna athraitheach a bhaineann leis an táirge nó leis an léargas sonraí

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Scéim · Scéimeanna sonraí: Orduithe
nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

valueTeaghránRiachtanach

Luach a ndéanann an scéim máguaird cur síos air.

Réimsí breise: Níl

OrderDiscountData

OrderDiscountData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
amountMoneyData Riachtanach

Ollmhéid · Táirgí · Lascainí.

Sampla: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é.

Sampla: "saved-coupon"
codeTeaghrán nullRiachtanach

Cód cobhsaí atá inléite ag meaisín.

Sampla: "SAVE"
kindTeaghránRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

Srianta
enum
["coupon", "promotion"]
Sampla: "coupon"
nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Saved coupon"
sequenceSlánuimhir nullRoghnach

Ord feidhmithe; null.

Sampla: 1
shipping_amountMoneyData nullRoghnach

Ollmhéid · Seachadadh · Lascainí; null.

Sampla: {"amount":"24.60","currency":"PLN","minor_units":2}
versionSlánuimhirRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

Sampla: 3

Réimsí breise: Níl

Sonraí íocaíochta taifeadta don ordú

PaymentData · Scéim · Scéimeanna sonraí: Orduithe
amountMoneyData Riachtanach

Is é payment.amount iomlán an ordaithe. Ní chinneann stádas íocaíochta méideanna íoctha, aisíoctha ná dlite.

Sampla: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentTeaghránRiachtanach

Eolas timpeallachta a ghabhann leis an taifead.

Srianta
enum
["live", "sandbox"]
Sampla: "live"
method_codeTeaghrán nullRiachtanach

Cód modha seachadta nó íocaíochta.

Sampla: "payment-old"
method_nameTeaghrán nullRiachtanach

Ainm modha seachadta nó íocaíochta.

Sampla: "Historic method"
paid_atTeaghrán nullRiachtanach

Dáta agus am a marcáladh an íocaíocht íoctha.

Teaghrán:format: "date-time"
Sampla: null
statusOrderPaymentStatus Riachtanach

Stádas a ghlacann an oibríocht áirithe seo.

Sampla: "unpaid"
updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"
Sampla: "2026-10-19T10:00:00Z"
versionSlánuimhirRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

Sampla: 0

Réimsí breise: Níl

Nuashonraigh · Stádas íocaíochta — Orduithe — Corp an iarratais

PaymentStatusUpdate · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
expected_versionSlánuimhirRiachtanach

Leagan a léadh roimh scríobh; diúltaítear don nuashonrú mura n-oireann sé.

minimum: 0maximum: 9223372036854775807
Sampla: 0
reasonTeaghránRiachtanach

Cúis taifeadta don athrú.

minLength: 1maxLength: 500
Sampla: "Bank transfer confirmed"
statusPaymentStatus Riachtanach

Stádas a ghlacann an oibríocht áirithe seo. unpaid: gan íoc; paid: íoctha; failed: theip ar an íocaíocht; refunded: aisíoctha.

Sampla: "paid"

Réimsí breise: Níl

Stádas a ghlacann an oibríocht áirithe seo

PaymentStatus · Scéim · Scéimeanna sonraí: Orduithe Teaghrán
Srianta
enum
["unpaid", "paid", "failed", "refunded"]

Réimsí breise: Tá

PickupPointAddressData

PickupPointAddressData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
address_line_1TeaghránRiachtanach

An chéad líne den seoladh.

minLength: 1maxLength: 240
cityTeaghránRiachtanach

Cathair nó ceantar.

minLength: 1maxLength: 160
postal_codeTeaghránRiachtanach

Cód poist.

minLength: 1maxLength: 32

Réimsí breise: Níl

PickupPointCoordinatesData

PickupPointCoordinatesData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
latitudeUimhirRiachtanach

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeUimhirRiachtanach

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Réimsí breise: Níl

PickupPointData

PickupPointData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
address_line1TeaghránRiachtanach

An chéad líne den seoladh.

cityTeaghránRiachtanach

Cathair nó ceantar.

codeTeaghránRiachtanach

Cód cobhsaí atá inléite ag meaisín.

country_codeTeaghránRiachtanach

Cód tíre.

kindTeaghránRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

Srianta
enum
["locker", "pickup_point"]
latitudeUimhir nullRiachtanach

WGS84 φ (°)

location_descriptionTeaghrán nullRiachtanach

Cur síos sa teanga roghnaithe.

longitudeUimhir nullRiachtanach

WGS84 λ (°)

nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

opening_hoursTeaghrán nullRiachtanach

Opening hours

operatorTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

postal_codeTeaghránRiachtanach

Cód poist.

Réimsí breise: Níl

PickupPointSummaryData

PickupPointSummaryData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
codeTeaghránRiachtanach

Cód cobhsaí atá inléite ag meaisín.

Srianta
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeTeaghránRiachtanach

Cód tíre.

Srianta
pattern
"^[A-Z]{2}$"
environmentTeaghránRiachtanach

Eolas timpeallachta a ghabhann leis an taifead.

Srianta
enum
["live", "sandbox"]
kindTeaghránRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

Srianta
enum
["locker", "pickup_point"]
operatorTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

minLength: 1maxLength: 63

Réimsí breise: Níl

Eolas custaiméara taifeadta don acmhainn seo

RequestCustomerData · Scéim · Scéimeanna sonraí: Orduithe
emailTeaghránRiachtanach

Seoladh ríomhphoist.

Sampla: "customer@example.invalid"
nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Example"

Réimsí breise: Níl

Modh seachadta agus eolas gaolmhar

ShippingData · Scéim · Scéimeanna sonraí: Orduithe
amountMoneyData Riachtanach

Méid comhlán loingseoireachta taifeadta ar an ordú mar MoneyData. Ní athraíonn athruithe cánach níos déanaí an méid stairiúil seo.

Sampla: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Riachtanach

Dátaí seolta agus seachadta. Tá delivery.dates ar fáil sa liosta orduithe agus sna sonraí. Is dátaí pleanáilte iad YYYY-MM-DD agus ní dheimhníonn siad seoladh. Tá tosaíocht ag na dátaí reatha; úsáideann seanorduithe an meastachán sábháilte. Is null iad luachanna glanta nó anaithnide. Tá gach líne ordaithe agus íomhá táirge sna sonraí freisin.

Sampla: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
method_codeTeaghrán nullRiachtanach

Cód modha seachadta nó íocaíochta.

Sampla: "shipping-old"
method_nameTeaghrán nullRiachtanach

Ainm modha seachadta nó íocaíochta.

Sampla: "Historic carrier"
pickup_pointPickupPointSummaryData nullRiachtanach

Pointe bailithe

Sampla: null
recipient_modeTeaghránRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

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

Réimsí breise: Níl

ShippingDetailData

ShippingDetailData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.
amountMoneyData Riachtanach

Méid comhlán loingseoireachta taifeadta ar an ordú mar MoneyData. Ní athraíonn athruithe cánach níos déanaí an méid stairiúil seo.

Sampla: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Riachtanach

Dátaí seolta agus seachadta. Tá delivery.dates ar fáil sa liosta orduithe agus sna sonraí. Is dátaí pleanáilte iad YYYY-MM-DD agus ní dheimhníonn siad seoladh. Tá tosaíocht ag na dátaí reatha; úsáideann seanorduithe an meastachán sábháilte. Is null iad luachanna glanta nó anaithnide. Tá gach líne ordaithe agus íomhá táirge sna sonraí freisin.

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

Ollmhéid · Lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullRiachtanach

Glanmhéid · Lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullRiachtanach

Méid cánach · Lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsEagar <OrderDeliveryDiscountData > nullRiachtanach

Seachadadh · Lascainí; []: 0; null: Anaithnid: null; náid aitheanta: 0.

Sampla: [{"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 Riachtanach

Ollmhéid · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeTeaghrán nullRiachtanach

Cód modha seachadta nó íocaíochta.

Sampla: "shipping-old"
method_nameTeaghrán nullRiachtanach

Ainm modha seachadta nó íocaíochta.

Sampla: "Historic carrier"
netMoneyData nullRiachtanach

Glanmhéid · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Riachtanach

Ollmhéid · Seachadadh · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullRiachtanach

Glanmhéid · Seachadadh · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullRiachtanach

Méid cánach · Seachadadh · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullRiachtanach

Pointe bailithe

Sampla: null
recipient_modeTeaghránRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

Srianta
enum
["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
Sampla: "full_address"
taxMoneyData nullRiachtanach

Méid cánach · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

Sampla: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idTeaghrán nullRiachtanach

Aitheantóir na catagóire cánach · Sonraí sábháilte an ordaithe; null.

Sampla: "standard"
tax_category_nameTeaghrán nullRiachtanach

Ainm sábháilte na catagóire cánach; null.

Sampla: "VAT 23%"
tax_rateTeaghrán nullRiachtanach

tax_rate · Sonraí sábháilte an ordaithe: "0.23" = 23%; "0" ≠ null.

Sampla: "0.23"

Réimsí breise: Níl