Gå til indhold
ShopentlyLearn
Dansk

Dataskemaer: Returneringer, reklamationer og ombytninger

Dataskemaer: Returneringer, reklamationer og ombytninger. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

Vis liste — Returneringer, reklamationer og ombytninger — Svar

ApiResponse_list_RequestSummaryData__ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Hent — Returneringer, reklamationer og ombytninger — Svar

ApiResponse_RequestDetailData_ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Opdater · Refusionsbeløb — Returneringer, reklamationer og ombytninger — Forespørgselsindhold

RefundAmountUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
amountStrengObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

minLength: 1maxLength: 64
Begrænsninger
pattern
"^[+-]?(?:[0-9]+(?:\\.[0-9]+)?|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?$"
Eksempel: "0.00"
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 0maximum: 9223372036854775807
Eksempel: 1
reasonStrengValgfrit

Registreret begrundelse for ændringen.

maxLength: 500
Standard: ""

Yderligere felter: Nej

Registrerede refusionsoplysninger

RefundData · Skema · Dataskemaer: Returneringer, reklamationer og ombytninger
amountMoneyData nullObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

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

Afslutningstidspunkt.

Streng:format: "date-time"
Eksempel: null
statusStrengObligatorisk

Status accepteret af denne specifikke operation.

Begrænsninger
enum
["pending", "completed"]
Eksempel: "pending"
updated_atStreng nullObligatorisk

Tidspunkt for seneste opdatering.

Streng:format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Hent — Returneringer, reklamationer og ombytninger — Svar

RequestDetailData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
customerRequestCustomerData Obligatorisk

Kundeoplysninger registreret for denne ressource.

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

Ressourceidentifikator; bevar den som returneret. (RequestDetailData).

Eksempel: "example"
itemsArray <RequestItemData > Obligatorisk

Elementer inkluderet i ressourcen.

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 sagsnummer beregnet til mennesker.

Eksempel: "example"
order_idStrengObligatorisk

Identifikator for den relaterede ordre.

Eksempel: "example"
order_numberStrengObligatorisk

Nummer på den relaterede ordre.

Eksempel: "example"
products_valueMoneyData Obligatorisk

Værdien af produkterne i ordren.

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

Registrerede refusionsoplysninger.

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

Kundesagens behandlingstilstand.

Begrænsninger
enum
["unknown", "open", "completed", "rejected", "cancelled"]
Eksempel: "unknown"
statusRequestStatusData Obligatorisk

Status accepteret af denne specifikke operation.

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

Ressourcetype.

Eksempel: "return"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Hent — Returneringer, reklamationer og ombytninger — Svar

RequestItemData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (RequestItemData).

Eksempel: "example"
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
order_line_idStreng nullObligatorisk

Identifikator for den relaterede ordrelinje.

Eksempel: "example"
product_idStrengObligatorisk

Produktidentifikator.

Eksempel: "example"
quantityHeltalObligatorisk

Antal enheder.

Eksempel: 1
returned_quantityHeltalObligatorisk

Returneret mængde for denne linje.

Eksempel: 1
skuStrengObligatorisk

SKU-varekode.

Eksempel: "example"
totalMoneyData Obligatorisk

Samlet beløb.

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

Pris for én enhed.

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 øjebliksbilledet.

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

Yderligere felter: Nej

Status accepteret af denne specifikke operation

RequestStatusData · Skema · Dataskemaer: Returneringer, reklamationer og ombytninger
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (RequestStatusData).

Eksempel: "example"
localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

Eksempel: "en"
nameStreng nullObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"

Yderligere felter: Nej

Vis liste · Statusser — Returneringer, reklamationer og ombytninger — Svar

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
codeStrengObligatorisk

Stabil maskinlæsbar kode.

Eksempel: "example"
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Eksempel: "example"
is_initialBoolesk værdiObligatorisk

Om dette er startstatus.

Eksempel: false
localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

Eksempel: "en"
nameStreng nullObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
positionHeltalObligatorisk

Placering i den sorterede samling.

Eksempel: 1
typeRequestType Obligatorisk

Ressourcetype.

Eksempel: "return"

Yderligere felter: Nej

Vis liste · Statusser — Returneringer, reklamationer og ombytninger — Svar

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Opdater · Status — Returneringer, reklamationer og ombytninger — Forespørgselsindhold

RequestStatusUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807
Eksempel: 1
status_idStrengObligatorisk

Identifikator hentet fra den relevante statusliste.

Begrænsninger
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Eksempel: "example"

Yderligere felter: Nej

Vis liste — Returneringer, reklamationer og ombytninger — Svar

RequestSummaryData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
customerRequestCustomerData Obligatorisk

Kundeoplysninger registreret for denne ressource.

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

Ressourceidentifikator; bevar den som returneret. (RequestSummaryData).

Eksempel: "example"
numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"
order_idStrengObligatorisk

Identifikator for den relaterede ordre.

Eksempel: "example"
order_numberStrengObligatorisk

Nummer på den relaterede ordre.

Eksempel: "example"
products_valueMoneyData Obligatorisk

Værdien af produkterne i ordren.

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

Registrerede refusionsoplysninger.

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

Kundesagens behandlingstilstand.

Begrænsninger
enum
["unknown", "open", "completed", "rejected", "cancelled"]
Eksempel: "unknown"
statusRequestStatusData Obligatorisk

Status accepteret af denne specifikke operation.

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

Ressourcetype.

Eksempel: "return"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Ressourcetype

RequestType · Skema · Dataskemaer: Returneringer, reklamationer og ombytninger Streng
Begrænsninger
enum
["return", "exchange", "complaint"]

Yderligere felter: Ja

Variantvalg knyttet til produktet eller øjebliksbilledet

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Skema · Dataskemaer: Returneringer, reklamationer og ombytninger
nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"
valueStrengObligatorisk

Værdi beskrevet af det omgivende skema.

Eksempel: "example"

Yderligere felter: Nej