Adatsémák: Visszaküldések, reklamációk és cserék

Adatsémák: Visszaküldések, reklamációk és cserék. Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

Adatsémák

Listázás — Visszaküldések, reklamációk és cserék — Válasz

ApiResponse_list_RequestSummaryData__ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

dataTömb <RequestSummaryData > Kötelező: Példaválasz · ApiResponse_list_RequestSummaryData__.

Példa: [{"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 Kötelező: A válasz metaadatai.

Példa: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

További mezők: Nem

Lekérés — Visszaküldések, reklamációk és cserék — Válasz

ApiResponse_RequestDetailData_ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

dataRequestDetailData Kötelező: Példaválasz · RequestDetailData.

Példa: {"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 Kötelező: A válasz metaadatai.

Példa: {"request_id":"example"}

További mezők: Nem

Módosítás · Visszatérítés összege — Visszaküldések, reklamációk és cserék — Kérés törzse

RefundAmountUpdate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

amountKarakterláncKötelező

JSON-karakterláncként kódolt tizedes összeg; null csak ott, ahol engedélyezett.

minLength: 1maxLength: 64

Korlátozások

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

Példa: "0.00"

expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 0maximum: 9223372036854775807

Példa: 1

reasonKarakterláncNem kötelező

A módosításhoz rögzített indok.

maxLength: 500

Alapértelmezett: ""

További mezők: Nem

A rögzített visszatérítési adatok

RefundData · Séma · Adatsémák: Visszaküldések, reklamációk és cserék

amountMoneyData nullKötelező

JSON-karakterláncként kódolt tizedes összeg; null csak ott, ahol engedélyezett.

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}

completed_atKarakterlánc nullKötelező

A befejezés időpontja.

Karakterlánc:format: "date-time"

Példa: null

statusKarakterláncKötelező

Az adott művelet által elfogadott állapot.

Korlátozások

enum: ["pending", "completed"]

Példa: "pending"

updated_atKarakterlánc nullKötelező

A legutóbbi módosítás időpontja.

Karakterlánc:format: "date-time"

Példa: "2026-01-01T12:00:00Z"

versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem

Lekérés — Visszaküldések, reklamációk és cserék — Válasz

RequestDetailData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

customerRequestCustomerData Kötelező

Az erőforráshoz rögzített ügyféladatok.

Példa: {"email":"customer@example.invalid","name":"Example"}

idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (RequestDetailData).

Példa: "example"

itemsTömb <RequestItemData > Kötelező

Az erőforrásban szereplő tételek.

Példa:

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

numberKarakterláncKötelező

A rendelés vagy bejelentés felhasználóknak szánt száma.

Példa: "example"

order_idKarakterláncKötelező

A kapcsolódó rendelés azonosítója.

Példa: "example"

order_numberKarakterláncKötelező

A kapcsolódó rendelés száma.

Példa: "example"

products_valueMoneyData Kötelező

A rendelésben szereplő termékek értéke.

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Kötelező

A rögzített visszatérítési adatok.

Példa:

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

resolution_stateKarakterláncKötelező

Az ügyfélbejelentés megoldási állapota.

Korlátozások

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

Példa: "unknown"

statusRequestStatusData Kötelező

Az adott művelet által elfogadott állapot.

Példa: {"id":"example","locale":"en","name":"Example"}

typeRequestType Kötelező

Erőforrástípus.

Példa: "return"

updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem

Lekérés — Visszaküldések, reklamációk és cserék — Válasz

RequestItemData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

idKarakterláncKötelező: Erőforrás-azonosító; a visszaadott alakban őrizze meg. (RequestItemData).

Példa: "example"
nameKarakterláncKötelező: Az erőforrás neve az adott környezetben.

Példa: "Example"
order_line_idKarakterlánc nullKötelező: A kapcsolódó rendelési tétel azonosítója.

Példa: "example"
product_idKarakterláncKötelező: Termékazonosító.

Példa: "example"
quantityEgész számKötelező: Egységek száma.

Példa: 1
returned_quantityEgész számKötelező: Az adott tételből visszaküldött mennyiség.

Példa: 1
skuKarakterláncKötelező: Készletnyilvántartási cikkszám.

Példa: "example"
totalMoneyData Kötelező: Teljes összeg.

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Kötelező: Egy egység ára.

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idKarakterlánc nullKötelező: Termékvariáns-azonosító.

Példa: "example"
variant_optionsTömb <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Kötelező: A termékhez vagy pillanatfelvételhez kapcsolódó variánsopciók.

Példa: [{"name":"Example","value":"example"}]

További mezők: Nem

Az adott művelet által elfogadott állapot

RequestStatusData · Séma · Adatsémák: Visszaküldések, reklamációk és cserék

idKarakterláncKötelező: Erőforrás-azonosító; a visszaadott alakban őrizze meg. (RequestStatusData).

Példa: "example"
localeKarakterláncKötelező: A kéréshez kiválasztott nyelv.

Példa: "en"
nameKarakterlánc nullKötelező: Az erőforrás neve az adott környezetben.

Példa: "Example"

További mezők: Nem

Listázás · Állapotok — Visszaküldések, reklamációk és cserék — Válasz

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

codeKarakterláncKötelező: Stabil, géppel feldolgozható kód.

Példa: "example"
created_atKarakterláncKötelező: A létrehozás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"
idKarakterláncKötelező: Erőforrás-azonosító; a visszaadott alakban őrizze meg. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Példa: "example"
is_initialLogikai értékKötelező: Jelzi, hogy ez a kezdeti állapot-e.

Példa: false
localeKarakterláncKötelező: A kéréshez kiválasztott nyelv.

Példa: "en"
nameKarakterlánc nullKötelező: Az erőforrás neve az adott környezetben.

Példa: "Example"
positionEgész számKötelező: Pozíció a rendezett gyűjteményben.

Példa: 1
typeRequestType Kötelező: Erőforrástípus.

Példa: "return"

További mezők: Nem

Listázás · Állapotok — Visszaküldések, reklamációk és cserék — Válasz

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

dataTömb <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Kötelező: Példaválasz · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Példa: [{"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 Kötelező: A válasz metaadatai.

Példa: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

További mezők: Nem

Módosítás · Állapot — Visszaküldések, reklamációk és cserék — Kérés törzse

RequestStatusUpdate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1maximum: 9223372036854775807

Példa: 1

status_idKarakterláncKötelező

A megfelelő állapotszótárból kapott azonosító.

Korlátozások

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

Példa: "example"

További mezők: Nem

Listázás — Visszaküldések, reklamációk és cserék — Válasz

RequestSummaryData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

customerRequestCustomerData Kötelező

Az erőforráshoz rögzített ügyféladatok.

Példa: {"email":"customer@example.invalid","name":"Example"}

idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (RequestSummaryData).

Példa: "example"

numberKarakterláncKötelező

A rendelés vagy bejelentés felhasználóknak szánt száma.

Példa: "example"

order_idKarakterláncKötelező

A kapcsolódó rendelés azonosítója.

Példa: "example"

order_numberKarakterláncKötelező

A kapcsolódó rendelés száma.

Példa: "example"

products_valueMoneyData Kötelező

A rendelésben szereplő termékek értéke.

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Kötelező

A rögzített visszatérítési adatok.

Példa:

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

resolution_stateKarakterláncKötelező

Az ügyfélbejelentés megoldási állapota.

Korlátozások

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

Példa: "unknown"

statusRequestStatusData Kötelező

Az adott művelet által elfogadott állapot.

Példa: {"id":"example","locale":"en","name":"Example"}

typeRequestType Kötelező

Erőforrástípus.

Példa: "return"

updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem

Erőforrástípus

RequestType · Séma · Adatsémák: Visszaküldések, reklamációk és cserék

Karakterlánc

Korlátozások

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

További mezők: Igen

A termékhez vagy pillanatfelvételhez kapcsolódó variánsopciók

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Séma · Adatsémák: Visszaküldések, reklamációk és cserék

nameKarakterláncKötelező: Az erőforrás neve az adott környezetben.

Példa: "Example"
valueKarakterláncKötelező: A környező séma által leírt érték.

Példa: "example"

További mezők: Nem