Podatkovne sheme: Vračila, reklamacije in zamenjave

Podatkovne sheme: Vračila, reklamacije in zamenjave. Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

Podatkovne sheme

Prikaži seznam — Vračila, reklamacije in zamenjave — Odgovor

ApiResponse_list_RequestSummaryData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

dataPolje elementov <RequestSummaryData > Obvezno: 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 Obvezno: Metapodatki odgovora.

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

Dodatna polja: Ne

Pridobi — Vračila, reklamacije in zamenjave — Odgovor

ApiResponse_RequestDetailData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

dataRequestDetailData Obvezno: 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 Obvezno: Metapodatki odgovora.

Primer: {"request_id":"example"}

Dodatna polja: Ne

Posodobi · Znesek vračila — Vračila, reklamacije in zamenjave — Telo zahteve

RefundAmountUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

amountNizObvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

minLength: 1maxLength: 64

Omejitve

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

Primer: "0.00"

expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 0maximum: 9223372036854775807

Primer: 1

reasonNizIzbirno

Zabeleženi razlog spremembe.

maxLength: 500

Privzeto: ""

Dodatna polja: Ne

Zabeleženi podatki o vračilu

RefundData · Shema · Podatkovne sheme: Vračila, reklamacije in zamenjave

amountMoneyData nullObvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

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

completed_atNiz nullObvezno

Čas zaključka.

Niz:format: "date-time"

Primer: null

statusNizObvezno

Status, ki ga sprejema ta operacija.

Omejitve

enum: ["pending", "completed"]

Primer: "pending"

updated_atNiz nullObvezno

Čas zadnje posodobitve.

Niz:format: "date-time"

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

versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Pridobi — Vračila, reklamacije in zamenjave — Odgovor

RequestDetailData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

created_atNizObvezno

Čas nastanka.

format: "date-time"

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

customerRequestCustomerData Obvezno

Podatki stranke, zabeleženi za ta vir.

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

idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (RequestDetailData).

Primer: "example"

itemsPolje elementov <RequestItemData > Obvezno

Elementi, vključeni v vir.

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

numberNizObvezno

Uporabniku prikazana številka naročila ali zahtevka.

Primer: "example"

order_idNizObvezno

Identifikator povezanega naročila.

Primer: "example"

order_numberNizObvezno

Številka povezanega naročila.

Primer: "example"

products_valueMoneyData Obvezno

Vrednost izdelkov v naročilu.

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

refundRefundData Obvezno

Zabeleženi podatki o vračilu.

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_stateNizObvezno

Stanje reševanja zahtevka stranke.

Omejitve

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

Primer: "unknown"

statusRequestStatusData Obvezno

Status, ki ga sprejema ta operacija.

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

typeRequestType Obvezno

Vrsta vira.

Primer: "return"

updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"

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

versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Pridobi — Vračila, reklamacije in zamenjave — Odgovor

RequestItemData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

idNizObvezno: Identifikator vira; ohranite ga v vrnjeni obliki. (RequestItemData).

Primer: "example"
nameNizObvezno: Ime vira v ustreznem kontekstu.

Primer: "Example"
order_line_idNiz nullObvezno: Identifikator povezane postavke naročila.

Primer: "example"
product_idNizObvezno: Identifikator izdelka.

Primer: "example"
quantityCelo številoObvezno: Število enot.

Primer: 1
returned_quantityCelo številoObvezno: Vrnjena količina za to postavko.

Primer: 1
skuNizObvezno: Koda enote za vodenje zaloge.

Primer: "example"
totalMoneyData Obvezno: Skupni znesek.

Primer: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obvezno: Cena ene enote.

Primer: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idNiz nullObvezno: Identifikator različice izdelka.

Primer: "example"
variant_optionsPolje elementov <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obvezno: Možnosti različic, povezane z izdelkom ali posnetkom.

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

Dodatna polja: Ne

Status, ki ga sprejema ta operacija

RequestStatusData · Shema · Podatkovne sheme: Vračila, reklamacije in zamenjave

idNizObvezno: Identifikator vira; ohranite ga v vrnjeni obliki. (RequestStatusData).

Primer: "example"
localeNizObvezno: Jezik, izbran za to zahtevo.

Primer: "en"
nameNiz nullObvezno: Ime vira v ustreznem kontekstu.

Primer: "Example"

Dodatna polja: Ne

Prikaži seznam · Statusi — Vračila, reklamacije in zamenjave — Odgovor

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

codeNizObvezno: Stabilna strojno berljiva koda.

Primer: "example"
created_atNizObvezno: Čas nastanka.

format: "date-time"

Primer: "2026-01-01T12:00:00Z"
idNizObvezno: Identifikator vira; ohranite ga v vrnjeni obliki. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Primer: "example"
is_initialLogična vrednostObvezno: Ali je to začetni status.

Primer: false
localeNizObvezno: Jezik, izbran za to zahtevo.

Primer: "en"
nameNiz nullObvezno: Ime vira v ustreznem kontekstu.

Primer: "Example"
positionCelo številoObvezno: Položaj v urejeni zbirki.

Primer: 1
typeRequestType Obvezno: Vrsta vira.

Primer: "return"

Dodatna polja: Ne

Prikaži seznam · Statusi — Vračila, reklamacije in zamenjave — Odgovor

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

dataPolje elementov <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obvezno: 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 Obvezno: Metapodatki odgovora.

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

Dodatna polja: Ne

Posodobi · Status — Vračila, reklamacije in zamenjave — Telo zahteve

RequestStatusUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807

Primer: 1

status_idNizObvezno

Identifikator iz ustreznega slovarja statusov.

Omejitve

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

Primer: "example"

Dodatna polja: Ne

Prikaži seznam — Vračila, reklamacije in zamenjave — Odgovor

RequestSummaryData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

created_atNizObvezno

Čas nastanka.

format: "date-time"

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

customerRequestCustomerData Obvezno

Podatki stranke, zabeleženi za ta vir.

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

idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (RequestSummaryData).

Primer: "example"

numberNizObvezno

Uporabniku prikazana številka naročila ali zahtevka.

Primer: "example"

order_idNizObvezno

Identifikator povezanega naročila.

Primer: "example"

order_numberNizObvezno

Številka povezanega naročila.

Primer: "example"

products_valueMoneyData Obvezno

Vrednost izdelkov v naročilu.

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

refundRefundData Obvezno

Zabeleženi podatki o vračilu.

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_stateNizObvezno

Stanje reševanja zahtevka stranke.

Omejitve

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

Primer: "unknown"

statusRequestStatusData Obvezno

Status, ki ga sprejema ta operacija.

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

typeRequestType Obvezno

Vrsta vira.

Primer: "return"

updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"

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

versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Vrsta vira

RequestType · Shema · Podatkovne sheme: Vračila, reklamacije in zamenjave

Niz

Omejitve

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

Dodatna polja: Da

Možnosti različic, povezane z izdelkom ali posnetkom

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Shema · Podatkovne sheme: Vračila, reklamacije in zamenjave

nameNizObvezno: Ime vira v ustreznem kontekstu.

Primer: "Example"
valueNizObvezno: Vrednost, opisana z okoliško shemo.

Primer: "example"

Dodatna polja: Ne