Cadastro de Colunas de Estrutura do Datalogic

POST /tools/datalogic/storage/struct/{datalogicStructureId}/column

Cria novas colunas em uma estrutura de armazenamento do Datalogic

Descrição

Endpoint responsável por criar uma ou mais colunas em uma estrutura de armazenamento já existente 🧱.

As colunas informadas são adicionadas diretamente na tabela física vinculada à estrutura, além de serem registradas nos metadados da estrutura.

O nome de cada coluna deve seguir o padrão snake_case e não pode coincidir com os nomes reservados de controle (id, created_at, updated_at).

O tipo da coluna determina o tipo físico criado no banco de dados.

Os tipos decimal e short-text exigem o campo length, e o tipo decimal exige também decimalPlaces.

Não é possível cadastrar uma coluna com um nome já utilizado por outra coluna da mesma estrutura.

🔐 Permissão

DATALOGIC_STRUCT_READ — Escopo de permissão para leitura das estruturas do Datalogic.
DATALOGIC_STRUCT_WRITE — Escopo de permissão para escrita das estruturas do Datalogic.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {userToken}	Token de autenticação

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
datalogicStructureId	integer	Sim	Identificador da estrutura onde as colunas serão criadas

Parâmetros do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
`columns`	array	✅	Lista de colunas a serem criadas (mínimo 1 item e máximo 100).
`columns.*.name`	string	✅	Nome da coluna em snake_case, iniciando com letra minúscula.
`columns.*.type`	string	✅	Tipo da coluna. Valores aceitos: `text`, `short-text`, `integer`, `decimal`, `date`, `datetime`, `boolean`.
`columns.*.length`	integer	❌	Tamanho da coluna. Obrigatório quando `type` for `decimal` ou `short-text`.
`columns.*.decimalPlaces`	integer	❌	Quantidade de casas decimais. Obrigatório quando `type` for `decimal`.

Exemplo de Requisição

1curl --request POST \
2  --url https://sua-loja-uappi.com.br/api/v3/tools/datalogic/storage/struct/{datalogicStructureId}/column \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "columns": [
6      {
7        "name": "full_name",
8        "type": "short-text",
9        "length": 150
10      },
11      {
12        "name": "total_amount",
13        "type": "decimal",
14        "length": 10,
15        "decimalPlaces": 2
16      }
17    ]
18  }'
curl --request POST \
  --url https://sua-loja-uappi.com.br/api/v3/tools/datalogic/storage/struct/{datalogicStructureId}/column \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --data '{
    "columns": [
      {
        "name": "full_name",
        "type": "short-text",
        "length": 150
      },
      {
        "name": "total_amount",
        "type": "decimal",
        "length": 10,
        "decimalPlaces": 2
      }
    ]
  }'

✅ Resposta de Sucesso

HTTP Status: 201 Created

1{
2  "status": true,
3  "data": {
4    "id": 1,
5    "name": "Clientes VIP",
6    "description": "Cadastro auxiliar de clientes VIP",
7    "publicRead": false,
8    "tableName": "clientes_vip_a1b2c3d4",
9    "columns": [
10      {
11        "name": "full_name",
12        "type": "short-text",
13        "length": 150,
14        "decimalPlaces": null,
15        "createdAt": "2026-07-14 10:00:00"
16      },
17      {
18        "name": "total_amount",
19        "type": "decimal",
20        "length": 10,
21        "decimalPlaces": 2,
22        "createdAt": "2026-07-14 10:00:00"
23      }
24    ],
25    "indexes": [],
26    "createdAt": "2026-07-10 09:00:00",
27    "updatedAt": "2026-07-14 10:00:00"
28  }
29}
{
  "status": true,
  "data": {
    "id": 1,
    "name": "Clientes VIP",
    "description": "Cadastro auxiliar de clientes VIP",
    "publicRead": false,
    "tableName": "clientes_vip_a1b2c3d4",
    "columns": [
      {
        "name": "full_name",
        "type": "short-text",
        "length": 150,
        "decimalPlaces": null,
        "createdAt": "2026-07-14 10:00:00"
      },
      {
        "name": "total_amount",
        "type": "decimal",
        "length": 10,
        "decimalPlaces": 2,
        "createdAt": "2026-07-14 10:00:00"
      }
    ],
    "indexes": [],
    "createdAt": "2026-07-10 09:00:00",
    "updatedAt": "2026-07-14 10:00:00"
  }
}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Código Interno	Código Http	Descrição
UAPPI_TOOLS_DATALOGIC_STRUCTURE_NOT_FOUND	404	A estrutura solicitada não foi encontrada.
UAPPI_TOOLS_DATALOGIC_COLUMN_DUPLICATED	409	Já existe uma coluna com o nome solicitado nesta estrutura.

