Tietoskeemat: Palautukset, reklamaatiot ja vaihdot

Tietoskeemat: Palautukset, reklamaatiot ja vaihdot. API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

Tietoskeemat

Listaa — Palautukset, reklamaatiot ja vaihdot — Vastaus

ApiResponse_list_RequestSummaryData__ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataTaulukko <RequestSummaryData > Pakollinen: Vastausesimerkki · ApiResponse_list_RequestSummaryData__.

Esimerkki: [{"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 Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Hae — Palautukset, reklamaatiot ja vaihdot — Vastaus

ApiResponse_RequestDetailData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataRequestDetailData Pakollinen: Vastausesimerkki · RequestDetailData.

Esimerkki: {"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 Pakollinen: Vastauksen metatiedot.

Esimerkki: {"request_id":"example"}

Lisäkentät: Ei

Päivitä · Palautussumma — Palautukset, reklamaatiot ja vaihdot — Pyynnön sisältö

RefundAmountUpdate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

amountMerkkijonoPakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

minLength: 1maxLength: 64

Rajoitukset

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

Esimerkki: "0.00"

expected_versionKokonaislukuPakollinen

Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 0maximum: 9223372036854775807

Esimerkki: 1

reasonMerkkijonoValinnainen

Muutokselle kirjattu syy.

maxLength: 500

Oletus: ""

Lisäkentät: Ei

Kirjatut palautustiedot

RefundData · Skeema · Tietoskeemat: Palautukset, reklamaatiot ja vaihdot

amountMoneyData nullPakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

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

completed_atMerkkijono nullPakollinen

Valmistumisajankohta.

Merkkijono:format: "date-time"

Esimerkki: null

statusMerkkijonoPakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

Rajoitukset

enum: ["pending", "completed"]

Esimerkki: "pending"

updated_atMerkkijono nullPakollinen

Viimeisimmän päivityksen ajankohta.

Merkkijono:format: "date-time"

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

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Hae — Palautukset, reklamaatiot ja vaihdot — Vastaus

RequestDetailData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"

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

customerRequestCustomerData Pakollinen

Tälle resurssille kirjatut asiakastiedot.

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

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (RequestDetailData).

Esimerkki: "example"

itemsTaulukko <RequestItemData > Pakollinen

Resurssiin sisältyvät kohteet.

Esimerkki:

[{"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"}]}]

numberMerkkijonoPakollinen

Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "example"

order_idMerkkijonoPakollinen

Liittyvän tilauksen tunniste.

Esimerkki: "example"

order_numberMerkkijonoPakollinen

Liittyvän tilauksen numero.

Esimerkki: "example"

products_valueMoneyData Pakollinen

Tilauksen tuotteiden arvo.

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

refundRefundData Pakollinen

Kirjatut palautustiedot.

Esimerkki:

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

resolution_stateMerkkijonoPakollinen

Asiakastapauksen käsittelytila.

Rajoitukset

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

Esimerkki: "unknown"

statusRequestStatusData Pakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

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

typeRequestType Pakollinen

Resurssin tyyppi.

Esimerkki: "return"

updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"

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

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Hae — Palautukset, reklamaatiot ja vaihdot — Vastaus

RequestItemData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (RequestItemData).

Esimerkki: "example"
nameMerkkijonoPakollinen: Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"
order_line_idMerkkijono nullPakollinen: Liittyvän tilausrivin tunniste.

Esimerkki: "example"
product_idMerkkijonoPakollinen: Tuotteen tunniste.

Esimerkki: "example"
quantityKokonaislukuPakollinen: Yksiköiden määrä.

Esimerkki: 1
returned_quantityKokonaislukuPakollinen: Tältä riviltä palautettu määrä.

Esimerkki: 1
skuMerkkijonoPakollinen: Varastonimikkeen SKU-koodi.

Esimerkki: "example"
totalMoneyData Pakollinen: Kokonaissumma.

Esimerkki: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Pakollinen: Yhden yksikön hinta.

Esimerkki: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idMerkkijono nullPakollinen: Tuotevariantin tunniste.

Esimerkki: "example"
variant_optionsTaulukko <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Pakollinen: Tuotteeseen tai tilannekuvaan liittyvät varianttivalinnat.

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

Lisäkentät: Ei

Tämän nimenomaisen toiminnon hyväksymä tila

RequestStatusData · Skeema · Tietoskeemat: Palautukset, reklamaatiot ja vaihdot

idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (RequestStatusData).

Esimerkki: "example"
localeMerkkijonoPakollinen: Tälle pyynnölle valittu kieli.

Esimerkki: "en"
nameMerkkijono nullPakollinen: Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"

Lisäkentät: Ei

Listaa · Tilat — Palautukset, reklamaatiot ja vaihdot — Vastaus

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

codeMerkkijonoPakollinen: Vakaa koneellisesti luettava koodi.

Esimerkki: "example"
created_atMerkkijonoPakollinen: Luontiajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Esimerkki: "example"
is_initialTotuusarvoPakollinen: Onko tämä alkutila.

Esimerkki: false
localeMerkkijonoPakollinen: Tälle pyynnölle valittu kieli.

Esimerkki: "en"
nameMerkkijono nullPakollinen: Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"
positionKokonaislukuPakollinen: Sijainti järjestetyssä kokoelmassa.

Esimerkki: 1
typeRequestType Pakollinen: Resurssin tyyppi.

Esimerkki: "return"

Lisäkentät: Ei

Listaa · Tilat — Palautukset, reklamaatiot ja vaihdot — Vastaus

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataTaulukko <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Pakollinen: Vastausesimerkki · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Esimerkki: [{"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 Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Päivitä · Tila — Palautukset, reklamaatiot ja vaihdot — Pyynnön sisältö

RequestStatusUpdate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

expected_versionKokonaislukuPakollinen

Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

status_idMerkkijonoPakollinen

Asianmukaisesta tilaluettelosta saatu tunniste.

Rajoitukset

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

Esimerkki: "example"

Lisäkentät: Ei

Listaa — Palautukset, reklamaatiot ja vaihdot — Vastaus

RequestSummaryData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"

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

customerRequestCustomerData Pakollinen

Tälle resurssille kirjatut asiakastiedot.

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

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (RequestSummaryData).

Esimerkki: "example"

numberMerkkijonoPakollinen

Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "example"

order_idMerkkijonoPakollinen

Liittyvän tilauksen tunniste.

Esimerkki: "example"

order_numberMerkkijonoPakollinen

Liittyvän tilauksen numero.

Esimerkki: "example"

products_valueMoneyData Pakollinen

Tilauksen tuotteiden arvo.

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

refundRefundData Pakollinen

Kirjatut palautustiedot.

Esimerkki:

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

resolution_stateMerkkijonoPakollinen

Asiakastapauksen käsittelytila.

Rajoitukset

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

Esimerkki: "unknown"

statusRequestStatusData Pakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

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

typeRequestType Pakollinen

Resurssin tyyppi.

Esimerkki: "return"

updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"

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

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Resurssin tyyppi

RequestType · Skeema · Tietoskeemat: Palautukset, reklamaatiot ja vaihdot

Merkkijono

Rajoitukset

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

Lisäkentät: Kyllä

Tuotteeseen tai tilannekuvaan liittyvät varianttivalinnat

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Skeema · Tietoskeemat: Palautukset, reklamaatiot ja vaihdot

nameMerkkijonoPakollinen: Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"
valueMerkkijonoPakollinen: Ympäröivän skeeman kuvaama arvo.

Esimerkki: "example"

Lisäkentät: Ei