Creación
El tipo de campaña se determina por el parámetro partial, puede ser una campaña total que se aplica a todos los artículos de tu comercio o puede ser una campaña parcial que se aplica a artículos espefícicos.
En el caso de campaña parcial es necesario añadir los artículos sobre los que aplica la campaña de financiación.
Consulta como gestionar los artículos de una campaña de financiación.
- http
- shell
- python
- php
- C#
POST /me/campaigns HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com
Content-Type: application/json
{
"name": "Summertime",
"start_date": "2016-06-01T00:00:00",
"end_date": "2016-08-31T23:59:59",
"interest": "2500",
"partial": true,
"num_instalments": [1, 2, 3, 5, 8]
}
$ curl "https://api.aplazame.com/me/campaigns" \
-H "Accept: application/vnd.aplazame.v1+json" \
-H "Authorization: Bearer api_private_key"\
--data-binary '{
"name": "Summertime",
"start_date": "2016-06-01T00:00:00",
"end_date": "2016-08-31T23:59:59",
"interest": "2500",
"partial": true,
"num_instalments": [1, 2, 3, 5, 8]
}'
import aplazame_sdk
client = aplazame_sdk.Client('api_private_key')
response = client.post_campaign(':merchantId', {
'name': 'Summertime',
'start_date': '2016-06-01T00:00:00',
'end_date': '2016-08-31T23:59:59',
'interest': '2500',
'partial': True,
'num_instalments': [1, 2, 3, 5, 8]
})
use Aplazame\Api\Client as AplazameClient;
$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");
$campaign = [
"name" => "Summertime",
"start_date" => Aplazame\Serializer\Decimal::fromDateTime(new DateTime("2016-06-01 00:00:00")),
"end_date" => Aplazame\Serializer\Decimal::fromDateTime(new DateTime("2016-08-31 23:59:59")),
"interest" => Aplazame\Serializer\Decimal::fromFloat(25),
"partial" => true,
"num_instalments" => [1, 2, 3, 5, 8],
];
$result = $aplazameClient->post("/me/campaigns", $campaign);
using Aplazame.Api;
Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");
dynamic campaign = new {
name = "Summertime",
start_date = Aplazame.Serializer.DateType.FromDateTime(DateTime.Parse("2016-06-01 00:00:00")),
end_date = Aplazame.Serializer.DateType.FromDateTime(DateTime.Parse("2016-08-31 23:59:59")),
interest = Aplazame.Serializer.DecimalType.FromDouble(25),
partial = true,
num_instalments = [1, 2, 3, 5, 8],
};
dynamic result = client.Post($"/me/campaigns", campaign);
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| name | string | Sí | Nombre de la campaña. |
| start_date | ISO 8601 | Sí | Fecha de inicio de la campaña. |
| end_date | ISO 8601 | No | Fecha fin de la campaña. |
| interest | decimal | Sí | Tasa de descuento en los intereses. |
| partial | Boolean | No | Determina si la campaña aplica a todos los productos, por defecto false. |
| num_instalments | array | No | Número de cuotas disponibles para la campaña. |
| min_order_amount | decimal | No | Importe mínimo del carrito (order.total_amount) al que aplica la campaña. |
| max_order_amount | decimal | No | Importe máximo del carrito (order.total_amount) al que aplica la campaña. |
Respuesta
HTTP/1.1 201 CREATED
Content-Type: application/json
X-Aplazame-Media-Type: aplazame.v1
{
"id": "c994e03e42d24be7bf6e1fcbad3334c0",
"name": "Summertime",
"start_date": "2016-06-01T00:00:00",
"end_date": "2016-08-31T23:59:59",
"interest": 2500,
"partial": true,
"num_instalments": [1, 2, 3, 5, 8],
"created": "2016-03-10T11:08:57.265971"
}