Atualização de Colunas de Estrutura do Datalogic

PUT /tools/datalogic/storage/struct/{datalogicStructureId}/column

Renomeia colunas de uma estrutura de armazenamento do Datalogic

Descrição

Endpoint responsável por renomear uma ou mais colunas de uma estrutura de armazenamento já existente ✏️.

Esta rota apenas renomeia colunas; tipo, tamanho e casas decimais permanecem inalterados após a atualização.

O nome atual informado precisa existir na estrutura.

O novo nome não pode coincidir com o de outra coluna já cadastrada nem com os nomes reservados de controle (id, created_at, updated_at).

Assim como no cadastro, os nomes de coluna devem seguir o padrão snake_case, iniciando com letra minúscula.

🔐 Permissão

DATALOGIC_STRUCT_READ — Escopo de permissão para leitura das estruturas do Datalogic.
DATALOGIC_STRUCT_WRITE — Escopo de permissão para escrita das estruturas do Datalogic.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {userToken}	Token de autenticação

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
datalogicStructureId	integer	Sim	Identificador da estrutura onde as colunas serão renomeadas

Parâmetros do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
`columns`	array	✅	Lista de renomeações a serem aplicadas (mínimo 1 item e máximo 100)
`columns.*.currentName`	string	✅	Nome atual da coluna em snake_case
`columns.*.newName`	string	✅	Novo nome da coluna em snake_case

Exemplo de Requisição

1curl --request PUT \
2  --url {{MAIN_URL}}/tools/datalogic/storage/struct/{datalogicStructureId}/column \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "columns": [
6      {
7        "currentName": "full_name",
8        "newName": "customer_name"
9      }
10    ]
11  }'
curl --request PUT \
  --url {{MAIN_URL}}/tools/datalogic/storage/struct/{datalogicStructureId}/column \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --data '{
    "columns": [
      {
        "currentName": "full_name",
        "newName": "customer_name"
      }
    ]
  }'

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": {
4    "id": 1,
5    "name": "Clientes VIP",
6    "description": "Cadastro auxiliar de clientes VIP",
7    "publicRead": false,
8    "tableName": "clientes_vip_a1b2c3d4",
9    "columns": [
10      {
11        "name": "customer_name",
12        "type": "short-text",
13        "length": 150,
14        "decimalPlaces": null,
15        "createdAt": "2026-07-14 10:00:00"
16      },
17      {
18        "name": "total_amount",
19        "type": "decimal",
20        "length": 10,
21        "decimalPlaces": 2,
22        "createdAt": "2026-07-14 10:00:00"
23      }
24    ],
25    "indexes": [],
26    "createdAt": "2026-07-10 09:00:00",
27    "updatedAt": "2026-07-14 11:00:00"
28  }
29}
{
  "status": true,
  "data": {
    "id": 1,
    "name": "Clientes VIP",
    "description": "Cadastro auxiliar de clientes VIP",
    "publicRead": false,
    "tableName": "clientes_vip_a1b2c3d4",
    "columns": [
      {
        "name": "customer_name",
        "type": "short-text",
        "length": 150,
        "decimalPlaces": null,
        "createdAt": "2026-07-14 10:00:00"
      },
      {
        "name": "total_amount",
        "type": "decimal",
        "length": 10,
        "decimalPlaces": 2,
        "createdAt": "2026-07-14 10:00:00"
      }
    ],
    "indexes": [],
    "createdAt": "2026-07-10 09:00:00",
    "updatedAt": "2026-07-14 11:00:00"
  }
}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Código Interno	Código Http	Descrição
UAPPI_TOOLS_DATALOGIC_STRUCTURE_NOT_FOUND	404	A estrutura solicitada não foi encontrada.
UAPPI_TOOLS_DATALOGIC_COLUMN_NOT_FOUND	404	A coluna informada em `currentName` não foi encontrada na estrutura.
UAPPI_TOOLS_DATALOGIC_COLUMN_DUPLICATED	409	Já existe uma coluna com o nome solicitado em `newName` nesta estrutura.

