Esquemas de datos: Devoluciones, reclamaciones y cambios

Esquemas de datos: Devoluciones, reclamaciones y cambios. Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

Esquemas de datos

Listar — Devoluciones, reclamaciones y cambios — Respuesta

ApiResponse_list_RequestSummaryData__ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataLista <RequestSummaryData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_RequestSummaryData__.

Ejemplo: [{"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 Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Obtener — Devoluciones, reclamaciones y cambios — Respuesta

ApiResponse_RequestDetailData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataRequestDetailData Obligatorio: Ejemplo de respuesta · RequestDetailData.

Ejemplo: {"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 Obligatorio: Metadatos de la respuesta.

Ejemplo: {"request_id":"example"}

Campos adicionales: No

Actualizar · Importe del reembolso — Devoluciones, reclamaciones y cambios — Cuerpo de la solicitud

RefundAmountUpdate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

amountCadena de textoObligatorio

Importe decimal codificado como cadena JSON; null solo cuando se permite.

minLength: 1maxLength: 64

Restricciones

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

Ejemplo: "0.00"

expected_versionNúmero enteroObligatorio

Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 0maximum: 9223372036854775807

Ejemplo: 1

reasonCadena de textoOpcional

Motivo registrado para el cambio.

maxLength: 500

Valor predeterminado: ""

Campos adicionales: No

Información registrada del reembolso

RefundData · Esquema · Esquemas de datos: Devoluciones, reclamaciones y cambios

amountMoneyData nullObligatorio

Importe decimal codificado como cadena JSON; null solo cuando se permite.

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

completed_atCadena de texto nullObligatorio

Momento de finalización.

Cadena de texto:format: "date-time"

Ejemplo: null

statusCadena de textoObligatorio

Estado admitido por esta operación concreta.

Restricciones

enum: ["pending", "completed"]

Ejemplo: "pending"

updated_atCadena de texto nullObligatorio

Momento de la última actualización.

Cadena de texto:format: "date-time"

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

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Obtener — Devoluciones, reclamaciones y cambios — Respuesta

RequestDetailData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"

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

customerRequestCustomerData Obligatorio

Información del cliente registrada para este recurso.

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

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (RequestDetailData).

Ejemplo: "example"

itemsLista <RequestItemData > Obligatorio

Elementos incluidos en el recurso.

Ejemplo:

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

numberCadena de textoObligatorio

Número de pedido o solicitud mostrado al usuario.

Ejemplo: "example"

order_idCadena de textoObligatorio

Identificador del pedido relacionado.

Ejemplo: "example"

order_numberCadena de textoObligatorio

Número del pedido relacionado.

Ejemplo: "example"

products_valueMoneyData Obligatorio

Valor de los productos del pedido.

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

refundRefundData Obligatorio

Información registrada del reembolso.

Ejemplo:

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

resolution_stateCadena de textoObligatorio

Estado de resolución de una solicitud del cliente.

Restricciones

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

Ejemplo: "unknown"

statusRequestStatusData Obligatorio

Estado admitido por esta operación concreta.

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

typeRequestType Obligatorio

Tipo de recurso.

Ejemplo: "return"

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

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

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Obtener — Devoluciones, reclamaciones y cambios — Respuesta

RequestItemData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

idCadena de textoObligatorio: Identificador del recurso; consérvalo tal como se devuelve. (RequestItemData).

Ejemplo: "example"
nameCadena de textoObligatorio: Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"
order_line_idCadena de texto nullObligatorio: Identificador de la línea de pedido relacionada.

Ejemplo: "example"
product_idCadena de textoObligatorio: Identificador del producto.

Ejemplo: "example"
quantityNúmero enteroObligatorio: Número de unidades.

Ejemplo: 1
returned_quantityNúmero enteroObligatorio: Cantidad devuelta de esta línea.

Ejemplo: 1
skuCadena de textoObligatorio: Código de referencia de inventario.

Ejemplo: "example"
totalMoneyData Obligatorio: Importe total.

Ejemplo: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obligatorio: Precio por unidad.

Ejemplo: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idCadena de texto nullObligatorio: Identificador de la variante del producto.

Ejemplo: "example"
variant_optionsLista <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obligatorio: Opciones de variante asociadas al producto o a sus datos registrados.

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

Campos adicionales: No

Estado admitido por esta operación concreta

RequestStatusData · Esquema · Esquemas de datos: Devoluciones, reclamaciones y cambios

idCadena de textoObligatorio: Identificador del recurso; consérvalo tal como se devuelve. (RequestStatusData).

Ejemplo: "example"
localeCadena de textoObligatorio: Idioma seleccionado para esta solicitud.

Ejemplo: "en"
nameCadena de texto nullObligatorio: Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"

Campos adicionales: No

Listar · Estados — Devoluciones, reclamaciones y cambios — Respuesta

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

codeCadena de textoObligatorio: Código estable legible por programas.

Ejemplo: "example"
created_atCadena de textoObligatorio: Momento de creación.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"
idCadena de textoObligatorio: Identificador del recurso; consérvalo tal como se devuelve. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Ejemplo: "example"
is_initialBooleanoObligatorio: Indica si este es el estado inicial.

Ejemplo: false
localeCadena de textoObligatorio: Idioma seleccionado para esta solicitud.

Ejemplo: "en"
nameCadena de texto nullObligatorio: Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"
positionNúmero enteroObligatorio: Posición en la colección ordenada.

Ejemplo: 1
typeRequestType Obligatorio: Tipo de recurso.

Ejemplo: "return"

Campos adicionales: No

Listar · Estados — Devoluciones, reclamaciones y cambios — Respuesta

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataLista <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obligatorio: Ejemplo de respuesta · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Ejemplo: [{"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 Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Actualizar · Estado — Devoluciones, reclamaciones y cambios — Cuerpo de la solicitud

RequestStatusUpdate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

expected_versionNúmero enteroObligatorio

Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

status_idCadena de textoObligatorio

Identificador obtenido del catálogo de estados correspondiente.

Restricciones

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

Ejemplo: "example"

Campos adicionales: No

Listar — Devoluciones, reclamaciones y cambios — Respuesta

RequestSummaryData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"

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

customerRequestCustomerData Obligatorio

Información del cliente registrada para este recurso.

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

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (RequestSummaryData).

Ejemplo: "example"

numberCadena de textoObligatorio

Número de pedido o solicitud mostrado al usuario.

Ejemplo: "example"

order_idCadena de textoObligatorio

Identificador del pedido relacionado.

Ejemplo: "example"

order_numberCadena de textoObligatorio

Número del pedido relacionado.

Ejemplo: "example"

products_valueMoneyData Obligatorio

Valor de los productos del pedido.

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

refundRefundData Obligatorio

Información registrada del reembolso.

Ejemplo:

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

resolution_stateCadena de textoObligatorio

Estado de resolución de una solicitud del cliente.

Restricciones

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

Ejemplo: "unknown"

statusRequestStatusData Obligatorio

Estado admitido por esta operación concreta.

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

typeRequestType Obligatorio

Tipo de recurso.

Ejemplo: "return"

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

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

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Tipo de recurso

RequestType · Esquema · Esquemas de datos: Devoluciones, reclamaciones y cambios

Cadena de texto

Restricciones

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

Campos adicionales: Sí

Opciones de variante asociadas al producto o a sus datos registrados

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Esquema · Esquemas de datos: Devoluciones, reclamaciones y cambios

nameCadena de textoObligatorio: Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"
valueCadena de textoObligatorio: Valor definido por el esquema que lo contiene.

Ejemplo: "example"

Campos adicionales: No