Limite de desconto

A entidade Limite de desconto permite gerenciar os limites de descontos que um vendedor pode aplicar além dos descontos que vêm da entidade de Promoções

Endpoint

GET /api/discount-limits

Campos

Campo	Tipo	Obrigatoriedade	Descrição	Exemplos
`targetCommerceIds`	🔠 Lista de textos → Comércios	⚪ Opcional	lista de Identificadores de Comércio ao qual será aplicado o Limite de desconto.
*Deve corresponder ao campo `commerceId` da carga de Comércios .
• Se estiver vazio, será aplicado para todos os comércios	[`"12345", "67890"`]
`productId`	📝 Texto	⚪ Opcional	Produto ao qual se aplica o limite de desconto.
• Deve corresponder ao campo `productId` da carga de Produtos.
• Requer que `type = product` para funcionar	`"PROD-00"`
`enabled`	🔘 Bool	🟢 Obrigatório	O Limite de desconto está ativo?	`true`
`false`
`useMixedDiscountTotal`	🔘 Bool	⚪ Opcional	Quando está em `true` são revisados todos os limites de desconto, tanto para type `product` quanto type `order`, e são somados. Quando este campo é `false`, é considerado apenas o desconto do `type` .	`true`
`false`
`type`	📝 Texto	🟢 Obrigatório	Tipo de desconto a aplicar.
`'product'` → Desconto aplicado a um produto em particular
`'order'` → Desconto aplicado ao pedido	`"product"`
`blockLimit`	🔢 Número	🟢 Obrigatório	Limite de desconto máximo para a criação do pedido no sistema da YOM. Se este valor for ultrapassado, a criação do pedido falha com mensagem de erro.
** Este limite se aplica exclusivamente a este desconto de vendedor	`0.2`
`retainLimit`	🔢 Número	🟢 Obrigatório	Limite de desconto máximo para a retenção do pedido no sistema da YOM. Se este valor for ultrapassado, a criação do pedido é bem-sucedida, mas fica com um status `pendiente de aprobación de admin` e não é enviado ao ERP do cliente.
** Este limite se aplica exclusivamente a este desconto de vendedor	`0.15`

Resposta

A resposta do endpoint de Limite de desconto fornece um JSON que contém as informações detalhadas do limite de desconto que se quer aplicar, seja aos pedidos ou a um produto em particular.

Exemplo de Resposta

{
  "enabled": true,
  "targetCommerceIds": [],
  "useMixedTotal": true,
  "type": "order",
  "blockLimit": 0.2,
  "retainLimit": 0.1
}

{
  "enabled": true,
  "targetCommerceIds": ["12345"],
  "productId": "PROD-1234"
  "useMixedTotal": true,
  "type": "product",
  "blockLimit": 0.2,
  "retainLimit": 0.1
}

Com esta estrutura, você poderá gerenciar e consultar a informação de Limite de desconto na YOM.

Etapas anteriores

Documentos Fiscais

</aside>

Próximas etapas

</aside>