Scéimeanna sonraí: Earraí ar ais, gearáin agus malartuithe

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

Scéimeanna sonraí

Liostaigh — Earraí ar ais, gearáin agus malartuithe — Freagra

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

dataEagar <RequestSummaryData > Riachtanach: Sampla freagra · ApiResponse_list_RequestSummaryData__.

Sampla: [{"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":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

Faigh — Earraí ar ais, gearáin agus malartuithe — Freagra

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

dataRequestDetailData Riachtanach: Sampla freagra · RequestDetailData.

Sampla: {"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","items":[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}],"number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach: Meiteashonraí an fhreagra.

Sampla: {"request_id":"example"}

Réimsí breise: Níl

Nuashonraigh · Méid aisíocaíochta — Earraí ar ais, gearáin agus malartuithe — Corp an iarratais

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

amountTeaghránRiachtanach

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

minLength: 1maxLength: 64

Srianta

pattern: "^[+-]?(?:[0-9]+(?:\\.[0-9]+)?|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?$"

Sampla: "0.00"

expected_versionSlánuimhirRiachtanach

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

minimum: 0maximum: 9223372036854775807

Sampla: 1

reasonTeaghránRoghnach

Cúis taifeadta don athrú.

maxLength: 500

Réamhshocrú: ""

Réimsí breise: Níl

Eolas aisíocaíochta taifeadta

RefundData · Scéim · Scéimeanna sonraí: Earraí ar ais, gearáin agus malartuithe

amountMoneyData nullRiachtanach

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

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

completed_atTeaghrán nullRiachtanach

Am críochnaithe.

Teaghrán:format: "date-time"

Sampla: null

statusTeaghránRiachtanach

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

Srianta

enum: ["pending", "completed"]

Sampla: "pending"

updated_atTeaghrán nullRiachtanach

Am an nuashonraithe is déanaí.

Teaghrán:format: "date-time"

Sampla: "2026-01-01T12:00:00Z"

versionSlánuimhirRiachtanach

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

Sampla: 1

Réimsí breise: Níl

Faigh — Earraí ar ais, gearáin agus malartuithe — Freagra

RequestDetailData · 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"

customerRequestCustomerData Riachtanach

Eolas custaiméara taifeadta don acmhainn seo.

Sampla: {"email":"customer@example.invalid","name":"Example"}

idTeaghránRiachtanach

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

Sampla: "example"

itemsEagar <RequestItemData > Riachtanach

Míreanna san acmhainn.

Sampla:

[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}]

numberTeaghránRiachtanach

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

Sampla: "example"

order_idTeaghránRiachtanach

Aitheantóir ordaithe ghaolmhair.

Sampla: "example"

order_numberTeaghránRiachtanach

Uimhir ordaithe ghaolmhair.

Sampla: "example"

products_valueMoneyData Riachtanach

Luach táirgí an ordaithe.

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

refundRefundData Riachtanach

Eolas aisíocaíochta taifeadta.

Sampla:

{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

resolution_stateTeaghránRiachtanach

Staid réitigh iarratais custaiméara.

Srianta

enum: ["unknown", "open", "completed", "rejected", "cancelled"]

Sampla: "unknown"

statusRequestStatusData Riachtanach

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

Sampla: {"id":"example","locale":"en","name":"Example"}

typeRequestType Riachtanach

Cineál acmhainne.

Sampla: "return"

updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"

Sampla: "2026-01-01T12:00:00Z"

versionSlánuimhirRiachtanach

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

Sampla: 1

Réimsí breise: Níl

Faigh — Earraí ar ais, gearáin agus malartuithe — Freagra

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

idTeaghránRiachtanach: Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. (RequestItemData).

Sampla: "example"
nameTeaghránRiachtanach: Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Example"
order_line_idTeaghrán nullRiachtanach: Aitheantóir líne ordaithe gaolmhaire.

Sampla: "example"
product_idTeaghránRiachtanach: Aitheantóir táirge.

Sampla: "example"
quantitySlánuimhirRiachtanach: Líon aonad.

Sampla: 1
returned_quantitySlánuimhirRiachtanach: Cainníocht a cuireadh ar ais don líne seo.

Sampla: 1
skuTeaghránRiachtanach: Cód aonaid coimeádta stoic.

Sampla: "example"
totalMoneyData Riachtanach: Suim iomlán.

Sampla: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Riachtanach: Praghas aonaid.

Sampla: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idTeaghrán nullRiachtanach: Aitheantóir athraithigh táirge.

Sampla: "example"
variant_optionsEagar <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Riachtanach: Roghanna athraitheach a bhaineann leis an táirge nó leis an léargas sonraí.

Sampla: [{"name":"Example","value":"example"}]

Réimsí breise: Níl

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

RequestStatusData · Scéim · Scéimeanna sonraí: Earraí ar ais, gearáin agus malartuithe

idTeaghránRiachtanach: Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. (RequestStatusData).

Sampla: "example"
localeTeaghránRiachtanach: Teanga roghnaithe don iarratas seo.

Sampla: "en"
nameTeaghrán nullRiachtanach: Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Example"

Réimsí breise: Níl

Liostaigh · Stádais — Earraí ar ais, gearáin agus malartuithe — Freagra

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · 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.

Sampla: "example"
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__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Sampla: "example"
is_initialLuach BooleRiachtanach: An é seo an stádas tosaigh.

Sampla: false
localeTeaghránRiachtanach: Teanga roghnaithe don iarratas seo.

Sampla: "en"
nameTeaghrán nullRiachtanach: Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Example"
positionSlánuimhirRiachtanach: Suíomh sa bhailiúchán ordaithe.

Sampla: 1
typeRequestType Riachtanach: Cineál acmhainne.

Sampla: "return"

Réimsí breise: Níl

Liostaigh · Stádais — Earraí ar ais, gearáin agus malartuithe — Freagra

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

dataEagar <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Riachtanach: Sampla freagra · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Sampla: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"locale":"en","name":"Example","position":1,"type":"return"}]
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 — Earraí ar ais, gearáin agus malartuithe — Corp an iarratais

