Datenschemas: Rückgaben, Reklamationen und Umtausch

Datenschemas: Rückgaben, Reklamationen und Umtausch. Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

Datenschemas

Auflisten — Rückgaben, Reklamationen und Umtausch — Antwort

ApiResponse_list_RequestSummaryData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <RequestSummaryData > Erforderlich: Beispielantwort · ApiResponse_list_RequestSummaryData__.

Beispiel: [{"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Abrufen — Rückgaben, Reklamationen und Umtausch — Antwort

ApiResponse_RequestDetailData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataRequestDetailData Erforderlich: Beispielantwort · RequestDetailData.

Beispiel: {"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 Erforderlich: Metadaten der Antwort.

Beispiel: {"request_id":"example"}

Zusätzliche Felder: Nein

Aktualisieren · Erstattungsbetrag — Rückgaben, Reklamationen und Umtausch — Anfrageinhalt

RefundAmountUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

amountZeichenfolgeErforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

minLength: 1maxLength: 64

Einschränkungen

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

Beispiel: "0.00"

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 0maximum: 9223372036854775807

Beispiel: 1

reasonZeichenfolgeOptional

Für die Änderung gespeicherte Begründung.

maxLength: 500

Standardwert: ""

Zusätzliche Felder: Nein

Gespeicherte Erstattungsinformationen

RefundData · Schema · Datenschemas: Rückgaben, Reklamationen und Umtausch

amountMoneyData nullErforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

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

completed_atZeichenfolge nullErforderlich

Zeitpunkt des Abschlusses.

Zeichenfolge:format: "date-time"

Beispiel: null

statusZeichenfolgeErforderlich

Von dieser konkreten Operation akzeptierter Status.

Einschränkungen

enum: ["pending", "completed"]

Beispiel: "pending"

updated_atZeichenfolge nullErforderlich

Zeitpunkt der letzten Änderung.

Zeichenfolge:format: "date-time"

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

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Abrufen — Rückgaben, Reklamationen und Umtausch — Antwort

RequestDetailData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"

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

customerRequestCustomerData Erforderlich

Für diese Ressource gespeicherte Kundendaten.

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

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (RequestDetailData).

Beispiel: "example"

itemsArray <RequestItemData > Erforderlich

In der Ressource enthaltene Positionen.

Beispiel:

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

numberZeichenfolgeErforderlich

Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "example"

order_idZeichenfolgeErforderlich

Kennung der zugehörigen Bestellung.

Beispiel: "example"

order_numberZeichenfolgeErforderlich

Nummer der zugehörigen Bestellung.

Beispiel: "example"

products_valueMoneyData Erforderlich

Wert der Produkte in der Bestellung.

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

refundRefundData Erforderlich

Gespeicherte Erstattungsinformationen.

Beispiel:

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

resolution_stateZeichenfolgeErforderlich

Bearbeitungsstatus eines Kundenvorgangs.

Einschränkungen

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

Beispiel: "unknown"

statusRequestStatusData Erforderlich

Von dieser konkreten Operation akzeptierter Status.

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

typeRequestType Erforderlich

Ressourcentyp.

Beispiel: "return"

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

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

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Abrufen — Rückgaben, Reklamationen und Umtausch — Antwort

RequestItemData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen. (RequestItemData).

Beispiel: "example"
nameZeichenfolgeErforderlich: Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"
order_line_idZeichenfolge nullErforderlich: Kennung der zugehörigen Bestellposition.

Beispiel: "example"
product_idZeichenfolgeErforderlich: Produktkennung.

Beispiel: "example"
quantityGanzzahlErforderlich: Anzahl der Einheiten.

Beispiel: 1
returned_quantityGanzzahlErforderlich: Für diese Position zurückgegebene Menge.

Beispiel: 1
skuZeichenfolgeErforderlich: Artikelcode der Lagerhaltungseinheit.

Beispiel: "example"
totalMoneyData Erforderlich: Gesamtbetrag.

Beispiel: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Erforderlich: Preis pro Einheit.

Beispiel: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idZeichenfolge nullErforderlich: Kennung der Produktvariante.

Beispiel: "example"
variant_optionsArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Erforderlich: Dem Produkt oder der gespeicherten Position zugeordnete Variantenoptionen.

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

Zusätzliche Felder: Nein

Von dieser konkreten Operation akzeptierter Status

RequestStatusData · Schema · Datenschemas: Rückgaben, Reklamationen und Umtausch

idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen. (RequestStatusData).

Beispiel: "example"
localeZeichenfolgeErforderlich: Für diese Anfrage ausgewählte Sprache.

Beispiel: "en"
nameZeichenfolge nullErforderlich: Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"

Zusätzliche Felder: Nein

Auflisten · Statusliste — Rückgaben, Reklamationen und Umtausch — Antwort

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

codeZeichenfolgeErforderlich: Stabiler maschinenlesbarer Code.

Beispiel: "example"
created_atZeichenfolgeErforderlich: Zeitpunkt der Erstellung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"
idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Beispiel: "example"
is_initialBoolescher WertErforderlich: Gibt an, ob dies der Anfangsstatus ist.

Beispiel: false
localeZeichenfolgeErforderlich: Für diese Anfrage ausgewählte Sprache.

Beispiel: "en"
nameZeichenfolge nullErforderlich: Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"
positionGanzzahlErforderlich: Position in der geordneten Sammlung.

Beispiel: 1
typeRequestType Erforderlich: Ressourcentyp.

Beispiel: "return"

Zusätzliche Felder: Nein

Auflisten · Statusliste — Rückgaben, Reklamationen und Umtausch — Antwort

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Erforderlich: Beispielantwort · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Beispiel: [{"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Aktualisieren · Status — Rückgaben, Reklamationen und Umtausch — Anfrageinhalt

RequestStatusUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1

status_idZeichenfolgeErforderlich

Kennung aus dem entsprechenden Statusverzeichnis.

Einschränkungen

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

Beispiel: "example"

Zusätzliche Felder: Nein

Auflisten — Rückgaben, Reklamationen und Umtausch — Antwort

RequestSummaryData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"

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

customerRequestCustomerData Erforderlich

Für diese Ressource gespeicherte Kundendaten.

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

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (RequestSummaryData).

Beispiel: "example"

numberZeichenfolgeErforderlich

Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "example"

order_idZeichenfolgeErforderlich

Kennung der zugehörigen Bestellung.

Beispiel: "example"

order_numberZeichenfolgeErforderlich

Nummer der zugehörigen Bestellung.

Beispiel: "example"

products_valueMoneyData Erforderlich

Wert der Produkte in der Bestellung.

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

refundRefundData Erforderlich

Gespeicherte Erstattungsinformationen.

Beispiel:

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

resolution_stateZeichenfolgeErforderlich

Bearbeitungsstatus eines Kundenvorgangs.

Einschränkungen

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

Beispiel: "unknown"

statusRequestStatusData Erforderlich

Von dieser konkreten Operation akzeptierter Status.

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

typeRequestType Erforderlich

Ressourcentyp.

Beispiel: "return"

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

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

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Ressourcentyp

RequestType · Schema · Datenschemas: Rückgaben, Reklamationen und Umtausch

Zeichenfolge

Einschränkungen

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

Zusätzliche Felder: Ja

Dem Produkt oder der gespeicherten Position zugeordnete Variantenoptionen

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Schema · Datenschemas: Rückgaben, Reklamationen und Umtausch

nameZeichenfolgeErforderlich: Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"
valueZeichenfolgeErforderlich: Durch das umgebende Schema beschriebener Wert.

Beispiel: "example"

Zusätzliche Felder: Nein