Cadastra uma campanha

post

https://openapi.plataformaneo.com.br/promotion/api/v{version}/discountInProducts

Path Params

version

string

required

Body Params

Campanha de desconto em produtos

idCampaign

int32

Id da Campanha

status

string | null

Status da Campanha; Valores aceitos "A" ou "I"

code

string | null

Código

name

string | null

Nome

dateTimeBegin

date-time | null

Data Hora Início

dateTimeEnd

date-time | null

Data Hora Final

freeShipping

boolean

Frete Grátis?

allowPurchaseWithZeroValue

boolean

Permite finalização de pedidos com valor zero

discountType

string

enum

Tipo de Desconto (1 - Porcentagem, 2 - Valor)

Allowed:

discountValue

double

Valor do Desconto

applicationDiscountType

string

enum

Tipo de aplicação do desconto (1 - Total do carrinho, 2 - Total dos produtos)

Allowed:

orderUseIsUnlimited

boolean

Limite de utilizações em pedido é ilimitado?

orderUseLimit

int32 | null

Limite de utilizações em pedido

customerUseIsUnlimited

boolean

Limite de utilizações por cliente é ilimitado?

customerUseLimit

int32 | null

Limite de utilizações por cliente

minimalOrderValue

double | null

Valor mínimo de pedido para ativar a campanha

maximalOrderValue

double | null

Valor máximo de pedido para ativar a campanha

minimalProductsQuantity

int32 | null

Quantidade mínima de produtos no carrinho para ativar a campanha

maximalProductsQuantity

int32 | null

Quantidade máxima de produtos no carrinho para ativar a campanha

campaignTotalCupons

int32

Quantidade de cupons da campanha

coupon

string | null

Chave do cupom da campanha

isBatchedCupons

boolean

Campanha é de cupons em lote?

qtdBatchedCupons

int32

Quantidade de cupons em lote

batchCupons

array of objects | null

Chaves de cupons da campanha em lote

batchCupons

campaignType

string

enum

Tipo da campanha (1 - Todos os produtos, 2 - Categoria, Marca ou Grupo, 3 - Produtos)

Allowed:

isB2B

boolean

Segmento da campanha é B2B?

isB2C

boolean

Segmento da campanha é B2C?

allClients

boolean

Campanha para todos os clientes?

isAccumulativeCoupon

boolean

Campanha é acumulativa com outros cupons?

token

uuid | null

Token único de identificação da campanha

tablePricesLinked

array of objects | null

Tabelas de preço vinculadas

tablePricesLinked

productsLinked

array of objects | null

Produtos vinculados

productsLinked

categoriesLinked

array of objects | null

Categorias vinculadas

categoriesLinked

brandsLinked

array of objects | null

Marcas vinculadas

brandsLinked

groupsLinked

array of objects | null

Grupos vinculados

groupsLinked

clientsLinked

array of objects | null

Clientes vinculados

clientsLinked

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK