API de Campañas

La API de Campañas permite gestionar las campañas de financiación del comercio.

Consulta la documentación sobre las campañas de financiación como estrategia para incrementar las ventas de tu comercio.

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.

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]
}
Parámetro Tipo Requerido Descripción
name string si Nombre de la campaña
start_date ISO 8601 si Fecha de inicio de la campaña
end_date ISO 8601 no Fecha fin de la campaña
interest decimal si 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"
}

Detalles

GET /me/campaigns/:campaignId HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com
Parámetro Tipo Requerido Descripción
:merchantId hash si id de la tienda con el que hacer las peticiones
:campaignId hash si id de la campaña con el que hacer las peticiones

Respuesta

HTTP/1.1 200 OK
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"
}
Parámetro Tipo Descripción
id hash id del hostname,
name string Nombre de la campaña
start_date ISO 8601 Fecha de inicio de la campaña
end_date ISO 8601 Fecha fin de la campaña
interest decimal Tasa de descuento en los intereses
partial Boolean Determina si la campaña aplica a todos los productos

Edición

PUT /me/campaigns/:campaignId 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]
}
Parámetro Tipo Requerido Descripción
name string si Nombre de la campaña
start_date ISO 8601 si Fecha de inicio de la campaña
end_date ISO 8601 no Fecha fin de la campaña
interest decimal si 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

Respuesta

HTTP/1.1 204 NO CONTENT
X-Aplazame-Media-Type: aplazame.v1

Partial edit

PATCH /me/campaigns/:campaignId HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com
Content-Type: application/json

{
  "start_date": "2016-06-22T00:00:00"
}
Parámetro Tipo Requerido Descripción
:merchantId hash si id de la tienda con el que hacer las peticiones
:campaignId hash si id de la campaña con el que hacer las peticiones
HTTP/1.1 204 NO CONTENT
X-Aplazame-Media-Type: aplazame.v1
Parámetro Tipo Requerido Descripción
--------- ---- -------- -----------
name string no Nombre de campaña
start_date ISO 8601 no Fecha de inicio de la campaña
end_date ISO 8601 no Fecha fin de la campaña
interest decimal no 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

Borrado

DELETE /me/campaigns/:campaignId HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

Respuesta

HTTP/1.1 204 NO CONTENT
X-Aplazame-Media-Type: aplazame.v1

Listado

GET /me/campaigns?page=2 HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

Respuesta

HTTP/1.1 200 OK
Content-Type: application/json
X-Aplazame-Media-Type: aplazame.v1

{
  "cursor": {
    "after": 3,
    "before": 1
  },
  "paging": {
    "count": 314,
    "next": "https://api.aplazame.com/me/campaigns?page=3",
    "previous": "https://api.aplazame.com/me/campaigns?page=1"
  },
  "results": [
  ]
}
Parámetro Tipo Descripción
cursor object Puntero de paginación
paging object Estado de paginación
results collection Listado de campañas