Criação de Promoções

Envio dos dados

{
    "aggregationTag": "123456",
    "promotions": [
        {
            "promotionName": "Promoção  teste",
            "channels": [
                "IFOOD-APP"
            ],
            "items": [
                {
                    "ean": "3213434343",
                    "discountValue": 22.99,
                    "initialDate": "2024-10-23",
                    "finalDate": "2024-10-30",
                    "promotionType": "FIXED",
                }
            ]
        }
    ]
}

{
    "aggregationTag": "123456",
    "promotions": [
        {
            "promotionName": "Promoção teste do tipo LXPY",
            "channels": [
                "IFOOD-APP"
            ],
            "items": [
                {
                    "ean": "3213434343",
                    "discountValue": null,
                    "initialDate": "2024-10-23",
                    "finalDate": "2024-10-30",
                    "promotionType": "LXPY",
                    "progressiveDiscount": {
                        "quantityToBuy": 3,
                        "quantityToPay": 2
                    }
                }
            ]
        }
    ]
}

{
    "aggregationTag": "123456",
    "promotions": [
        {
            "promotionName": "Promoção teste do tipo Atacarejo",
            "channels": [
                "IFOOD-APP"
            ],
            "items": [
                {
                    "ean": "3213434343",
                    "discountValue": 3,
                    "initialDate": "2024-10-23",
                    "finalDate": "2024-10-30",
                    "promotionType": "ATACAREJO",
                    "progressiveDiscount": {
                        "quantityToBuy": 6
                    }
                }
            ]
        }
    ]
}

{
    "aggregationTag": "123456",
    "promotions": [
        {
            "promotionName": "Promoção teste - 50% de desconto na 3 unidade",
            "channels": [
                "IFOOD-APP"
            ],
            "items": [
                {
                    "ean": "3213434343",
                    "discountValue": 50.0,
                    "initialDate": "2024-10-23",
                    "finalDate": "2024-10-30",
                    "promotionType": "PERCENTAGE_PER_X_UNITS",
                    "progressiveDiscount": {
                        "quantityToBuy": 3
                    }
                }
            ]
        }
    ]
}

Informações dos campos

Tipos de promoções

• Tipos de promoções (promotionType) suportados pela integração.
  • FIXED: determina o valor do desconto em R$.
  • PERCENTAGE: determina o valor do desconto do item em porcentagem.
  • FIXED_PRICE: determina o valor final do item.
  • LXPY: determina o valor de desconto dado um combo de itens.
  • ATACAREJO: aplica o valor do desconto a partir de uma quantidade X de itens.
  • PERCENTAGE_PER_X_UNITS: aplica o desconto percentual a cada x quantidade do item.
• Campos usados em conjunto
  • Para promoções do tipo: FIXED , PERCENTAGE, FIXED_PRICE deve ser enviado promotionType e o discountValue. EX:

    {
            "promotionType": "tipo da promoção",
            "discountValue": "valor do desconto ou valor do item"
    }

  • Para promoções do tipo LXPY deve ser enviado o promotionType e o progressiveDiscount (objeto completo) EX:

        {
            "promotionType": "LXPY", 
            "progressiveDiscount":{
                "quantityToBuy": 3, 
                "quantityToPay": 2
            }
        }

  • Para promoções do tipo ATACAREJO deve ser enviado o promotionType, o progressiveDiscount e o discountValue EX:

        {
            "promotionType": "ATACAREJO", 
            "discountValue": "valor final do item",
            "progressiveDiscount":{
                "quantityToBuy": 3, 
            }
        }

  • Para promoções do tipo PERCENTAGE_PER_X_UNITS deve ser enviado o promotionType, o progressiveDiscount.quantityToBuy e o discountValue EX:

        {
            "promotionType": "PERCENTAGE_PER_X_UNITS", 
            "discountValue": "valor do desconto aplicado a cada x unidades do item",
            "progressiveDiscount":{
                "quantityToBuy": 3, 
            }
        }