Remoção de Colunas de Estrutura do Datalogic

DELETE /tools/datalogic/storage/struct/{datalogicStructureId}/column

Remove colunas de uma estrutura de armazenamento do Datalogic

Descrição

Endpoint responsável por remover uma ou mais colunas de uma estrutura de armazenamento já existente 🗑️.

As colunas informadas são removidas tanto da tabela física vinculada à estrutura quanto dos metadados da estrutura.

Caso alguma das colunas informadas componha um índice já cadastrado, essa coluna também é removida da definição do índice.

Quando a remoção de uma coluna faz com que um índice fique sem nenhuma coluna restante, esse índice é removido junto com a coluna.

Todos os nomes de coluna informados precisam existir na estrutura; caso algum não seja encontrado, a remoção inteira é rejeitada.

🔐 Permissão

DATALOGIC_STRUCT_READ — Escopo de permissão para leitura das estruturas do Datalogic.
DATALOGIC_STRUCT_WRITE — Escopo de permissão para escrita das estruturas do Datalogic.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {userToken}	Token de autenticação

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
datalogicStructureId	integer	Sim	Identificador da estrutura onde as colunas serão removidas

Parâmetros do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
`columns`	array	✅	Lista com os nomes das colunas a serem removidas (mínimo 1 item e máximo 100)
`columns.*`	string	✅	Nome da coluna em snake_case a ser removida

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/tools/datalogic/storage/struct/{datalogicStructureId}/column \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "columns": [
6      "total_amount"
7    ]
8  }'
curl --request DELETE \
  --url {{MAIN_URL}}/tools/datalogic/storage/struct/{datalogicStructureId}/column \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --data '{
    "columns": [
      "total_amount"
    ]
  }'

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": {
4    "id": 1,
5    "name": "Clientes VIP",
6    "description": "Cadastro auxiliar de clientes VIP",
7    "publicRead": false,
8    "tableName": "clientes_vip_a1b2c3d4",
9    "columns": [
10      {
11        "name": "customer_name",
12        "type": "short-text",
13        "length": 150,
14        "decimalPlaces": null,
15        "createdAt": "2026-07-14 10:00:00"
16      }
17    ],
18    "indexes": [],
19    "createdAt": "2026-07-10 09:00:00",
20    "updatedAt": "2026-07-14 12:00:00"
21  }
22}
{
  "status": true,
  "data": {
    "id": 1,
    "name": "Clientes VIP",
    "description": "Cadastro auxiliar de clientes VIP",
    "publicRead": false,
    "tableName": "clientes_vip_a1b2c3d4",
    "columns": [
      {
        "name": "customer_name",
        "type": "short-text",
        "length": 150,
        "decimalPlaces": null,
        "createdAt": "2026-07-14 10:00:00"
      }
    ],
    "indexes": [],
    "createdAt": "2026-07-10 09:00:00",
    "updatedAt": "2026-07-14 12:00:00"
  }
}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Código Interno	Código Http	Descrição
UAPPI_TOOLS_DATALOGIC_STRUCTURE_NOT_FOUND	404	A estrutura solicitada não foi encontrada.
UAPPI_TOOLS_DATALOGIC_COLUMN_NOT_FOUND	404	Uma ou mais colunas informadas não foram encontradas na estrutura.

Começando

Store Theme

Customização de Interface

Consumo de Dados

Tracking e SEO

Checkout

Consumo de Dados

Tracking e SEO

Ambiente de Pagamento

Área Restrita (Minha Conta)

Consumo de Dados

Tracking e SEO

SDK Público (public-sdk)

Modules

Api

Tracking

API Pública

Área Restrita (Minha Conta)

Carrinho de Compras

API Privada

Apps

Configurações Gerais

Clientes

Template

Avaliações

Notificações

ERPs

Filas

Grupo de Pedidos

Pedidos

Carrinhos

Pagamentos

Anti-Fraude

Produtos

Inteligência Artificial

Marcas

Categorias

Filtros

Atributos

Url

Relatórios

Render

Fretes

Usuários

Promocionais

Marketplace

Third Party

Datalogic

Busca

MCP

Cadastro de Colunas de Estrutura do Datalogic

Descrição

🔐 Permissão

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Atualização de Colunas de Estrutura do Datalogic

Descrição

🔐 Permissão

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Remoção de Colunas de Estrutura do Datalogic

Descrição

🔐 Permissão

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros: