Skip to content

Cadastro de regras de segmentação

POST /common/segmentation/{segmentationId}/rules

Cadastro de regras de segmentação

Descrição

Este endpoint é responsável por cadastrar regras de segmentação. As regras devem ser definidas no corpo da requisição, informando, dentro de cada objeto, o tipo de regra, o operador e o valor que será utilizado para validação.

A segmentação à qual as regras serão associadas deve ser identificada pelo ID informado na URL. Este endpoint não permite a atualização de regras já cadastradas, sendo destinado exclusivamente ao cadastro de novas regras de segmentação.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação

Parâmetros da URL

ParâmetroTipoObrigatórioDescrição
segmentationIdintegerSimID único da segmentação

Parâmetros do Corpo

ParâmetroTipoObrigatórioDescrição
rulesarrayObrigatório em cenários de cadastroLista de regras que devem ser criadas.
rules.*.ruleTypestring✅Determina o tipo da regra (product-id, category-id, customer-id, total-quantity, total-value, zip-code, customer-age)
rules.*.ruleOperatorstring✅Operador lógico da regra (less, equal, greater, in, not-in, contains, between)
rules.*.rulevalueinteger - decimal - string✅Valor que a regra deve conter (contém mais de uma tipagem)

Exemplo de Requisição

1curl --request POST \
2  --url https://sua-loja-uappi.com.br/api/v3/common/segmentation/{segmentationId}/rules \
3  --header "Authorization: Bearer userToken" \
4  --data '{
5    "rules": [
6      {
7        "ruleType": "product-id",
8        "ruleOperator": "equal",
9        "ruleValue": 10
10      }
11    ]
12  }'
13  '

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "id": 1,
3  "operator": "and",
4  "sellerId": null,
5  "userForAllSellers": false,
6  "rules": [
7    {
8      "id": 1,
9      "ruleType": "category-id",
10      "ruleOperator": "in",
11      "ruleValue": [1, 2, 3, 4, 5, 6, 8, 9],
12      "entityMap": {
13        "1": "Eletrônicos",
14        "2": "Informática",
15        "3": "Celulares",
16        "4": "Games",
17        "5": "Áudio",
18        "6": "TV",
19        "8": "Fotografia",
20        "9": "Wearables"
21      },
22      "createdAt": "2024-08-21 00:00:00",
23      "updatedAt": "2025-09-01 13:11:44"
24    },
25    {
26      "id": 101,
27      "ruleType": "product-id",
28      "ruleOperator": "equal",
29      "ruleValue": 10,
30      "entityMap": {
31        "10": "Produto Exemplo"
32      },
33      "createdAt": "2026-02-04 16:57:27",
34      "updatedAt": "2026-02-04 16:57:27"
35    }
36  ]
37}

⚠️ 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.

1{
2  "status": false,
3  "data": {
4    "code": 404,
5    "errorCode": "UAPPI_STORE_SEGMENTATION_NOT_FOUND",
6    "message": "The requested segmentation was not found."
7  }
8}

Atualização de regras de segmentação em massa

POST /common/segmentation/rules

Atualização de regras de segmentação em massa

Descrição

Este endpoint é responsável por atualizar regras de segmentação. No corpo da requisição, devem ser informados o identificador da regra, o tipo de regra atualizado, além do novo operador e do novo valor que deverão ser aplicados.

A atualização pode ser realizada em massa, sendo necessário informar cada regra em um nó separado dentro da requisição, o que permite atualizar múltiplas regras de forma organizada.

Caso a atualização seja realizada com sucesso e não ocorra nenhum erro, o JSON retornado pela API conterá as mesmas informações enviadas no corpo da requisição, refletindo os dados preenchidos pelo usuário.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {token}Token de autenticação

Parâmetros do Corpo

ParâmetroTipoObrigatórioDescrição
rulesarray✅Lista de regras de segmentação a serem atualizadas
rules.*.idstring✅Identificador da regra que deve ser atualizada (max 255 caracteres)
rules.*.ruleTypestring✅Tipo da regra que deve ser atualizada (product-id, category-id, customer-id, total-quantity, total-value, zip-code, customer-age)
rules.*.ruleOperatorstring✅Operador lógico da regra (less, equal, greater, in, not-in, contains, between)
rules.*.rulevalueinteger - decimal - string✅Valor que a regra deve conter (contém mais de uma tipagem)

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/common/segmentation/rules \
3  --header "Authorization: Bearer userToken" \
4  --data '{
5    "rules": [
6      {
7        "id": 1,
8        "ruleType": "category-id",
9        "ruleOperator": "different",
10        "ruleValue": 100
11      },
12    ]
13  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3	"data": [
4    {
5      "id": 1,
6      "ruleType": "category-id",
7      "ruleOperator": "different",
8      "ruleValue": 2077,
9      "createdAt": "2025-09-18 18:16:31",
10      "updatedAt": "2026-02-10 17:12:10"
11    }
12  ]
13}

Excluir segmentação

DELETE /common/segmentation/rules

Exclusão de regras de segmentações.

Descrição

Este endpoint é responsável por excluir regras de segmentação previamente cadastradas. Ao realizar a exclusão, a regra segmentação identificada pelo seu ID terá seu cadastro excluida, tornando-se indisponível para consultas ou atualizações futuras.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {token}Token de autenticação

Parâmetros do Corpo

ParâmetroTipoObrigatórioDescrição
idsarray✅id da regra (min 1 caracter)
ids.*integer✅id da regra (min 1 caracter)

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/common/segmentation/{segmentationId}\
3  --header "Authorization: Bearer userToken" \
4  --data '{
5    "ids": [
6      1, 2, 3
7    ]
8  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3	"data": true
4}

Uappi é a melhor opção para o crescimento da sua loja!

Institucional

;