Criar Campanha

Xsolla Developers

Criar CampanhaServer-sideAdmin

post/merchants/{merchant_id}/coupon_promotions

Você precisa revisar uma promoção antes de ativá-la. Este método retorna a lista de erros, se houver.

Aviso

Esta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização.

SecuritybasicAuth

Request

path Parameters

merchant_id

required

integer

ID de comerciante.

Request Body schema: application/json

campaign_code

required

string

Nome da campanha.

project_id

required

integer

ID de projeto.

required

object

Objeto que contém nomes de campanha traduzidos.

ar	string Árabe.
bg	string Búlgaro.
cn	string Chinês (Simplificado).
cs	string Tcheco.
de	string Alemão.
en	string Inglês.
es	string Espanhol.
fr	string Francês.
he	string Hebreu.
it	string Italiano.
ja	string Japonês.
ko	string Coreano.
pl	string Polonês.
pt	string Português.
ro	string Romeno.
ru	string Russo.
th	string Tailandês.
tr	string Turco.
tw	string Chinês (Tradicional).
vi	string Vietnamita.

campaign_redeems_count_for_user

integer

Quantidade máxima de resgates de cupons por usuário em uma campanha. Se null for passado, a quantidade de resgates será ilimitada.

expiration_date

string <datetime>

A data de validade da campanha no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o ISO 8601.

redeems_count

integer

Quantidade máxima de resgates de cupons. Se null for passado, a quantidade de resgates será ilimitada.

redeems_count_for_user

integer

Quantidade máxima de resgates de cupons por usuário. Se null for passado, a quantidade de resgates será ilimitada.

object

Objeto que contém parâmetros de assinatura em uma recompensa.

plan_id required	integer ID de plano de assinatura.
product_id required	integer ID de produto de assinatura.
trial_period required	integer O período de teste em dias.

virtual_currency_amount

number <float>

Quantia da moeda virtual em uma recompensa.

object

Matriz de parâmetros de itens virtuais em uma recompensa.

sku required	string SKU de itens virtuais.
quantity required	integer Quantidade de itens virtuais.

Responses

201

Criado.

Request samples

application/json

{"campaign_code": "sample_campaign",
"campaign_names": {"en": "Campaign Name",
"ru": "Название кампании"
},
"campaign_redeems_count_for_user": 1,
"expiration_date": "2019-12-31",
"project_id": 12345,
"redeems_count": 10,
"redeems_count_for_user": 1,
"subscription_coupon": {"plan_id": 123,
"product_id": 456,
"trial_period": 30
},
"virtual_currency_amount": 200
}

Response samples

application/json

{"id": 9134
}