Dataskjemaer: Returer, reklamasjoner og bytter

Dataskjemaer: Returer, reklamasjoner og bytter. Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Dataskjemaer

Vis liste — Returer, reklamasjoner og bytter — Svar

ApiResponse_list_RequestSummaryData__ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

dataArray <RequestSummaryData > Obligatorisk: Eksempel på svar · ApiResponse_list_RequestSummaryData__.

Eksempel: [{"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 Obligatorisk: Svarmetadata.

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

Ytterligere felt: Nei

Hent — Returer, reklamasjoner og bytter — Svar

ApiResponse_RequestDetailData_ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

dataRequestDetailData Obligatorisk: Eksempel på svar · RequestDetailData.

Eksempel: {"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 Obligatorisk: Svarmetadata.

Eksempel: {"request_id":"example"}

Ytterligere felt: Nei

Oppdater · Refusjonsbeløp — Returer, reklamasjoner og bytter — Forespørselsinnhold

RefundAmountUpdate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

amountStrengObligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

minLength: 1maxLength: 64

Begrensninger

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

Eksempel: "0.00"

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 0maximum: 9223372036854775807

Eksempel: 1

reasonStrengValgfritt

Registrert begrunnelse for endringen.

maxLength: 500

Standard: ""

Ytterligere felt: Nei

Registrert refusjonsinformasjon

RefundData · Skjema · Dataskjemaer: Returer, reklamasjoner og bytter

amountMoneyData nullObligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

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

completed_atStreng nullObligatorisk

Fullføringstidspunkt.

Streng:format: "date-time"

Eksempel: null

statusStrengObligatorisk

Status som godtas av denne bestemte operasjonen.

Begrensninger

enum: ["pending", "completed"]

Eksempel: "pending"

updated_atStreng nullObligatorisk

Tidspunkt for siste oppdatering.

Streng:format: "date-time"

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

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Hent — Returer, reklamasjoner og bytter — Svar

RequestDetailData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"

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

customerRequestCustomerData Obligatorisk

Kundeinformasjon registrert for denne ressursen.

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

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (RequestDetailData).

Eksempel: "example"

itemsArray <RequestItemData > Obligatorisk

Elementer som inngår i ressursen.

Eksempel:

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

numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "example"

order_idStrengObligatorisk

Identifikator for tilknyttet ordre.

Eksempel: "example"

order_numberStrengObligatorisk

Nummer på tilknyttet ordre.

Eksempel: "example"

products_valueMoneyData Obligatorisk

Verdien av produktene i ordren.

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

refundRefundData Obligatorisk

Registrert refusjonsinformasjon.

Eksempel:

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

resolution_stateStrengObligatorisk

Behandlingstilstand for en kundesak.

Begrensninger

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

Eksempel: "unknown"

statusRequestStatusData Obligatorisk

Status som godtas av denne bestemte operasjonen.

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

typeRequestType Obligatorisk

Ressurstype.

Eksempel: "return"

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"

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

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Hent — Returer, reklamasjoner og bytter — Svar

RequestItemData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

idStrengObligatorisk: Ressursidentifikator; behold den slik den returneres. (RequestItemData).

Eksempel: "example"
nameStrengObligatorisk: Ressursens navn i den relevante konteksten.

Eksempel: "Example"
order_line_idStreng nullObligatorisk: Identifikator for tilknyttet ordrelinje.

Eksempel: "example"
product_idStrengObligatorisk: Produktidentifikator.

Eksempel: "example"
quantityHeltallObligatorisk: Antall enheter.

Eksempel: 1
returned_quantityHeltallObligatorisk: Returnert mengde for denne linjen.

Eksempel: 1
skuStrengObligatorisk: SKU-varekode.

Eksempel: "example"
totalMoneyData Obligatorisk: Samlet beløp.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obligatorisk: Pris for én enhet.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idStreng nullObligatorisk: Produktvariantidentifikator.

Eksempel: "example"
variant_optionsArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obligatorisk: Variantvalg knyttet til produktet eller øyeblikksbildet.

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

Ytterligere felt: Nei

Status som godtas av denne bestemte operasjonen

RequestStatusData · Skjema · Dataskjemaer: Returer, reklamasjoner og bytter

idStrengObligatorisk: Ressursidentifikator; behold den slik den returneres. (RequestStatusData).

Eksempel: "example"
localeStrengObligatorisk: Språk valgt for denne forespørselen.

Eksempel: "en"
nameStreng nullObligatorisk: Ressursens navn i den relevante konteksten.

Eksempel: "Example"

Ytterligere felt: Nei

Vis liste · Statuser — Returer, reklamasjoner og bytter — Svar

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

codeStrengObligatorisk: Stabil maskinlesbar kode.

Eksempel: "example"
created_atStrengObligatorisk: Opprettelsestidspunkt.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk: Ressursidentifikator; behold den slik den returneres. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Eksempel: "example"
is_initialBoolsk verdiObligatorisk: Om dette er startstatusen.

Eksempel: false
localeStrengObligatorisk: Språk valgt for denne forespørselen.

Eksempel: "en"
nameStreng nullObligatorisk: Ressursens navn i den relevante konteksten.

Eksempel: "Example"
positionHeltallObligatorisk: Plassering i den sorterte samlingen.

Eksempel: 1
typeRequestType Obligatorisk: Ressurstype.

Eksempel: "return"

Ytterligere felt: Nei

Vis liste · Statuser — Returer, reklamasjoner og bytter — Svar

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

dataArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obligatorisk: Eksempel på svar · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Eksempel: [{"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 Obligatorisk: Svarmetadata.

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

Ytterligere felt: Nei

Oppdater · Status — Returer, reklamasjoner og bytter — Forespørselsinnhold

RequestStatusUpdate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

status_idStrengObligatorisk

Identifikator hentet fra den relevante statuslisten.

Begrensninger

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

Eksempel: "example"

Ytterligere felt: Nei

Vis liste — Returer, reklamasjoner og bytter — Svar

RequestSummaryData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"

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

customerRequestCustomerData Obligatorisk

Kundeinformasjon registrert for denne ressursen.

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

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (RequestSummaryData).

Eksempel: "example"

numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "example"

order_idStrengObligatorisk

Identifikator for tilknyttet ordre.

Eksempel: "example"

order_numberStrengObligatorisk

Nummer på tilknyttet ordre.

Eksempel: "example"

products_valueMoneyData Obligatorisk

Verdien av produktene i ordren.

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

refundRefundData Obligatorisk

Registrert refusjonsinformasjon.

Eksempel:

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

resolution_stateStrengObligatorisk

Behandlingstilstand for en kundesak.

Begrensninger

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

Eksempel: "unknown"

statusRequestStatusData Obligatorisk

Status som godtas av denne bestemte operasjonen.

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

typeRequestType Obligatorisk

Ressurstype.

Eksempel: "return"

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"

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

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Ressurstype

RequestType · Skjema · Dataskjemaer: Returer, reklamasjoner og bytter

Streng

Begrensninger

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

Ytterligere felt: Ja

Variantvalg knyttet til produktet eller øyeblikksbildet

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Skjema · Dataskjemaer: Returer, reklamasjoner og bytter

nameStrengObligatorisk: Ressursens navn i den relevante konteksten.

Eksempel: "Example"
valueStrengObligatorisk: Verdi beskrevet av det omkringliggende skjemaet.

Eksempel: "example"

Ytterligere felt: Nei