Pular para o conteúdo principal

Desconto

Criação de Desconto Diário​

Este endpoint é utilizado para criar regras de desconto por dia da semana (Daily Sale) e vinculá-las a uma Categoria, Tamanho, ou Item específico.

POST
/menu/{store_id}/daily-sale

Payload Criação de Desconto Diário
{
  "parent_type": "size",
  "parent_id": "4519951",
  "start": "2025-12-10",
  "end": "2025-12-11",
  "daily_weekday_sale": [
    {
      "weekday_code": 0,
      "discount": 5,
      "discount_type": 0
    },
    {
      "weekday_code": 1,
      "discount": 5,
      "discount_type": 0
    },
    {
      "weekday_code": 2,
      "discount": 5,
      "discount_type": 0
    },
    {
      "weekday_code": 3,
      "discount": 5,
      "discount_type": 0
    },
    {
      "weekday_code": 4,
      "discount": 5,
      "discount_type": 0
    }
  ]
}
Detalhamento do Payload

O payload exige a definição da entidade onde o desconto será aplicado (parent_type e parent_id), a vigência da promoção (start/end) e as regras de desconto por dia da semana (daily_weekday_sale).


CampoObrigatórioDescrição
parent_type✅O nível da hierarquia onde o desconto será aplicado. Valores: "category", "size", ou "item", “item_size"
parent_id✅ID da Entidade escolhida no parent_type (ID da Categoria, ID do Tamanho, Tamanho do Item ou UUID do Item).
start✅Data de início da vigência da promoção (Formato: YYYY-MM-DD).
end✅Data de fim da vigência da promoção (Formato: YYYY-MM-DD).
daily_weekday_sale❌Array de objetos que define o desconto por dia da semana.

Detalhamento da Regra de Desconto (daily_weekday_sale[])​

Este objeto define o valor e o tipo de desconto aplicado a um dia específico da semana.


CampoObrigatórioDescrição
weekday_code✅Código do dia da semana. Valores: 0 (Segunda) a 6 (Domingo).
discount✅Valor do desconto. O significado depende do discount_type.
discount_type✅Tipo de desconto a ser aplicado. Valores: 0 (Valor Fixo em Reais, Ex: 10.00) ou 1 (Porcentagem, Ex: 10).

Atualização de Desconto Diário​

Este endpoint permite atualizar as regras de uma promoção existente, definindo o período de vigência e os descontos específicos para cada dia da semana. É uma solução unificada para gerenciar campanhas de descontos recorrentes.

PUT
/menu/{store_id}/daily-sale/{id}

PATCH
/menu/{store_id}/daily-sale/{id}

Payload Atualização de Desconto Diário
{
  "start": "2025-12-20",
  "end": "2025-12-25",
  "daily_weekday_sale": [
    {
      "weekday_code": 0,
      "discount": 50,
      "discount_type": 1
    },
    {
      "weekday_code": 1,
      "discount": 50,
      "discount_type": 1
    },
    {
      "weekday_code": 2,
      "discount": 50,
      "discount_type": 1
    },
    {
      "weekday_code": 3,
      "discount": 50,
      "discount_type": 1
    },
    {
      "weekday_code": 4,
      "discount": 50,
      "discount_type": 1
    }
  ]
}
Detalhamento do Payload

O objeto principal define o intervalo de datas e uma lista de configurações por dia da semana.


CampoDescrição
startData de início da promoção (Formato: YYYY-MM-DD).
endData de término da promoção (Formato: YYYY-MM-DD).
daily_weekday_saleArray contendo as regras de desconto para cada dia da semana.

Detalhamento da Regra de Desconto (daily_weekday_sale[])​

Este objeto define o valor e o tipo de desconto aplicado a um dia específico da semana.


CampoObrigatórioDescrição
weekday_code✅Código do dia da semana. Valores: 0 (Segunda) a 6 (Domingo).
discount✅Valor do desconto. O significado depende do discount_type.
discount_type✅Tipo de desconto a ser aplicado. Valores: 0 (Valor Fixo em Reais, Ex: 10.00) ou 1 (Porcentagem, Ex: 10).

Listagem de Descontos Diários​

Este endpoint retorna todos os descontos configurados para uma loja específica. É útil para identificar promoções ativas e obter os IDs necessários para atualizações via PUT/PATCH.

GET
/menu/{store_id}/daily-sales

