Criar promoção para o seller
POST/seller/v1/promotions
Cria uma promoção de autosserviço para o seller em um canal de vendas.
Escopo da Operação
Este endpoint permite que o seller crie suas próprias campanhas promocionais, informando nome, descrição, período de vigência, canal, tipo de benefício, escopo de SKUs, benefícios e regras aplicáveis.
Tipos de Promoção Suportados
percentage_discount— Desconto à Vistaabsolute_discount— Preço Promocionalcoupon_discount— Cupom de Descontofidelity_discount— Cliente Ouro
Regras de Negócio Comerciais
- Escopo da promoção: a promoção pode ser criada com
scope = full_catalog(todo o catálogo do seller) ouscope = seller_choice(seleção de SKUs). Paraabsolute_discount, apenasseller_choiceé permitido. - Benefícios: o campo
benefitsé obrigatório para todos os tipos, excetoabsolute_discount. A estrutura aceita varia conforme o tipo informado emtype.id. - Cupom de Desconto (
coupon_discount): o código do cupom deve ter no máximo 11 dígitos e iniciar com os 4 primeiros dígitos do id do seller; informe embenefits.limito limite total de cupons e o limite máximo de usos por CPF/CNPJ. - Meios de pagamento: para
percentage_discount, os meios de pagamento do seller são consultados internamente — não enviepayment_methodsno corpo da requisição.
Regras de Configuração (rules)
As regras abaixo podem ser informadas em rules para ativar comportamentos adicionais na promoção:
allow_disclosure— permite que o canal divulgue a promoção em ações como recuperação de carrinho abandonado. Aplicável acoupon_discount.allow_limit_sku_sales— aplica limite de vendas por SKU na campanha. Aplicável aabsolute_discountefidelity_discount, e não é permitida quando a promoção é criada comscope = full_catalog(apenasseller_choice).
Request
Responses
- 202
- 400
- 403
- 404
- 422
- 500
Successful Response
Requisição inválida
- O código do cupom não pode ter mais que 11 dígitos.
- O código do cupom não pode ter menos que 5 dígitos.
- O código do cupom deve iniciar com os 4 primeiros dígitos iguais aos 4 primeiros dígitos do id do seller.
- O limite de skus não pode ser configurado para promoções com o catálogo completo
Proibido
- O seller '%{id_tenant}', de contexto '%{id_channel}', não foi encontrado ou está inativo no sistema.
Não encontrado
- Canal não encontrado.
- O canal '%{channel}' não está habilitado para promoção do tipo '%{promotion_type}'.
- Tipo de benefício não implementado.
Entidade não processável
- O tipo de promoção '%{type}' não é válido!
- O campo benefits é obrigatório para este tipo de promoção
- A comissão do seller '%{id_seller}' é inferior ao subsídio da promoção.
Erro interno do servidor
- Internal server error