Gegevensschema’s: Retouren, klachten en ruilingen

Gegevensschema’s: Retouren, klachten en ruilingen. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Lijst ophalen — Retouren, klachten en ruilingen — Antwoord

ApiResponse_list_RequestSummaryData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <RequestSummaryData > Verplicht: Voorbeeldantwoord · ApiResponse_list_RequestSummaryData__.

Voorbeeld: [{"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Ophalen — Retouren, klachten en ruilingen — Antwoord

ApiResponse_RequestDetailData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataRequestDetailData Verplicht: Voorbeeldantwoord · RequestDetailData.

Voorbeeld: {"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 Verplicht: Metadata van het antwoord.

Voorbeeld: {"request_id":"example"}

Aanvullende velden: Nee

Bijwerken · Terugbetalingsbedrag — Retouren, klachten en ruilingen — Verzoekinhoud

RefundAmountUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

amountTekenreeksVerplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

minLength: 1maxLength: 64

Beperkingen

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

Voorbeeld: "0.00"

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 0maximum: 9223372036854775807

Voorbeeld: 1

reasonTekenreeksOptioneel

Vastgelegde reden voor de wijziging.

maxLength: 500

Standaard: ""

Aanvullende velden: Nee

Vastgelegde terugbetalingsgegevens

RefundData · Schema · Gegevensschema’s: Retouren, klachten en ruilingen

amountMoneyData nullVerplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

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

completed_atTekenreeks nullVerplicht

Tijdstip van voltooiing.

Tekenreeks:format: "date-time"

Voorbeeld: null

statusTekenreeksVerplicht

Status die deze specifieke bewerking accepteert.

Beperkingen

enum: ["pending", "completed"]

Voorbeeld: "pending"

updated_atTekenreeks nullVerplicht

Tijdstip van de meest recente wijziging.

Tekenreeks:format: "date-time"

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

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Ophalen — Retouren, klachten en ruilingen — Antwoord

RequestDetailData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"

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

customerRequestCustomerData Verplicht

Klantgegevens die voor deze resource zijn vastgelegd.

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

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (RequestDetailData).

Voorbeeld: "example"

itemsArray <RequestItemData > Verplicht

Items in de resource.

Voorbeeld:

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

numberTekenreeksVerplicht

Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "example"

order_idTekenreeksVerplicht

Identificatie van de bijbehorende bestelling.

Voorbeeld: "example"

order_numberTekenreeksVerplicht

Nummer van de bijbehorende bestelling.

Voorbeeld: "example"

products_valueMoneyData Verplicht

Waarde van de producten in de bestelling.

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

refundRefundData Verplicht

Vastgelegde terugbetalingsgegevens.

Voorbeeld:

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

resolution_stateTekenreeksVerplicht

Afhandelingsstatus van een klantaanvraag.

Beperkingen

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

Voorbeeld: "unknown"

statusRequestStatusData Verplicht

Status die deze specifieke bewerking accepteert.

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

typeRequestType Verplicht

Resourcetype.

Voorbeeld: "return"

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"

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

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Ophalen — Retouren, klachten en ruilingen — Antwoord

RequestItemData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

idTekenreeksVerplicht: Resource-identificatie; bewaar deze zoals teruggegeven. (RequestItemData).

Voorbeeld: "example"
nameTekenreeksVerplicht: Resourcenaam in de betreffende context.

Voorbeeld: "Example"
order_line_idTekenreeks nullVerplicht: Identificatie van de bijbehorende bestelregel.

Voorbeeld: "example"
product_idTekenreeksVerplicht: Productidentificatie.

Voorbeeld: "example"
quantityGeheel getalVerplicht: Aantal eenheden.

Voorbeeld: 1
returned_quantityGeheel getalVerplicht: Geretourneerde hoeveelheid voor deze regel.

Voorbeeld: 1
skuTekenreeksVerplicht: Voorraadartikelcode (SKU).

Voorbeeld: "example"
totalMoneyData Verplicht: Totaalbedrag.

Voorbeeld: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Verplicht: Prijs per eenheid.

Voorbeeld: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idTekenreeks nullVerplicht: Identificatie van de productvariant.

Voorbeeld: "example"
variant_optionsArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Verplicht: Variantopties die bij het product of de momentopname horen.

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

Aanvullende velden: Nee

Status die deze specifieke bewerking accepteert

RequestStatusData · Schema · Gegevensschema’s: Retouren, klachten en ruilingen

idTekenreeksVerplicht: Resource-identificatie; bewaar deze zoals teruggegeven. (RequestStatusData).

Voorbeeld: "example"
localeTekenreeksVerplicht: Taal die voor dit verzoek is geselecteerd.

Voorbeeld: "en"
nameTekenreeks nullVerplicht: Resourcenaam in de betreffende context.

Voorbeeld: "Example"

Aanvullende velden: Nee

Lijst ophalen · Statussen — Retouren, klachten en ruilingen — Antwoord

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

codeTekenreeksVerplicht: Stabiele, machineleesbare code.

Voorbeeld: "example"
created_atTekenreeksVerplicht: Tijdstip van aanmaak.

format: "date-time"

Voorbeeld: "2026-01-01T12:00:00Z"
idTekenreeksVerplicht: Resource-identificatie; bewaar deze zoals teruggegeven. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Voorbeeld: "example"
is_initialBooleaanse waardeVerplicht: Of dit de beginstatus is.

Voorbeeld: false
localeTekenreeksVerplicht: Taal die voor dit verzoek is geselecteerd.

Voorbeeld: "en"
nameTekenreeks nullVerplicht: Resourcenaam in de betreffende context.

Voorbeeld: "Example"
positionGeheel getalVerplicht: Positie in de geordende verzameling.

Voorbeeld: 1
typeRequestType Verplicht: Resourcetype.

Voorbeeld: "return"

Aanvullende velden: Nee

Lijst ophalen · Statussen — Retouren, klachten en ruilingen — Antwoord

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Verplicht: Voorbeeldantwoord · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Voorbeeld: [{"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Bijwerken · Status — Retouren, klachten en ruilingen — Verzoekinhoud

RequestStatusUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

status_idTekenreeksVerplicht

Identificatie uit de bijbehorende statuslijst.

Beperkingen

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

Voorbeeld: "example"

Aanvullende velden: Nee

Lijst ophalen — Retouren, klachten en ruilingen — Antwoord

RequestSummaryData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"

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

customerRequestCustomerData Verplicht

Klantgegevens die voor deze resource zijn vastgelegd.

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

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (RequestSummaryData).

Voorbeeld: "example"

numberTekenreeksVerplicht

Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "example"

order_idTekenreeksVerplicht

Identificatie van de bijbehorende bestelling.

Voorbeeld: "example"

order_numberTekenreeksVerplicht

Nummer van de bijbehorende bestelling.

Voorbeeld: "example"

products_valueMoneyData Verplicht

Waarde van de producten in de bestelling.

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

refundRefundData Verplicht

Vastgelegde terugbetalingsgegevens.

Voorbeeld:

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

resolution_stateTekenreeksVerplicht

Afhandelingsstatus van een klantaanvraag.

Beperkingen

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

Voorbeeld: "unknown"

statusRequestStatusData Verplicht

Status die deze specifieke bewerking accepteert.

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

typeRequestType Verplicht

Resourcetype.

Voorbeeld: "return"

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"

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

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Resourcetype

RequestType · Schema · Gegevensschema’s: Retouren, klachten en ruilingen

Tekenreeks

Beperkingen

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

Aanvullende velden: Ja

Variantopties die bij het product of de momentopname horen

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Schema · Gegevensschema’s: Retouren, klachten en ruilingen

nameTekenreeksVerplicht: Resourcenaam in de betreffende context.

Voorbeeld: "Example"
valueTekenreeksVerplicht: Waarde zoals beschreven door het omringende schema.

Voorbeeld: "example"

Aanvullende velden: Nee