Pređi na sadržaj
ShopentlyLearn

Šeme podataka: Povrati, reklamacije i zamene

Šeme podataka: Povrati, reklamacije i zamene. Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.

Šeme podataka

Prikaži listu — Povrati, reklamacije i zamene — Odgovor

ApiResponse_list_RequestSummaryData__ · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
dataNiz vrednosti <RequestSummaryData > Obavezno

Primer odgovora · ApiResponse_list_RequestSummaryData__.

Primer: [{"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 Obavezno

Metapodaci odgovora.

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

Dodatna polja: Ne

Preuzmi — Povrati, reklamacije i zamene — Odgovor

ApiResponse_RequestDetailData_ · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
dataRequestDetailData Obavezno

Primer odgovora · RequestDetailData.

Primer: {"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 Obavezno

Metapodaci odgovora.

Primer: {"request_id":"example"}

Dodatna polja: Ne

Ažuriraj · Iznos povraćaja — Povrati, reklamacije i zamene — Telo zahteva

RefundAmountUpdate · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
amountNiz znakovaObavezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gde je dozvoljen.

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

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

minimum: 0maximum: 9223372036854775807
Primer: 1
reasonNiz znakovaOpciono

Razlog zabeležen za promenu.

maxLength: 500
Podrazumevano: ""

Dodatna polja: Ne

Zabeleženi podaci o povratu novca

RefundData · Šema · Šeme podataka: Povrati, reklamacije i zamene
amountMoneyData nullObavezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gde je dozvoljen.

Primer: {"amount":"0.00","currency":"PLN","minor_units":2}
completed_atNiz znakova nullObavezno

Vreme završetka.

Niz znakova:format: "date-time"
Primer: null
statusNiz znakovaObavezno

Status prihvaćen za ovu određenu operaciju.

Ograničenja
enum
["pending", "completed"]
Primer: "pending"
updated_atNiz znakova nullObavezno

Vreme poslednjeg ažuriranja.

Niz znakova:format: "date-time"
Primer: "2026-01-01T12:00:00Z"
versionCeli brojObavezno

Verzija resursa za kontrolu istovremenih upisa.

Primer: 1

Dodatna polja: Ne

Preuzmi — Povrati, reklamacije i zamene — Odgovor

RequestDetailData · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
created_atNiz znakovaObavezno

Vreme kreiranja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
customerRequestCustomerData Obavezno

Podaci kupca zabeleženi za ovaj resurs.

Primer: {"email":"customer@example.invalid","name":"Example"}
idNiz znakovaObavezno

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

Primer: "example"
itemsNiz vrednosti <RequestItemData > Obavezno

Stavke uključene u resurs.

Primer: [{"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 znakovaObavezno

Broj porudžbine ili zahteva namenjen korisniku.

Primer: "example"
order_idNiz znakovaObavezno

Identifikator povezane porudžbine.

Primer: "example"
order_numberNiz znakovaObavezno

Broj povezane porudžbine.

Primer: "example"
products_valueMoneyData Obavezno

Vrednost proizvoda u porudžbini.

Primer: {"amount":"0.00","currency":"PLN","minor_units":2}
refundRefundData Obavezno

Zabeleženi podaci o povratu novca.

Primer: {"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 znakovaObavezno

Stanje rešavanja zahteva kupca.

Ograničenja
enum
["unknown", "open", "completed", "rejected", "cancelled"]
Primer: "unknown"
statusRequestStatusData Obavezno

Status prihvaćen za ovu određenu operaciju.

Primer: {"id":"example","locale":"en","name":"Example"}
typeRequestType Obavezno

Tip resursa.

Primer: "return"
updated_atNiz znakovaObavezno

Vreme poslednjeg ažuriranja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
versionCeli brojObavezno

Verzija resursa za kontrolu istovremenih upisa.

Primer: 1

Dodatna polja: Ne

Preuzmi — Povrati, reklamacije i zamene — Odgovor

RequestItemData · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
idNiz znakovaObavezno

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

Primer: "example"
nameNiz znakovaObavezno

Naziv resursa u odgovarajućem kontekstu.

Primer: "Example"
order_line_idNiz znakova nullObavezno

Identifikator povezane stavke porudžbine.

Primer: "example"
product_idNiz znakovaObavezno

Identifikator proizvoda.

Primer: "example"
quantityCeli brojObavezno

Broj jedinica.

Primer: 1
returned_quantityCeli brojObavezno

Vraćena količina ove stavke.

Primer: 1
skuNiz znakovaObavezno

Šifra skladišne jedinice.

Primer: "example"
totalMoneyData Obavezno

Ukupan iznos.

Primer: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obavezno

Cena jedne jedinice.

Primer: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idNiz znakova nullObavezno

Identifikator varijante proizvoda.

Primer: "example"
variant_optionsNiz vrednosti <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obavezno

Opcije varijante povezane s proizvodom ili snimkom stanja.

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

Dodatna polja: Ne

Status prihvaćen za ovu određenu operaciju

RequestStatusData · Šema · Šeme podataka: Povrati, reklamacije i zamene
idNiz znakovaObavezno

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

Primer: "example"
localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

Primer: "en"
nameNiz znakova nullObavezno

Naziv resursa u odgovarajućem kontekstu.

Primer: "Example"

Dodatna polja: Ne

Prikaži listu · Statusi — Povrati, reklamacije i zamene — Odgovor

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
codeNiz znakovaObavezno

Stabilan mašinski čitljiv kod.

Primer: "example"
created_atNiz znakovaObavezno

Vreme kreiranja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
idNiz znakovaObavezno

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

Primer: "example"
is_initialLogička vrednostObavezno

Da li je ovo početni status.

Primer: false
localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

Primer: "en"
nameNiz znakova nullObavezno

Naziv resursa u odgovarajućem kontekstu.

Primer: "Example"
positionCeli brojObavezno

Položaj u uređenoj kolekciji.

Primer: 1
typeRequestType Obavezno

Tip resursa.

Primer: "return"

Dodatna polja: Ne

Prikaži listu · Statusi — Povrati, reklamacije i zamene — Odgovor

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
dataNiz vrednosti <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obavezno

Primer odgovora · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Primer: [{"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 Obavezno

Metapodaci odgovora.

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

Dodatna polja: Ne

Ažuriraj · Status — Povrati, reklamacije i zamene — Telo zahteva

RequestStatusUpdate · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
expected_versionCeli brojObavezno

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

minimum: 1maximum: 9223372036854775807
Primer: 1
status_idNiz znakovaObavezno

Identifikator dobijen iz odgovarajućeg šifrarnika statusa.

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

Dodatna polja: Ne

Prikaži listu — Povrati, reklamacije i zamene — Odgovor

RequestSummaryData · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
created_atNiz znakovaObavezno

Vreme kreiranja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
customerRequestCustomerData Obavezno

Podaci kupca zabeleženi za ovaj resurs.

Primer: {"email":"customer@example.invalid","name":"Example"}
idNiz znakovaObavezno

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

Primer: "example"
numberNiz znakovaObavezno

Broj porudžbine ili zahteva namenjen korisniku.

Primer: "example"
order_idNiz znakovaObavezno

Identifikator povezane porudžbine.

Primer: "example"
order_numberNiz znakovaObavezno

Broj povezane porudžbine.

Primer: "example"
products_valueMoneyData Obavezno

Vrednost proizvoda u porudžbini.

Primer: {"amount":"0.00","currency":"PLN","minor_units":2}
refundRefundData Obavezno

Zabeleženi podaci o povratu novca.

Primer: {"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 znakovaObavezno

Stanje rešavanja zahteva kupca.

Ograničenja
enum
["unknown", "open", "completed", "rejected", "cancelled"]
Primer: "unknown"
statusRequestStatusData Obavezno

Status prihvaćen za ovu određenu operaciju.

Primer: {"id":"example","locale":"en","name":"Example"}
typeRequestType Obavezno

Tip resursa.

Primer: "return"
updated_atNiz znakovaObavezno

Vreme poslednjeg ažuriranja.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
versionCeli brojObavezno

Verzija resursa za kontrolu istovremenih upisa.

Primer: 1

Dodatna polja: Ne

Tip resursa

RequestType · Šema · Šeme podataka: Povrati, reklamacije i zamene
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 · Šema · Šeme podataka: Povrati, reklamacije i zamene
nameNiz znakovaObavezno

Naziv resursa u odgovarajućem kontekstu.

Primer: "Example"
valueNiz znakovaObavezno

Vrednost opisana okolnom šemom.

Primer: "example"

Dodatna polja: Ne