Payload Listagem de Descontos Diários
{
  "data": [
    {
      "id": 168022,
      "menu_category_id": 930103,
      "size_id": null,
      "item_uuid": null,
      "item_size_id": null,
      "start": "2025-12-09",
      "end": "2025-12-12"
    },
    {
      "id": 168023,
      "menu_category_id": null,
      "size_id": 4519950,
      "item_uuid": null,
      "item_size_id": null,
      "start": "2025-12-10",
      "end": "2025-12-11"
    },
    {
      "id": 168024,
      "menu_category_id": null,
      "size_id": 4519951,
      "item_uuid": null,
      "item_size_id": null,
      "start": "2025-12-10",
      "end": "2025-12-11"
    },
    {
      "id": 168025,
      "menu_category_id": null,
      "size_id": 4519952,
      "item_uuid": null,
      "item_size_id": null,
      "start": "2025-12-25",
      "end": "2025-12-31"
    },
    {
      "id": 168026,
      "menu_category_id": null,
      "size_id": null,
      "item_uuid": "39536367-4042-329b-8e57-c4c4ccc8f9a4",
      "item_size_id": null,
      "start": "2025-12-25",
      "end": "2025-12-31"
    },
    {
      "id": 168027,
      "menu_category_id": null,
      "size_id": null,
      "item_uuid": null,
      "item_size_id": 37727028,
      "start": "2025-12-25",
      "end": "2025-12-31"
    }
  ]
}
Resposta de Sucesso (Status Code 200)

O retorno é paginado e contém a lista de promoções no campo data.


CampoDescrição
idID único da promoção de desconto diário.
menu_category_idID da categoria do cardápio vinculada ao desconto (se houver).
size_idID do tamanho específico vinculado ao desconto (se houver).
item_uuidUUID do item vinculado ao desconto (se houver).
item_size_idID do tamanho do item vinculado ao desconto (se houver).
startData de início da vigência da promoção (YYYY-MM-DD).
endData de término da vigência da promoção (YYYY-MM-DD).

Detalhamento de Desconto​

Este endpoint retorna os detalhes completos de uma configuração de desconto específica, incluindo a vigência e o detalhamento de valores por dia da semana.

GET
/menu/{store_id}/daily-sales/{id}

Payload Detalhamento de Desconto Diário
{
  "data": {
    "id": 168027,
    "menu_category_id": null,
    "size_id": null,
    "item_uuid": null,
    "item_size_id": 37727028,
    "start": "2025-12-25",
    "end": "2025-12-31",
    "daily_weekday_sale": [
      {
        "weekday_code": 0,
        "weekday_name": "segunda",
        "discount": "5.00",
        "discount_type": 0
      },
      {
        "weekday_code": 1,
        "weekday_name": "terca",
        "discount": "5.00",
        "discount_type": 0
      },
      {
        "weekday_code": 2,
        "weekday_name": "quarta",
        "discount": "5.00",
        "discount_type": 0
      },
      {
        "weekday_code": 3,
        "weekday_name": "quinta",
        "discount": "5.00",
        "discount_type": 0
      },
      {
        "weekday_code": 4,
        "weekday_name": "sexta",
        "discount": "5.00",
        "discount_type": 0
      },
      {
        "weekday_code": 5,
        "weekday_name": "sabado",
        "discount": "0.00",
        "discount_type": 1
      },
      {
        "weekday_code": 6,
        "weekday_name": "domingo",
        "discount": "0.00",
        "discount_type": 1
      }
    ]
  }
}
Resposta de Sucesso (Status Code 200)

1. Cabeçalho da Promoção (data)​

O retorno consiste em um objeto data contendo o cabeçalho da promoção e o array de regras diárias.


CampoDescrição
idID único da promoção.
menu_category_idID da categoria vinculada (se aplicável).
size_idID do tamanho vinculado (se aplicável).
item_uuidUUID do item vinculado (se aplicável).
item_size_idID da variação de tamanho do item vinculada.
startData de início da vigência (YYYY-MM-DD).
endData de término da vigência (YYYY-MM-DD).
daily_weekday_saleArray com as regras de desconto por dia da semana.

2. Regras por Dia da Semana (daily_weekday_sale[])​


CampoDescrição
weekday_codeCódigo numérico do dia (0 = Segunda, 1 = Terça, ..., 6 = Domingo).
weekday_nameNome por extenso do dia da semana.
discountValor do desconto configurado.
discount_typeTipo do desconto (ex: 0 para valor fixo, 1 para porcentagem).

aiqfome

Visite o site
Termos e condições Política de privacidade

© Copyright 2007-2026 aiqfome LTDA .