Schemi dei dati: Resi, reclami e cambi

Schemi dei dati: Resi, reclami e cambi. Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Schemi dei dati

Elenca — Resi, reclami e cambi — Risposta

ApiResponse_list_RequestSummaryData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataArray <RequestSummaryData > Obbligatorio: Esempio di risposta · ApiResponse_list_RequestSummaryData__.

Esempio: [{"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 Obbligatorio: Metadati della risposta.

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

Campi aggiuntivi: No

Recupera — Resi, reclami e cambi — Risposta

ApiResponse_RequestDetailData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataRequestDetailData Obbligatorio: Esempio di risposta · RequestDetailData.

Esempio: {"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 Obbligatorio: Metadati della risposta.

Esempio: {"request_id":"example"}

Campi aggiuntivi: No

Aggiorna · Importo del rimborso — Resi, reclami e cambi — Corpo della richiesta

RefundAmountUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

amountStringaObbligatorio

Importo decimale codificato come stringa JSON; null solo dove consentito.

minLength: 1maxLength: 64

Vincoli

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

Esempio: "0.00"

expected_versionInteroObbligatorio

Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 0maximum: 9223372036854775807

Esempio: 1

reasonStringaFacoltativo

Motivo registrato per la modifica.

maxLength: 500

Valore predefinito: ""

Campi aggiuntivi: No

Informazioni sul rimborso registrato

RefundData · Schema · Schemi dei dati: Resi, reclami e cambi

amountMoneyData nullObbligatorio

Importo decimale codificato come stringa JSON; null solo dove consentito.

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

completed_atStringa nullObbligatorio

Data e ora di completamento.

Stringa:format: "date-time"

Esempio: null

statusStringaObbligatorio

Stato accettato da questa specifica operazione.

Vincoli

enum: ["pending", "completed"]

Esempio: "pending"

updated_atStringa nullObbligatorio

Data e ora dell’aggiornamento più recente.

Stringa:format: "date-time"

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

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Recupera — Resi, reclami e cambi — Risposta

RequestDetailData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"

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

customerRequestCustomerData Obbligatorio

Dati del cliente registrati per questa risorsa.

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

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (RequestDetailData).

Esempio: "example"

itemsArray <RequestItemData > Obbligatorio

Elementi inclusi nella risorsa.

Esempio:

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

numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"

order_idStringaObbligatorio

Identificativo dell’ordine collegato.

Esempio: "example"

order_numberStringaObbligatorio

Numero dell’ordine collegato.

Esempio: "example"

products_valueMoneyData Obbligatorio

Valore dei prodotti nell’ordine.

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

refundRefundData Obbligatorio

Informazioni sul rimborso registrato.

Esempio:

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

resolution_stateStringaObbligatorio

Stato di risoluzione di una richiesta del cliente.

Vincoli

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

Esempio: "unknown"

statusRequestStatusData Obbligatorio

Stato accettato da questa specifica operazione.

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

typeRequestType Obbligatorio

Tipo di risorsa.

Esempio: "return"

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"

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

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Recupera — Resi, reclami e cambi — Risposta

RequestItemData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

idStringaObbligatorio: Identificativo della risorsa; conservalo come restituito. (RequestItemData).

Esempio: "example"
nameStringaObbligatorio: Nome della risorsa nel contesto pertinente.

Esempio: "Example"
order_line_idStringa nullObbligatorio: Identificativo della riga d’ordine collegata.

Esempio: "example"
product_idStringaObbligatorio: Identificativo del prodotto.

Esempio: "example"
quantityInteroObbligatorio: Numero di unità.

Esempio: 1
returned_quantityInteroObbligatorio: Quantità restituita per questa riga.

Esempio: 1
skuStringaObbligatorio: Codice di identificazione dell’articolo a magazzino.

Esempio: "example"
totalMoneyData Obbligatorio: Importo totale.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obbligatorio: Prezzo per unità.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idStringa nullObbligatorio: Identificativo della variante del prodotto.

Esempio: "example"
variant_optionsArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obbligatorio: Opzioni di variante associate al prodotto o ai dati storici salvati.

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

Campi aggiuntivi: No

Stato accettato da questa specifica operazione

RequestStatusData · Schema · Schemi dei dati: Resi, reclami e cambi

idStringaObbligatorio: Identificativo della risorsa; conservalo come restituito. (RequestStatusData).

Esempio: "example"
localeStringaObbligatorio: Lingua selezionata per questa richiesta.

Esempio: "en"
nameStringa nullObbligatorio: Nome della risorsa nel contesto pertinente.

Esempio: "Example"

Campi aggiuntivi: No

Elenca · Stati — Resi, reclami e cambi — Risposta

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

codeStringaObbligatorio: Codice stabile interpretabile dal software.

Esempio: "example"
created_atStringaObbligatorio: Data e ora di creazione.

format: "date-time"

Esempio: "2026-01-01T12:00:00Z"
idStringaObbligatorio: Identificativo della risorsa; conservalo come restituito. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Esempio: "example"
is_initialBooleanoObbligatorio: Indica se è lo stato iniziale.

Esempio: false
localeStringaObbligatorio: Lingua selezionata per questa richiesta.

Esempio: "en"
nameStringa nullObbligatorio: Nome della risorsa nel contesto pertinente.

Esempio: "Example"
positionInteroObbligatorio: Posizione nella collezione ordinata.

Esempio: 1
typeRequestType Obbligatorio: Tipo di risorsa.

Esempio: "return"

Campi aggiuntivi: No

Elenca · Stati — Resi, reclami e cambi — Risposta

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obbligatorio: Esempio di risposta · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Esempio: [{"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 Obbligatorio: Metadati della risposta.

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

Campi aggiuntivi: No

Aggiorna · Stato — Resi, reclami e cambi — Corpo della richiesta

RequestStatusUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

expected_versionInteroObbligatorio

Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 9223372036854775807

Esempio: 1

status_idStringaObbligatorio

Identificativo ottenuto dal dizionario degli stati pertinente.

Vincoli

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

Esempio: "example"

Campi aggiuntivi: No

Elenca — Resi, reclami e cambi — Risposta

RequestSummaryData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"

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

customerRequestCustomerData Obbligatorio

Dati del cliente registrati per questa risorsa.

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

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (RequestSummaryData).

Esempio: "example"

numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"

order_idStringaObbligatorio

Identificativo dell’ordine collegato.

Esempio: "example"

order_numberStringaObbligatorio

Numero dell’ordine collegato.

Esempio: "example"

products_valueMoneyData Obbligatorio

Valore dei prodotti nell’ordine.

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

refundRefundData Obbligatorio

Informazioni sul rimborso registrato.

Esempio:

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

resolution_stateStringaObbligatorio

Stato di risoluzione di una richiesta del cliente.

Vincoli

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

Esempio: "unknown"

statusRequestStatusData Obbligatorio

Stato accettato da questa specifica operazione.

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

typeRequestType Obbligatorio

Tipo di risorsa.

Esempio: "return"

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"

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

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Tipo di risorsa

RequestType · Schema · Schemi dei dati: Resi, reclami e cambi

Stringa

Vincoli

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

Campi aggiuntivi: Sì

Opzioni di variante associate al prodotto o ai dati storici salvati

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Schema · Schemi dei dati: Resi, reclami e cambi

nameStringaObbligatorio: Nome della risorsa nel contesto pertinente.

Esempio: "Example"
valueStringaObbligatorio: Valore descritto dallo schema circostante.

Esempio: "example"

Campi aggiuntivi: No