Cadastro de agendamento

POST /common/scheduling

Descrição

Este endpoint é responsável por cadastrar agendamentos, que são definidos pelo tipo de entidade, pelo identificador da entidade e pelas datas de início e término informadas na API. Os tipos de entidades que podem ser agendadas incluem baners, configurações de selos, promocionais, regra de preço e regra do sistema de pontos, permitindo o controle de ativação dessas entidades dentro de um período específico.

Parâmetros

Headers Obrigatórios

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

Parâmetros do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
`entity`	string	✅ Qual entidade que deve receber o agendamento
`entityId`	integer	✅	Identificador da entidade que deve receber o agendamento
`startDate`	string	✅	Data inicial
`endDate`	string	❌	Data final

Tipos de Entidades aceitas

bannerItem;
sealSetting;
promotionalEntity;
priceRule;
point-system.

Exemplo de Requisição

1curl --request POST \
2  --url https://sua-loja-uappi.com.br/api/v3/common/scheduling\
3  --header "Authorization: Bearer userToken" \
4  --data '{
5    "entity": "bannerItem",
6	  "entityId": 2,
7	  "startDate": "2026-02-03 17:00:00",
8	  "endDate": "2026-10-30 23:59:59"
9  }
curl --request POST \
  --url https://sua-loja-uappi.com.br/api/v3/common/scheduling\
  --header "Authorization: Bearer userToken" \
  --data '{
    "entity": "bannerItem",
	  "entityId": 2,
	  "startDate": "2026-02-03 17:00:00",
	  "endDate": "2026-10-30 23:59:59"
  }

✅ Resposta de Sucesso

1{
2  "id": 1,
3  "startDate": "2026-02-03 17:00:00",
4  "endDate": "2026-10-30 23:59:59"
5}
{
  "id": 1,
  "startDate": "2026-02-03 17:00:00",
  "endDate": "2026-10-30 23:59:59"
}

⚠️ 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_STORE_SCHEDULING_ALREADY_CREATED	409	A entidade especificada já possuí agendamento.
UAPPI_STORE_BANNER_NOT_FOUND	404	O banner solicitado não foi encontrado.
UAPPI_STORE_SEAL_SETTING_NOT_FOUND	404	A configuração de selo solicitada não foi encontrado.
UAPPI_STORE_PROMOTIONAL_ENTITY_NOT_FOUND	404	A entidade promocional solicitada não foi encontrada.
UAPPI_STORE_PRODUCT_PRICE_RULE_NOT_FOUND	404	A regra de preço solicitada não foi encontrada.
UAPPI_STORE_POINT_SYSTEM_RULE_NOT_FOUND	404	A regra do sistema de ponto solicitada não foi encontrada.

Atualização de agendamento

PUT /common/scheduling/{schedulingId}

Atualização de agendamento

Descrição

Este endpoint é responsável por atualizar um agendamento previamente cadastrado. O ID do agendamento que será alterado deve ser informado na API, juntamente com as datas de início e término desejadas para a atualização, garantindo que o período de vigência seja ajustado corretamente.

Parâmetros

Headers Obrigatórios

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

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
schedulingId	integer	Sim	ID único do agendamento que deve ser atualizado.

Parâmetros do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
`startDate`	string	✅	Data inicial do agendamento
`endDate`	string	❌	Data final do agendamento

Exemplo de Requisição

1curl --request PUT \
2  --url {{MAIN_URL}}/common/scheduling/{schedulingId}\
3  --header "Authorization: Bearer userToken" \
4  --data '{
5	  "startDate": "2026-02-03 17:00:00",
6	  "endDate": "2026-10-30 23:59:59"
7  }
curl --request PUT \
  --url {{MAIN_URL}}/common/scheduling/{schedulingId}\
  --header "Authorization: Bearer userToken" \
  --data '{
	  "startDate": "2026-02-03 17:00:00",
	  "endDate": "2026-10-30 23:59:59"
  }

✅ Resposta de Sucesso

1{
2  "id": 1,
3  "startDate": "2026-02-03 17:00:00",
4  "endDate": "2026-10-30 23:59:59"
5}
{
  "id": 1,
  "startDate": "2026-02-03 17:00:00",
  "endDate": "2026-10-30 23:59:59"
}

⚠️ 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_SCHEDULING_NOT_FOUND",
6    "message": "O agendamento solicitado não foi encontrado."
7  }
8}
{
  "status": false,
  "data": {
    "code": 404,
    "errorCode": "UAPPI_STORE_SCHEDULING_NOT_FOUND",
    "message": "O agendamento solicitado não foi encontrado."
  }
}

Excluir avaliação de agendamento

DELETE /common/scheduling/{schedulingId}/

Exclui um agendamento cadastrado.

Descrição

Este endpoint é responsável por excluir um agendamento previamente cadastrado. Após a exclusão, o agendamento identificado pelo seu ID não estará mais disponível para consulta ou atualização na API.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Authorization`	Bearer {token}	Token de autenticação

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
schedulingId	integer	Sim	ID único do agendamento que deve ser removido.

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/common/scheduling/{schedulingId}\
3  --header "Authorization: Bearer userToken" \
curl --request DELETE \
  --url {{MAIN_URL}}/common/scheduling/{schedulingId}\
  --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

HTTP Status: 200 OK

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

⚠️ 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_SCHEDULING_NOT_FOUND",
6    "message": "The requested scheduling was not found."
7  }
8}
{
  "status": false,
  "data": {
    "code": 404,
    "errorCode": "UAPPI_STORE_SCHEDULING_NOT_FOUND",
    "message": "The requested scheduling was not found."
  }
}

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 agendamento

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros do Corpo

Tipos de Entidades aceitas

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Atualização de agendamento

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Excluir avaliação de agendamento

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Nesta página

Institucional