Criar promoção de cupom

post/v2/project/{project_id}/admin/coupon

Cria uma promoção de cupom.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Example: 44056

Request Body schema: application/json

external_id

required

string

Default: "coupon_external_id"

ID de promoção exclusivo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.

required

object

Default: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}

Nome da promoção. Deve conter pares chave/valor onde a chave é uma localidade com formato "^[a-z]{2}-[A-Z]{2}$", e valor sendo uma cadeia de caracteres.

property name*

additional property

string

Array of objects or null

Array

quantity	number Default: 1 Quantidade do item.
sku	string Default: "elven_shield" SKU do item.

date_end

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

Data em que sua promoção será concluída. Pode ser null. Se date_end for null, a promoção terá um tempo ilimitado.

date_start

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

Data em que sua promoção será iniciada.

redeem_code_limit

integer or null

Default: 10

Número de resgates por código.

redeem_total_limit

integer or null

Default: 10

Limita o número total de cupons.

redeem_user_limit

integer or null

Default: 10

Limita o número total de cupons resgatados por um único usuário.

Responses

201

O cupom foi criado com sucesso.

401

Autenticação básica não aprovada ou errada. Verifique se você usou a autenticação básica ou as credenciais corretas.

422

Solicitação inválida.

Request samples

application/json

{"bonus": [{"quantity": 1,
"sku": "elven_shield"
}
],
"date_end": "2020-04-15T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"external_id": "coupon_external_id",
"name": {"de-DE": "Gutscheintitel",
"en-US": "Coupon title"
},
"redeem_code_limit": 10,
"redeem_total_limit": 10,
"redeem_user_limit": 10
}

Response samples

application/json

{"coupon_id": "coupon_external_id"
}