Dátové schémy: Vrátenia, reklamácie a výmeny

Dátové schémy: Vrátenia, reklamácie a výmeny. Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Dátové schémy

Zobraziť zoznam — Vrátenia, reklamácie a výmeny — Odpoveď

ApiResponse_list_RequestSummaryData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataPole <RequestSummaryData > Povinné: Príklad odpovede · ApiResponse_list_RequestSummaryData__.

Príklad: [{"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 Povinné: Metaúdaje odpovede.

Príklad: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ďalšie polia: Nie

Načítať — Vrátenia, reklamácie a výmeny — Odpoveď

ApiResponse_RequestDetailData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataRequestDetailData Povinné: Príklad odpovede · RequestDetailData.

Príklad: {"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 Povinné: Metaúdaje odpovede.

Príklad: {"request_id":"example"}

Ďalšie polia: Nie

Upraviť · Suma vrátenia — Vrátenia, reklamácie a výmeny — Telo požiadavky

RefundAmountUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

amountReťazecPovinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

minLength: 1maxLength: 64

Obmedzenia

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

Príklad: "0.00"

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 0maximum: 9223372036854775807

Príklad: 1

reasonReťazecVoliteľné

Dôvod zaznamenaný pri zmene.

maxLength: 500

Predvolená hodnota: ""

Ďalšie polia: Nie

Evidované informácie o vrátení peňazí

RefundData · Schéma · Dátové schémy: Vrátenia, reklamácie a výmeny

amountMoneyData nullPovinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}

completed_atReťazec nullPovinné

Čas dokončenia.

Reťazec:format: "date-time"

Príklad: null

statusReťazecPovinné

Stav prijímaný touto konkrétnou operáciou.

Obmedzenia

enum: ["pending", "completed"]

Príklad: "pending"

updated_atReťazec nullPovinné

Čas poslednej aktualizácie.

Reťazec:format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Načítať — Vrátenia, reklamácie a výmeny — Odpoveď

RequestDetailData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

customerRequestCustomerData Povinné

Údaje zákazníka zaznamenané pri tomto zdroji.

Príklad: {"email":"customer@example.invalid","name":"Example"}

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (RequestDetailData).

Príklad: "example"

itemsPole <RequestItemData > Povinné

Položky zahrnuté v zdroji.

Príklad:

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

numberReťazecPovinné

Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

Príklad: "example"

order_idReťazecPovinné

Identifikátor súvisiacej objednávky.

Príklad: "example"

order_numberReťazecPovinné

Číslo súvisiacej objednávky.

Príklad: "example"

products_valueMoneyData Povinné

Hodnota produktov v objednávke.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Povinné

Evidované informácie o vrátení peňazí.

Príklad:

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

resolution_stateReťazecPovinné

Stav vybavenia zákazníckej žiadosti.

Obmedzenia

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

Príklad: "unknown"

statusRequestStatusData Povinné

Stav prijímaný touto konkrétnou operáciou.

Príklad: {"id":"example","locale":"en","name":"Example"}

typeRequestType Povinné

Typ zdroja.

Príklad: "return"

updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Načítať — Vrátenia, reklamácie a výmeny — Odpoveď

RequestItemData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

idReťazecPovinné: Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (RequestItemData).

Príklad: "example"
nameReťazecPovinné: Názov zdroja v príslušnom kontexte.

Príklad: "Example"
order_line_idReťazec nullPovinné: Identifikátor súvisiacej položky objednávky.

Príklad: "example"
product_idReťazecPovinné: Identifikátor produktu.

Príklad: "example"
quantityCelé čísloPovinné: Počet jednotiek.

Príklad: 1
returned_quantityCelé čísloPovinné: Vrátené množstvo tejto položky.

Príklad: 1
skuReťazecPovinné: Skladový kód položky.

Príklad: "example"
totalMoneyData Povinné: Celková suma.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Povinné: Cena jednej jednotky.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idReťazec nullPovinné: Identifikátor variantu produktu.

Príklad: "example"
variant_optionsPole <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Povinné: Možnosti variantov priradené produktu alebo uloženému záznamu.

Príklad: [{"name":"Example","value":"example"}]

Ďalšie polia: Nie

Stav prijímaný touto konkrétnou operáciou

RequestStatusData · Schéma · Dátové schémy: Vrátenia, reklamácie a výmeny

idReťazecPovinné: Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (RequestStatusData).

Príklad: "example"
localeReťazecPovinné: Jazyk vybraný pre túto požiadavku.

Príklad: "en"
nameReťazec nullPovinné: Názov zdroja v príslušnom kontexte.

Príklad: "Example"

Ďalšie polia: Nie

Zobraziť zoznam · Stavy — Vrátenia, reklamácie a výmeny — Odpoveď

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

codeReťazecPovinné: Stabilný strojovo čitateľný kód.

Príklad: "example"
created_atReťazecPovinné: Čas vytvorenia.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"
idReťazecPovinné: Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Príklad: "example"
is_initialLogická hodnotaPovinné: Či ide o počiatočný stav.

Príklad: false
localeReťazecPovinné: Jazyk vybraný pre túto požiadavku.

Príklad: "en"
nameReťazec nullPovinné: Názov zdroja v príslušnom kontexte.

Príklad: "Example"
positionCelé čísloPovinné: Pozícia v zoradenom zozname.

Príklad: 1
typeRequestType Povinné: Typ zdroja.

Príklad: "return"

Ďalšie polia: Nie

Zobraziť zoznam · Stavy — Vrátenia, reklamácie a výmeny — Odpoveď

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataPole <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Povinné: Príklad odpovede · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Príklad: [{"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 Povinné: Metaúdaje odpovede.

Príklad: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ďalšie polia: Nie

Upraviť · Stav — Vrátenia, reklamácie a výmeny — Telo požiadavky

RequestStatusUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807

Príklad: 1

status_idReťazecPovinné

Identifikátor získaný z príslušného číselníka stavov.

Obmedzenia

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

Príklad: "example"

Ďalšie polia: Nie

Zobraziť zoznam — Vrátenia, reklamácie a výmeny — Odpoveď

RequestSummaryData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

customerRequestCustomerData Povinné

Údaje zákazníka zaznamenané pri tomto zdroji.

Príklad: {"email":"customer@example.invalid","name":"Example"}

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (RequestSummaryData).

Príklad: "example"

numberReťazecPovinné

Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

Príklad: "example"

order_idReťazecPovinné

Identifikátor súvisiacej objednávky.

Príklad: "example"

order_numberReťazecPovinné

Číslo súvisiacej objednávky.

Príklad: "example"

products_valueMoneyData Povinné

Hodnota produktov v objednávke.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Povinné

Evidované informácie o vrátení peňazí.

Príklad:

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

resolution_stateReťazecPovinné

Stav vybavenia zákazníckej žiadosti.

Obmedzenia

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

Príklad: "unknown"

statusRequestStatusData Povinné

Stav prijímaný touto konkrétnou operáciou.

Príklad: {"id":"example","locale":"en","name":"Example"}

typeRequestType Povinné

Typ zdroja.

Príklad: "return"

updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Typ zdroja

RequestType · Schéma · Dátové schémy: Vrátenia, reklamácie a výmeny

Reťazec

Obmedzenia

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

Ďalšie polia: Áno

Možnosti variantov priradené produktu alebo uloženému záznamu

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Schéma · Dátové schémy: Vrátenia, reklamácie a výmeny

nameReťazecPovinné: Názov zdroja v príslušnom kontexte.

Príklad: "Example"
valueReťazecPovinné: Hodnota opísaná okolitou schémou.

Príklad: "example"

Ďalšie polia: Nie