API atual/Referência completa/Lista de desejos e dados do cliente

Dados do cliente

Lê, grava e apaga um JSON livre guardado na conta do cliente logado, sob um nome escolhido por você.

Um espaço privado por cliente para o que o seu app quiser lembrar: tema, filtros salvos, últimos termos buscados. Cada entrada é identificada por type (um nome seu, como preferencias) e guarda um JSON qualquer. Gravar de novo no mesmo type substitui o conteúdo.

Os dados são lidos e gravados só pelo próprio cliente. A plataforma não interpreta o conteúdo.

Ler

GET/api/v1/storefront/data/{type}Cliente

Lê uma entrada de dados do cliente

Parâmetros de caminho

typestringobrigatório

Nome da entrada, escolhido por você. Não pode ser vazio.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/data/preferencias" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Entrada encontrada

json

{"id":"8a057ef6-1597-4046-b893-aad1c1c18804","user_id":"d4613dde-ac7a-431c-9232-50d8cd6ad5fc","data_type":"preferencias","data":{"tema":"escuro","itens_por_pagina":24},"created_at":"2026-10-11T21:05:06.813353Z","updated_at":"2026-10-11T21:05:06.813353Z"}

Entrada ainda não gravada (resposta real, status 200, não 404):

200Sem dados

json

{"data":null,"data_type":"preferencias"}

Campos da resposta

iduuid

Id da entrada. Ausente quando não há dados.

user_iduuid

Id do cliente dono. Ausente quando não há dados.

data_typestring

O type consultado.

dataany

O JSON gravado, exatamente como foi enviado. null quando não há dados.

created_atstring

Primeira gravação, RFC 3339 em UTC. Ausente quando não há dados.

updated_atstring

Última gravação, RFC 3339 em UTC. Ausente quando não há dados.

Gravar

PUT/api/v1/storefront/data/{type}Cliente

Grava ou substitui uma entrada de dados do cliente

Com chave de API, ela precisa do escopo customer:write.

Parâmetros de caminho

typestringobrigatório

Nome da entrada.

Corpo da requisição

dataanyobrigatório

Qualquer valor JSON válido (objeto, lista, texto, número). Ausente ou vazio responde 400.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/storefront/data/preferencias" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"data": {"tema": "escuro", "itens_por_pagina": 24}}'

Resposta

200Gravado

json

{"message": "data saved"}

Apagar

DELETE/api/v1/storefront/data/{type}Cliente

Apaga uma entrada de dados do cliente

Parâmetros de caminho

typestringobrigatório

Nome da entrada.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/storefront/data/preferencias" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Apagado

json

{"message": "data deleted"}

Erros

Status	Quando	Corpo de exemplo
400	`PUT` com corpo inválido ou sem `data`.	`{"error":"data is required"}`
400	`DELETE` de um `type` que não existe para o cliente.	`{"error":"additional data preferencias not found for user d4613dde-ac7a-431c-9232-50d8cd6ad5fc"}`
401	Sem token.	`{"error":"missing authorization header"}`
403	Chave de API sem o escopo `customer:read` (GET) ou `customer:write` (PUT, DELETE).	`{"error":"missing_scope"}`

Veja também

API atual/Referência completa/Lista de desejos e dados do cliente

Dados do cliente

Lê, grava e apaga um JSON livre guardado na conta do cliente logado, sob um nome escolhido por você.

Os dados são lidos e gravados só pelo próprio cliente. A plataforma não interpreta o conteúdo.

Ler

GET/api/v1/storefront/data/{type}Cliente

Lê uma entrada de dados do cliente

Parâmetros de caminho

typestringobrigatório

Nome da entrada, escolhido por você. Não pode ser vazio.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/data/preferencias" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Entrada encontrada

json

{"id":"8a057ef6-1597-4046-b893-aad1c1c18804","user_id":"d4613dde-ac7a-431c-9232-50d8cd6ad5fc","data_type":"preferencias","data":{"tema":"escuro","itens_por_pagina":24},"created_at":"2026-10-11T21:05:06.813353Z","updated_at":"2026-10-11T21:05:06.813353Z"}

Entrada ainda não gravada (resposta real, status 200, não 404):

200Sem dados

json

{"data":null,"data_type":"preferencias"}

Campos da resposta

iduuid

Id da entrada. Ausente quando não há dados.

user_iduuid

Id do cliente dono. Ausente quando não há dados.

data_typestring

O type consultado.

dataany

O JSON gravado, exatamente como foi enviado. null quando não há dados.

created_atstring

Primeira gravação, RFC 3339 em UTC. Ausente quando não há dados.

updated_atstring

Última gravação, RFC 3339 em UTC. Ausente quando não há dados.

Gravar

PUT/api/v1/storefront/data/{type}Cliente

Grava ou substitui uma entrada de dados do cliente

Com chave de API, ela precisa do escopo customer:write.

Parâmetros de caminho

typestringobrigatório

Nome da entrada.

Corpo da requisição

dataanyobrigatório

Qualquer valor JSON válido (objeto, lista, texto, número). Ausente ou vazio responde 400.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/storefront/data/preferencias" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"data": {"tema": "escuro", "itens_por_pagina": 24}}'

Resposta

200Gravado

json

{"message": "data saved"}

Apagar

DELETE/api/v1/storefront/data/{type}Cliente

Apaga uma entrada de dados do cliente

Parâmetros de caminho

typestringobrigatório

Nome da entrada.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/storefront/data/preferencias" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Apagado

json

{"message": "data deleted"}

Erros

Status	Quando	Corpo de exemplo
400	`PUT` com corpo inválido ou sem `data`.	`{"error":"data is required"}`
400	`DELETE` de um `type` que não existe para o cliente.	`{"error":"additional data preferencias not found for user d4613dde-ac7a-431c-9232-50d8cd6ad5fc"}`
401	Sem token.	`{"error":"missing authorization header"}`
403	Chave de API sem o escopo `customer:read` (GET) ou `customer:write` (PUT, DELETE).	`{"error":"missing_scope"}`