RequestStatusUpdate · 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: "example"

Réimsí breise: Níl

Liostaigh — Earraí ar ais, gearáin agus malartuithe — Freagra

RequestSummaryData · 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"

customerRequestCustomerData Riachtanach

Eolas custaiméara taifeadta don acmhainn seo.

Sampla: {"email":"customer@example.invalid","name":"Example"}

idTeaghránRiachtanach

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

Sampla: "example"

numberTeaghránRiachtanach

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

Sampla: "example"

order_idTeaghránRiachtanach

Aitheantóir ordaithe ghaolmhair.

Sampla: "example"

order_numberTeaghránRiachtanach

Uimhir ordaithe ghaolmhair.

Sampla: "example"

products_valueMoneyData Riachtanach

Luach táirgí an ordaithe.

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

refundRefundData Riachtanach

Eolas aisíocaíochta taifeadta.

Sampla:

{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

resolution_stateTeaghránRiachtanach

Staid réitigh iarratais custaiméara.

Srianta

enum: ["unknown", "open", "completed", "rejected", "cancelled"]

Sampla: "unknown"

statusRequestStatusData Riachtanach

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

Sampla: {"id":"example","locale":"en","name":"Example"}

typeRequestType Riachtanach

Cineál acmhainne.

Sampla: "return"

updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"

Sampla: "2026-01-01T12:00:00Z"

versionSlánuimhirRiachtanach

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

Sampla: 1

Réimsí breise: Níl

Cineál acmhainne

RequestType · Scéim · Scéimeanna sonraí: Earraí ar ais, gearáin agus malartuithe

Teaghrán

Srianta

enum: ["return", "exchange", "complaint"]

Réimsí breise: Tá

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

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Scéim · Scéimeanna sonraí: Earraí ar ais, gearáin agus malartuithe

nameTeaghránRiachtanach: Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Example"
valueTeaghránRiachtanach: Luach a ndéanann an scéim máguaird cur síos air.

Sampla: "example"

Réimsí breise: Níl