Preskoči na sadržaj
ShopentlyLearn

Sheme podataka: Povrati, reklamacije i zamjene

Sheme podataka: Povrati, reklamacije i zamjene. Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

Sheme podataka

Popis — Povrati, reklamacije i zamjene — Odgovor

ApiResponse_list_RequestSummaryData__ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
dataPolje vrijednosti <RequestSummaryData > Obvezno

Primjer odgovora · ApiResponse_list_RequestSummaryData__.

Primjer: [{"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 Obvezno

Metapodaci odgovora.

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

Dodatna polja: Ne

Dohvati — Povrati, reklamacije i zamjene — Odgovor

ApiResponse_RequestDetailData_ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
dataRequestDetailData Obvezno

Primjer odgovora · RequestDetailData.

Primjer: {"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 Obvezno

Metapodaci odgovora.

Primjer: {"request_id":"example"}

Dodatna polja: Ne

Ažuriraj · Iznos povrata — Povrati, reklamacije i zamjene — Tijelo zahtjeva

RefundAmountUpdate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
amountNiz znakovaObvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

minLength: 1maxLength: 64
Ograničenja
pattern
"^[+-]?(?:[0-9]+(?:\\.[0-9]+)?|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?$"
Primjer: "0.00"
expected_versionCijeli brojObvezno

Verzija pročitana prije upisa; nepodudaranje odbija ažuriranje.

minimum: 0maximum: 9223372036854775807
Primjer: 1
reasonNiz znakovaNeobavezno

Razlog zabilježen za promjenu.

maxLength: 500
Zadano: ""

Dodatna polja: Ne

Zabilježeni podaci o povratu novca

RefundData · Shema · Sheme podataka: Povrati, reklamacije i zamjene
amountMoneyData nullObvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

Primjer: {"amount":"0.00","currency":"PLN","minor_units":2}
completed_atNiz znakova nullObvezno

Vrijeme dovršetka.

Niz znakova:format: "date-time"
Primjer: null
statusNiz znakovaObvezno

Status prihvaćen za ovu određenu operaciju.

Ograničenja
enum
["pending", "completed"]
Primjer: "pending"
updated_atNiz znakova nullObvezno

Vrijeme posljednjeg ažuriranja.

Niz znakova:format: "date-time"
Primjer: "2026-01-01T12:00:00Z"
versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

Primjer: 1

Dodatna polja: Ne

Dohvati — Povrati, reklamacije i zamjene — Odgovor

RequestDetailData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
created_atNiz znakovaObvezno

Vrijeme izrade.

format: "date-time"
Primjer: "2026-01-01T12:00:00Z"
customerRequestCustomerData Obvezno

Podaci kupca zabilježeni za ovaj resurs.

Primjer: {"email":"customer@example.invalid","name":"Example"}
idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (RequestDetailData).

Primjer: "example"
itemsPolje vrijednosti <RequestItemData > Obvezno

Stavke uključene u resurs.

Primjer: [{"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"}]}]
numberNiz znakovaObvezno

Broj narudžbe ili zahtjeva namijenjen korisniku.

Primjer: "example"
order_idNiz znakovaObvezno

Identifikator povezane narudžbe.

Primjer: "example"
order_numberNiz znakovaObvezno

Broj povezane narudžbe.

Primjer: "example"
products_valueMoneyData Obvezno

Vrijednost proizvoda u narudžbi.

Primjer: {"amount":"0.00","currency":"PLN","minor_units":2}
refundRefundData Obvezno

Zabilježeni podaci o povratu novca.

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

Stanje rješavanja zahtjeva kupca.

Ograničenja
enum
["unknown", "open", "completed", "rejected", "cancelled"]
Primjer: "unknown"
statusRequestStatusData Obvezno

Status prihvaćen za ovu određenu operaciju.

Primjer: {"id":"example","locale":"en","name":"Example"}
typeRequestType Obvezno

Tip resursa.

Primjer: "return"
updated_atNiz znakovaObvezno

Vrijeme posljednjeg ažuriranja.

format: "date-time"
Primjer: "2026-01-01T12:00:00Z"
versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

Primjer: 1

Dodatna polja: Ne

Dohvati — Povrati, reklamacije i zamjene — Odgovor

RequestItemData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (RequestItemData).

Primjer: "example"
nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Example"
order_line_idNiz znakova nullObvezno

Identifikator povezane stavke narudžbe.

Primjer: "example"
product_idNiz znakovaObvezno

Identifikator proizvoda.

Primjer: "example"
quantityCijeli brojObvezno

Broj jedinica.

Primjer: 1
returned_quantityCijeli brojObvezno

Vraćena količina ove stavke.

Primjer: 1
skuNiz znakovaObvezno

Šifra skladišne jedinice.

Primjer: "example"
totalMoneyData Obvezno

Ukupan iznos.

Primjer: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obvezno

Cijena jedne jedinice.

Primjer: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idNiz znakova nullObvezno

Identifikator varijante proizvoda.

Primjer: "example"
variant_optionsPolje vrijednosti <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obvezno

Opcije varijante povezane s proizvodom ili snimkom stanja.

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

Dodatna polja: Ne

Status prihvaćen za ovu određenu operaciju

RequestStatusData · Shema · Sheme podataka: Povrati, reklamacije i zamjene
idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (RequestStatusData).

Primjer: "example"
localeNiz znakovaObvezno

Jezik odabran za ovaj zahtjev.

Primjer: "en"
nameNiz znakova nullObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Example"

Dodatna polja: Ne

Popis · Statusi — Povrati, reklamacije i zamjene — Odgovor

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
codeNiz znakovaObvezno

Stabilan strojno čitljiv kod.

Primjer: "example"
created_atNiz znakovaObvezno

Vrijeme izrade.

format: "date-time"
Primjer: "2026-01-01T12:00:00Z"
idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Primjer: "example"
is_initialLogička vrijednostObvezno

Je li ovo početni status.

Primjer: false
localeNiz znakovaObvezno

Jezik odabran za ovaj zahtjev.

Primjer: "en"
nameNiz znakova nullObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Example"
positionCijeli brojObvezno

Položaj u uređenoj zbirci.

Primjer: 1
typeRequestType Obvezno

Tip resursa.

Primjer: "return"

Dodatna polja: Ne

Popis · Statusi — Povrati, reklamacije i zamjene — Odgovor

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
dataPolje vrijednosti <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obvezno

Primjer odgovora · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Primjer: [{"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 Obvezno

Metapodaci odgovora.

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

Dodatna polja: Ne

Ažuriraj · Status — Povrati, reklamacije i zamjene — Tijelo zahtjeva

RequestStatusUpdate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
expected_versionCijeli brojObvezno

Verzija pročitana prije upisa; nepodudaranje odbija ažuriranje.

minimum: 1maximum: 9223372036854775807
Primjer: 1
status_idNiz znakovaObvezno

Identifikator dobiven iz odgovarajućeg šifrarnika statusa.

Ograničenja
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primjer: "example"

Dodatna polja: Ne

Popis — Povrati, reklamacije i zamjene — Odgovor

RequestSummaryData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
created_atNiz znakovaObvezno

Vrijeme izrade.

format: "date-time"
Primjer: "2026-01-01T12:00:00Z"
customerRequestCustomerData Obvezno

Podaci kupca zabilježeni za ovaj resurs.

Primjer: {"email":"customer@example.invalid","name":"Example"}
idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (RequestSummaryData).

Primjer: "example"
numberNiz znakovaObvezno

Broj narudžbe ili zahtjeva namijenjen korisniku.

Primjer: "example"
order_idNiz znakovaObvezno

Identifikator povezane narudžbe.

Primjer: "example"
order_numberNiz znakovaObvezno

Broj povezane narudžbe.

Primjer: "example"
products_valueMoneyData Obvezno

Vrijednost proizvoda u narudžbi.

Primjer: {"amount":"0.00","currency":"PLN","minor_units":2}
refundRefundData Obvezno

Zabilježeni podaci o povratu novca.

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

Stanje rješavanja zahtjeva kupca.

Ograničenja
enum
["unknown", "open", "completed", "rejected", "cancelled"]
Primjer: "unknown"
statusRequestStatusData Obvezno

Status prihvaćen za ovu određenu operaciju.

Primjer: {"id":"example","locale":"en","name":"Example"}
typeRequestType Obvezno

Tip resursa.

Primjer: "return"
updated_atNiz znakovaObvezno

Vrijeme posljednjeg ažuriranja.

format: "date-time"
Primjer: "2026-01-01T12:00:00Z"
versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

Primjer: 1

Dodatna polja: Ne

Tip resursa

RequestType · Shema · Sheme podataka: Povrati, reklamacije i zamjene
Niz znakova
Ograničenja
enum
["return", "exchange", "complaint"]

Dodatna polja: Da

Opcije varijante povezane s proizvodom ili snimkom stanja

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Shema · Sheme podataka: Povrati, reklamacije i zamjene
nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Example"
valueNiz znakovaObvezno

Vrijednost opisana okolnom shemom.

Primjer: "example"

Dodatna polja: Ne