Exemplo de utilização:

• Em um exemplo que o item tem o valor R$ 10,00

Retorno da requisição

• Sucesso
  • HTTP status code 202
  • Response body

    {
    "aggregationId": "String",
    "message": "We have successfully received your request to create promotions"
    }

• Erro
  • Quando ocorrer algum erro ao realizar o processamento, será retornado o HTTP status code 400 ou 422

    {
    "type": "Business Exception || Unprocessable Entity",
    "title": "Business Exception || Unprocessable Entity",
    "status": 400 || 422,
    "detail": "Detail error",
    "instance": "07228dab-644c-4bec-b8a3-073397a839a0"
    }

  • Quando ocorrer algum erro em algum parâmetro ou no body, será retornado o HTTP status code 412 HTTP status code 412

    {
    "type": "Precondition Failed || Invalid Argument",
    "title": "Invalid Request Body || Invalid Argument",
    "status": 412,
    "detail": "Detail error",
    "instance": "07228dab-644c-4bec-b8a3-073397a839a0"
    }

Atualização de Promoções

• Os itens promocionais novos serão criados;
• Nada será feito em relação aos itens promocionais que já tiverem sido enviados anteriormente exatamente iguais;
• Os itens promocionais que estavam ativos anteriormente, porém não apareceram mais na nova chamada de reset, serão desativados.

Consulta de Promoções

Detalhamento dos filtros possíveis

Tabela de valores para o campo status

Retorno da requisição

• Sucesso
  • HTTP status code 200
  • Response body

    {
      "promotions": [
        {
            "promotionItemId": "005f5ea0-1ff4-4c9b-9f48-76d94bfe4694",
            "ean": "3213434343",
            "status": "PROCESSING",
            "initialDate": "2024-10-10",
            "finalDate": "2024-10-11",
            "promotionType": "LXPY",
            "promotionName": "Promoção teste do tipo LXPY",
            "progressiveDiscount": {
                "quantityToBuy": 3,
                "quantityToPay": 2
            }
        }
      ],
      "pagination": {
        "nextOffset": 99,
        "currentOffset": 0
      }
    }

• Erro
  • Quando ocorrer algum erro ao realizar o processamento, será retornado o HTTP status code 400 ou 422

    {
    "type": "Business Exception || Unprocessable Entity",
    "title": "Business Exception || Unprocessable Entity",
    "status": 400 || 422,
    "detail": "Detail error",
    "instance": "07228dab-644c-4bec-b8a3-073397a839a0"
    }

  • Quando ocorrer algum erro em algum parâmetro ou no body, será retornado o HTTP status code 412 HTTP status code 412

    {
    "type": "Precondition Failed || Invalid Argument",
    "title": "Invalid Request Body || Invalid Argument",
    "status": 412,
    "detail": "Detail error",
    "instance": "07228dab-644c-4bec-b8a3-073397a839a0"
    }

Tabela de valores retornados no campo error

Retorno no módulo de Order

• Os benefícios serão apresentados no campo benefit.benefits (para todas as mecânicas, inclusive as do tipo FIXED_PRICE);
• Caso queira saber somente os benefícios em itens que são patrocinados pela sua loja (que é o caso das promoções enviadas pelo módulo de Promotion):
  • Filtre somente os benefícios em que target seja ITEM;
  • Destes, filtre somente os benefícios que possuem somente 1 elemento em sponsorships, e que este possua liability como PARTNER.
• Para saber o valor do item com desconto:
  • Obtenha o valor de targetId do benefício e use para correlacionar com o item (elemento em bag.items que tenha uniqueId de mesmo valor).
  • O valor no item é sempre sem qualquer desconto. Então, subtraia o valor de sponsorships.amount.value (do benefício) do valor do campo prices.grossValue.value (do item).

Critérios de Homologação