Esquemas de dados: Devoluções, reclamações e trocas

Esquemas de dados: Devoluções, reclamações e trocas. Campos, tipos e restrições dos dados aceitos ou retornados pela API.

Esquemas de dados

Listar — Devoluções, reclamações e trocas — Resposta

ApiResponse_list_RequestSummaryData__ · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

dataLista <RequestSummaryData > Obrigatório: Exemplo de resposta · ApiResponse_list_RequestSummaryData__.

Exemplo: [{"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 Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

Obter — Devoluções, reclamações e trocas — Resposta

ApiResponse_RequestDetailData_ · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

dataRequestDetailData Obrigatório: Exemplo de resposta · RequestDetailData.

Exemplo: {"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 Obrigatório: Metadados da resposta.

Exemplo: {"request_id":"example"}

Campos adicionais: Não

Atualizar · Valor do reembolso — Devoluções, reclamações e trocas — Corpo da requisição

RefundAmountUpdate · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

amountTextoObrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

minLength: 1maxLength: 64

Restrições

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

Exemplo: "0.00"

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 0maximum: 9223372036854775807

Exemplo: 1

reasonTextoOpcional

Motivo registrado para a alteração.

maxLength: 500

Padrão: ""

Campos adicionais: Não

Informações de reembolso registradas

RefundData · Esquema · Esquemas de dados: Devoluções, reclamações e trocas

amountMoneyData nullObrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

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

completed_atTexto nullObrigatório

Momento da conclusão.

Texto:format: "date-time"

Exemplo: null

statusTextoObrigatório

Estado aceito por esta operação específica.

Restrições

enum: ["pending", "completed"]

Exemplo: "pending"

updated_atTexto nullObrigatório

Momento da atualização mais recente.

Texto:format: "date-time"

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

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controle de concorrência.

Exemplo: 1

Campos adicionais: Não

Obter — Devoluções, reclamações e trocas — Resposta

RequestDetailData · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

created_atTextoObrigatório

Momento da criação.

format: "date-time"

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

customerRequestCustomerData Obrigatório

Informações do cliente registradas para este recurso.

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

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. (RequestDetailData).

Exemplo: "example"

itemsLista <RequestItemData > Obrigatório

Itens incluídos no recurso.

Exemplo:

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

numberTextoObrigatório

Número do pedido ou da solicitação exibido ao usuário.

Exemplo: "example"

order_idTextoObrigatório

Identificador do pedido relacionado.

Exemplo: "example"

order_numberTextoObrigatório

Número do pedido relacionado.

Exemplo: "example"

products_valueMoneyData Obrigatório

Valor dos produtos do pedido.

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

refundRefundData Obrigatório

Informações de reembolso registradas.

Exemplo:

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

resolution_stateTextoObrigatório

Estado de resolução de uma solicitação do cliente.

Restrições

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

Exemplo: "unknown"

statusRequestStatusData Obrigatório

Estado aceito por esta operação específica.

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

typeRequestType Obrigatório

Tipo de recurso.

Exemplo: "return"

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

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

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controle de concorrência.

Exemplo: 1

Campos adicionais: Não

Obter — Devoluções, reclamações e trocas — Resposta

RequestItemData · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (RequestItemData).

Exemplo: "example"
nameTextoObrigatório: Nome do recurso no contexto correspondente.

Exemplo: "Example"
order_line_idTexto nullObrigatório: Identificador da linha do pedido relacionada.

Exemplo: "example"
product_idTextoObrigatório: Identificador do produto.

Exemplo: "example"
quantityNúmero inteiroObrigatório: Número de unidades.

Exemplo: 1
returned_quantityNúmero inteiroObrigatório: Quantidade devolvida desta linha.

Exemplo: 1
skuTextoObrigatório: Código da unidade de manutenção de estoque.

Exemplo: "example"
totalMoneyData Obrigatório: Valor total.

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obrigatório: Preço por unidade.

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idTexto nullObrigatório: Identificador da variante do produto.

Exemplo: "example"
variant_optionsLista <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obrigatório: Opções de variante associadas ao produto ou aos dados preservados.

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

Campos adicionais: Não

Estado aceito por esta operação específica

RequestStatusData · Esquema · Esquemas de dados: Devoluções, reclamações e trocas

idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (RequestStatusData).

Exemplo: "example"
localeTextoObrigatório: Idioma selecionado para esta requisição.

Exemplo: "en"
nameTexto nullObrigatório: Nome do recurso no contexto correspondente.

Exemplo: "Example"

Campos adicionais: Não

Listar · Status disponíveis — Devoluções, reclamações e trocas — Resposta

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

codeTextoObrigatório: Código estável legível por programas.

Exemplo: "example"
created_atTextoObrigatório: Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Exemplo: "example"
is_initialBooleanoObrigatório: Indica se este é o estado inicial.

Exemplo: false
localeTextoObrigatório: Idioma selecionado para esta requisição.

Exemplo: "en"
nameTexto nullObrigatório: Nome do recurso no contexto correspondente.

Exemplo: "Example"
positionNúmero inteiroObrigatório: Posição na coleção ordenada.

Exemplo: 1
typeRequestType Obrigatório: Tipo de recurso.

Exemplo: "return"

Campos adicionais: Não

Listar · Status disponíveis — Devoluções, reclamações e trocas — Resposta

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

dataLista <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obrigatório: Exemplo de resposta · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Exemplo: [{"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 Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

Atualizar · Status — Devoluções, reclamações e trocas — Corpo da requisição

RequestStatusUpdate · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

status_idTextoObrigatório

Identificador obtido do catálogo de estados correspondente.

Restrições

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

Exemplo: "example"

Campos adicionais: Não

Listar — Devoluções, reclamações e trocas — Resposta

RequestSummaryData · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

created_atTextoObrigatório

Momento da criação.

format: "date-time"

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

customerRequestCustomerData Obrigatório

Informações do cliente registradas para este recurso.

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

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. (RequestSummaryData).

Exemplo: "example"

numberTextoObrigatório

Número do pedido ou da solicitação exibido ao usuário.

Exemplo: "example"

order_idTextoObrigatório

Identificador do pedido relacionado.

Exemplo: "example"

order_numberTextoObrigatório

Número do pedido relacionado.

Exemplo: "example"

products_valueMoneyData Obrigatório

Valor dos produtos do pedido.

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

refundRefundData Obrigatório

Informações de reembolso registradas.

Exemplo:

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

resolution_stateTextoObrigatório

Estado de resolução de uma solicitação do cliente.

Restrições

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

Exemplo: "unknown"

statusRequestStatusData Obrigatório

Estado aceito por esta operação específica.

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

typeRequestType Obrigatório

Tipo de recurso.

Exemplo: "return"

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

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

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controle de concorrência.

Exemplo: 1

Campos adicionais: Não

Tipo de recurso

RequestType · Esquema · Esquemas de dados: Devoluções, reclamações e trocas

Texto

Restrições

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

Campos adicionais: Sim

Opções de variante associadas ao produto ou aos dados preservados

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Esquema · Esquemas de dados: Devoluções, reclamações e trocas

nameTextoObrigatório: Nome do recurso no contexto correspondente.

Exemplo: "Example"
valueTextoObrigatório: Valor definido pelo esquema que o contém.

Exemplo: "example"

Campos adicionais: Não