Datová schémata: Vrácení, reklamace a výměny

Datová schémata: Vrácení, reklamace a výměny. Pole, typy a omezení dat přijímaných nebo vracených API.

Datová schémata

Vypsat — Vrácení, reklamace a výměny — Odpověď

ApiResponse_list_RequestSummaryData__ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataPole <RequestSummaryData > Povinné: Příklad odpovědi · ApiResponse_list_RequestSummaryData__.

Pří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é: Metadata odpovědi.

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

Další pole: Ne

Načíst — Vrácení, reklamace a výměny — Odpověď

ApiResponse_RequestDetailData_ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataRequestDetailData Povinné: Příklad odpovědi · RequestDetailData.

Pří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é: Metadata odpovědi.

Příklad: {"request_id":"example"}

Další pole: Ne

Upravit · Vrácená částka — Vrácení, reklamace a výměny — Tělo požadavku

RefundAmountUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.

amountŘetězecPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

minLength: 1maxLength: 64

Omezení

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

Příklad: "0.00"

expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 0maximum: 9223372036854775807

Příklad: 1

reasonŘetězecVolitelné

Důvod zaznamenaný u změny.

maxLength: 500

Výchozí hodnota: ""

Další pole: Ne

Evidované informace o vrácení peněz

RefundData · Schéma · Datová schémata: Vrácení, reklamace a výměny

amountMoneyData nullPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

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

completed_atŘetězec nullPovinné

Čas dokončení.

Řetězec:format: "date-time"

Příklad: null

statusŘetězecPovinné

Stav přijímaný touto konkrétní operací.

Omezení

enum: ["pending", "completed"]

Příklad: "pending"

updated_atŘetězec nullPovinné

Čas poslední aktualizace.

Řetězec:format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Načíst — Vrácení, reklamace a výměny — Odpověď

RequestDetailData · Pole, typy a omezení dat přijímaných nebo vracených API.

created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

customerRequestCustomerData Povinné

Údaje zákazníka zaznamenané u tohoto zdroje.

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

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (RequestDetailData).

Příklad: "example"

itemsPole <RequestItemData > Povinné

Položky zahrnuté ve zdroji.

Pří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"}]}]

numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

Příklad: "example"

order_idŘetězecPovinné

Identifikátor související objednávky.

Příklad: "example"

order_numberŘetězecPovinné

Číslo související objednávky.

Příklad: "example"

products_valueMoneyData Povinné

Hodnota produktů v objednávce.

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

refundRefundData Povinné

Evidované informace o vrácení peněz.

Pří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_stateŘetězecPovinné

Stav vyřízení zákaznického požadavku.

Omezení

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

Příklad: "unknown"

statusRequestStatusData Povinné

Stav přijímaný touto konkrétní operací.

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

typeRequestType Povinné

Typ zdroje.

Příklad: "return"

updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Načíst — Vrácení, reklamace a výměny — Odpověď

RequestItemData · Pole, typy a omezení dat přijímaných nebo vracených API.

idŘetězecPovinné: Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (RequestItemData).

Příklad: "example"
nameŘetězecPovinné: Název zdroje v příslušném kontextu.

Příklad: "Example"
order_line_idŘetězec nullPovinné: Identifikátor související položky objednávky.

Příklad: "example"
product_idŘetězecPovinné: Identifikátor produktu.

Příklad: "example"
quantityCelé čísloPovinné: Počet jednotek.

Příklad: 1
returned_quantityCelé čísloPovinné: Vrácené množství této položky.

Příklad: 1
skuŘetězecPovinné: Skladový kód položky.

Příklad: "example"
totalMoneyData Povinné: Celková částka.

Příklad: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Povinné: Cena jedné jednotky.

Příklad: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idŘetězec nullPovinné: Identifikátor varianty produktu.

Příklad: "example"
variant_optionsPole <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Povinné: Možnosti variant přiřazené produktu nebo uloženému záznamu.

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

Další pole: Ne

Stav přijímaný touto konkrétní operací

RequestStatusData · Schéma · Datová schémata: Vrácení, reklamace a výměny

idŘetězecPovinné: Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (RequestStatusData).

Příklad: "example"
localeŘetězecPovinné: Jazyk vybraný pro tento požadavek.

Příklad: "en"
nameŘetězec nullPovinné: Název zdroje v příslušném kontextu.

Příklad: "Example"

Další pole: Ne

Vypsat · Stavy — Vrácení, reklamace a výměny — Odpověď

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Pole, typy a omezení dat přijímaných nebo vracených API.

codeŘetězecPovinné: Stabilní strojově čitelný kód.

Příklad: "example"
created_atŘetězecPovinné: Čas vytvoření.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"
idŘetězecPovinné: Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Příklad: "example"
is_initialLogická hodnotaPovinné: Zda jde o počáteční stav.

Příklad: false
localeŘetězecPovinné: Jazyk vybraný pro tento požadavek.

Příklad: "en"
nameŘetězec nullPovinné: Název zdroje v příslušném kontextu.

Příklad: "Example"
positionCelé čísloPovinné: Pozice v seřazeném seznamu.

Příklad: 1
typeRequestType Povinné: Typ zdroje.

Příklad: "return"

Další pole: Ne

Vypsat · Stavy — Vrácení, reklamace a výměny — Odpověď

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Pole, typy a omezení dat přijímaných nebo vracených API.

dataPole <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Povinné: Příklad odpovědi · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Pří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é: Metadata odpovědi.

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

Další pole: Ne

Upravit · Stav — Vrácení, reklamace a výměny — Tělo požadavku

RequestStatusUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.

expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807

Příklad: 1

status_idŘetězecPovinné

Identifikátor získaný z příslušného číselníku stavů.

Omezení

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

Příklad: "example"

Další pole: Ne

Vypsat — Vrácení, reklamace a výměny — Odpověď

RequestSummaryData · Pole, typy a omezení dat přijímaných nebo vracených API.

created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

customerRequestCustomerData Povinné

Údaje zákazníka zaznamenané u tohoto zdroje.

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

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (RequestSummaryData).

Příklad: "example"

numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

Příklad: "example"

order_idŘetězecPovinné

Identifikátor související objednávky.

Příklad: "example"

order_numberŘetězecPovinné

Číslo související objednávky.

Příklad: "example"

products_valueMoneyData Povinné

Hodnota produktů v objednávce.

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

refundRefundData Povinné

Evidované informace o vrácení peněz.

Pří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_stateŘetězecPovinné

Stav vyřízení zákaznického požadavku.

Omezení

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

Příklad: "unknown"

statusRequestStatusData Povinné

Stav přijímaný touto konkrétní operací.

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

typeRequestType Povinné

Typ zdroje.

Příklad: "return"

updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Typ zdroje

RequestType · Schéma · Datová schémata: Vrácení, reklamace a výměny

Řetězec

Omezení

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

Další pole: Ano

Možnosti variant přiřazené produktu nebo uloženému záznamu

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Schéma · Datová schémata: Vrácení, reklamace a výměny

nameŘetězecPovinné: Název zdroje v příslušném kontextu.

Příklad: "Example"
valueŘetězecPovinné: Hodnota popsaná okolním schématem.

Příklad: "example"

Další pole: Ne