Crear campaña

Xsolla Developers

Crear campañaServer-sideAdmin

post/merchants/{merchant_id}/coupon_promotions

Crear una nueva campaña de cupones.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

SecuritybasicAuth

Request

path Parameters

merchant_id

required

integer

ID de vendedor.

Request Body schema: application/json

campaign_code

required

string

Nombre de campaña.

project_id

required

integer

ID de proyecto.

required

object

Objeto que contiene los nombres de las campañas localizados.

ar	string Árabe.
bg	string Búlgaro.
cn	string Chino (simplificado).
cs	string Checo.
de	string Alemán.
en	string Inglés.
es	string Español.
fr	string Francés.
he	string Hebreo.
it	string Italiano.
ja	string Japonés.
ko	string Coreano.
pl	string Polaco.
pt	string Portugués.
ro	string Rumano.
ru	string Ruso.
th	string Tailandés.
tr	string Turco.
tw	string Chino (tradicional).
vi	string Vietnamita.

campaign_redeems_count_for_user

integer

Número máximo de canjes de cupones por usuario en el marco de una campaña. Si se transmite null, el número de canjes es ilimitado.

expiration_date

string <datetime>

Fecha de finalización de la campaña en formato YYYY-MM-DD’T’HH:MM:SS de conformidad con la norma ISO 8601.

redeems_count

integer

Número máximo de canjes de cupones. Si se transmite null, el número de canjes es ilimitado.

redeems_count_for_user

integer

Número máximo de canjes de cupones por usuario. Si se transmite null, el número de canjes es ilimitado.

object

Objeto que contiene parámetros de suscripción en una recompensa.

plan_id required	integer ID del plan de suscripción.
product_id required	integer ID del producto de suscripción.
trial_period required	integer Duración del periodo de prueba en días.

virtual_currency_amount

number <float>

Importe en moneda virtual de una recompensa.

object

Matriz de parámetros de artículos virtuales de una recompensa.

sku required	string Código de artículo (SKU) virtual.
quantity required	integer Cantidad de artículos virtuales.

Responses

201

Creada.

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
}