Datascheman: Returer, reklamationer och byten

Datascheman: Returer, reklamationer och byten. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Lista — Returer, reklamationer och byten — Svar

ApiResponse_list_RequestSummaryData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <RequestSummaryData > Obligatoriskt: Exempel på svar · ApiResponse_list_RequestSummaryData__.

Exempel: [{"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Hämta — Returer, reklamationer och byten — Svar

ApiResponse_RequestDetailData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataRequestDetailData Obligatoriskt: Exempel på svar · RequestDetailData.

Exempel: {"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 Obligatoriskt: Metadata för svaret.

Exempel: {"request_id":"example"}

Ytterligare fält: Nej

Uppdatera · Återbetalningsbelopp — Returer, reklamationer och byten — Begärans innehåll

RefundAmountUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

amountSträngObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

minLength: 1maxLength: 64

Begränsningar

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

Exempel: "0.00"

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 0maximum: 9223372036854775807

Exempel: 1

reasonSträngValfritt

Registrerad orsak till ändringen.

maxLength: 500

Standardvärde: ""

Ytterligare fält: Nej

Registrerad information om återbetalning

RefundData · Schema · Datascheman: Returer, reklamationer och byten

amountMoneyData nullObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

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

completed_atSträng nullObligatoriskt

Tidpunkt för slutförande.

Sträng:format: "date-time"

Exempel: null

statusSträngObligatoriskt

Status som accepteras av den aktuella operationen.

Begränsningar

enum: ["pending", "completed"]

Exempel: "pending"

updated_atSträng nullObligatoriskt

Tidpunkt för senaste uppdatering.

Sträng:format: "date-time"

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

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Hämta — Returer, reklamationer och byten — Svar

RequestDetailData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"

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

customerRequestCustomerData Obligatoriskt

Kunduppgifter registrerade för resursen.

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

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (RequestDetailData).

Exempel: "example"

itemsArray <RequestItemData > Obligatoriskt

Artiklar eller poster som ingår i resursen.

Exempel:

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

numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"

order_idSträngObligatoriskt

Identifierare för tillhörande beställning.

Exempel: "example"

order_numberSträngObligatoriskt

Tillhörande beställningsnummer.

Exempel: "example"

products_valueMoneyData Obligatoriskt

Värdet på produkterna i beställningen.

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

refundRefundData Obligatoriskt

Registrerad information om återbetalning.

Exempel:

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

resolution_stateSträngObligatoriskt

Status för lösning av ett kundärende.

Begränsningar

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

Exempel: "unknown"

statusRequestStatusData Obligatoriskt

Status som accepteras av den aktuella operationen.

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

typeRequestType Obligatoriskt

Resurstyp.

Exempel: "return"

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"

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

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Hämta — Returer, reklamationer och byten — Svar

RequestItemData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

idSträngObligatoriskt: Resursens identifierare; bevara den som den returneras. (RequestItemData).

Exempel: "example"
nameSträngObligatoriskt: Resursens namn i aktuell kontext.

Exempel: "Example"
order_line_idSträng nullObligatoriskt: Identifierare för tillhörande orderrad.

Exempel: "example"
product_idSträngObligatoriskt: Produktens identifierare.

Exempel: "example"
quantityHeltalObligatoriskt: Antal enheter.

Exempel: 1
returned_quantityHeltalObligatoriskt: Returnerat antal för denna rad.

Exempel: 1
skuSträngObligatoriskt: Artikelns SKU-kod.

Exempel: "example"
totalMoneyData Obligatoriskt: Totalbelopp.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obligatoriskt: Pris per enhet.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idSträng nullObligatoriskt: Produktvariantens identifierare.

Exempel: "example"
variant_optionsArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obligatoriskt: Variantalternativ kopplade till produkten eller den sparade posten.

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

Ytterligare fält: Nej

Status som accepteras av den aktuella operationen

RequestStatusData · Schema · Datascheman: Returer, reklamationer och byten

idSträngObligatoriskt: Resursens identifierare; bevara den som den returneras. (RequestStatusData).

Exempel: "example"
localeSträngObligatoriskt: Språk valt för denna begäran.

Exempel: "en"
nameSträng nullObligatoriskt: Resursens namn i aktuell kontext.

Exempel: "Example"

Ytterligare fält: Nej

Lista · Statusar — Returer, reklamationer och byten — Svar

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

codeSträngObligatoriskt: Stabil maskinläsbar kod.

Exempel: "example"
created_atSträngObligatoriskt: Tidpunkt för skapande.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
idSträngObligatoriskt: Resursens identifierare; bevara den som den returneras. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Exempel: "example"
is_initialBooleskt värdeObligatoriskt: Anger om detta är den ursprungliga statusen.

Exempel: false
localeSträngObligatoriskt: Språk valt för denna begäran.

Exempel: "en"
nameSträng nullObligatoriskt: Resursens namn i aktuell kontext.

Exempel: "Example"
positionHeltalObligatoriskt: Position i den ordnade samlingen.

Exempel: 1
typeRequestType Obligatoriskt: Resurstyp.

Exempel: "return"

Ytterligare fält: Nej

Lista · Statusar — Returer, reklamationer och byten — Svar

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obligatoriskt: Exempel på svar · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Exempel: [{"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Uppdatera · Status — Returer, reklamationer och byten — Begärans innehåll

RequestStatusUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1

status_idSträngObligatoriskt

Identifierare hämtad från relevant statuskatalog.

Begränsningar

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

Exempel: "example"

Ytterligare fält: Nej

Lista — Returer, reklamationer och byten — Svar

RequestSummaryData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"

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

customerRequestCustomerData Obligatoriskt

Kunduppgifter registrerade för resursen.

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

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (RequestSummaryData).

Exempel: "example"

numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"

order_idSträngObligatoriskt

Identifierare för tillhörande beställning.

Exempel: "example"

order_numberSträngObligatoriskt

Tillhörande beställningsnummer.

Exempel: "example"

products_valueMoneyData Obligatoriskt

Värdet på produkterna i beställningen.

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

refundRefundData Obligatoriskt

Registrerad information om återbetalning.

Exempel:

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

resolution_stateSträngObligatoriskt

Status för lösning av ett kundärende.

Begränsningar

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

Exempel: "unknown"

statusRequestStatusData Obligatoriskt

Status som accepteras av den aktuella operationen.

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

typeRequestType Obligatoriskt

Resurstyp.

Exempel: "return"

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"

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

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Resurstyp

RequestType · Schema · Datascheman: Returer, reklamationer och byten

Sträng

Begränsningar

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

Ytterligare fält: Ja

Variantalternativ kopplade till produkten eller den sparade posten

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Schema · Datascheman: Returer, reklamationer och byten

nameSträngObligatoriskt: Resursens namn i aktuell kontext.

Exempel: "Example"
valueSträngObligatoriskt: Värde som beskrivs av omgivande schema.

Exempel: "example"

Ytterligare fält: Nej