Proceso de checkout
Entorno de pruebas
- Modo de pruebas
- Datos de prueba
Peticiones a la API
Creación del checkout
SDK Javascript
SDK iOS
SDK Android
Confirmación del pedido
Captura del pedido
Integración del widget
API de Pedidos
API de Campañas
Integración POS

Artículos

Añadir

Una vez creada la campaña, deberás añadir el listado de los artículos sobre los que aplica.

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

[
  {
    "id": "89793238462643383279",
    "name": "Reloj en oro blanco de 18 quilates y diamantes",
    "description": "Movimiento de cuarzo de alta precisión",
    "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
    "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg"
  },
  {
    "id": "59825349042875546873",
    "name": "Nº5 eau premiere spray",
    "description": "A decidedly lighter, fresher...",
    "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
    "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg"
  }
]

$ curl "https://api.aplazame.com/me/campaigns/:campaignId/articles" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"\
    --data-binary '[
  {
    "id": "89793238462643383279",
    "name": "Reloj en oro blanco de 18 quilates y diamantes",
    "description": "Movimiento de cuarzo de alta precisión",
    "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
    "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg"
  },
  {
    "id": "59825349042875546873",
    "name": "Nº5 eau premiere spray",
    "description": "A decidedly lighter, fresher...",
    "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
    "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg"
  }
]'

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')
response = client.post_campaign_articles(':merchantId', ':campaignId', [
  {
    'id': '89793238462643383279',
    'name': 'Reloj en oro blanco de 18 quilates y diamantes',
    'description': 'Movimiento de cuarzo de alta precisión',
    'url': 'http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083',
    'image_url': 'http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg',
  },
  {
    'id': '59825349042875546873',
    'name': 'Nº5 eau premiere spray',
    'description': 'A decidedly lighter, fresher...',
    'url': 'http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083',
    'image_url': 'http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg',
  }
])

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$articles = [
  [
    "id" => "89793238462643383279",
    "name" => "Reloj en oro blanco de 18 quilates y diamantes",
    "description" => "Movimiento de cuarzo de alta precisión",
    "url" => "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
    "image_url" => "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
  ],
  [
    "id" => "59825349042875546873",
    "name" => "N°5 eau premiere spray",
    "description" => "A decidedly lighter, fresher...",
    "url" => "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
    "image_url" => "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
  ]
];
$result = $aplazameClient->post("/me/campaigns/{$campaignId}/articles", $articles);

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic[] articles = new dynamic[] {
  new {
    id = "89793238462643383279",
    name = "Reloj en oro blanco de 18 quilates y diamantes",
    description = "Movimiento de cuarzo de alta precisión",
    url = "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
    image_url = "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
  },
  new {
    id = "59825349042875546873",
    name = "N°5 eau premiere spray",
    description = "A decidedly lighter, fresher...",
    url = "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
    image_url = "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
  }
};
dynamic result = client.Post($"/me/campaigns/{campaignId}/articles", articles);

Parámetro	Tipo	Requerido	Descripción
id	string	si	`ID` del artículo
name	string	si	Nombre del artículo
description	string	no	Descripción del artículo
url	URL	si	URL absoluta del artículo
image_url	URL	no	URL absoluta de la imagen del artículo

Respuesta

HTTP/1.1 204 NO CONTENT
Content-Type: application/vnd.aplazame.v1+json

Borrado

Borrado individual de un artículo incluido en una campaña.

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

$ curl "https://api.aplazame.com/me/campaigns/:campaignId/articles/:articleId" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"\
    -X DELETE'

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')
response = client.delete_campaign_article(':merchantId', ':campaignId', ':articleId')

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");
$result = $aplazameClient->delete("/me/campaigns/{$campaignId}/articles/{$articleId}");

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");
dynamic result = client.Delete($"/me/campaigns/{campaignId}/articles/{articleId}");

Respuesta

HTTP/1.1 204 NO CONTENT
Content-Type: application/vnd.aplazame.v1+json

Borrar todos

Al no incluir el id del artículo en la URL estarás referenciando a todos los artítulos de la campaña.

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

$ curl "https://api.aplazame.com/me/campaigns/:campaignId/articles" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"\
    -X DELETE'

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')
response = client.delete_campaign_articles(':merchantId', ':campaignId')

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");
$result = $aplazameClient->delete("/me/campaigns/{$campaignId}/articles");

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");
dynamic result = client.Delete($"/me/campaigns/{campaignId}/articles");

Respuesta

HTTP/1.1 204 NO CONTENT
Content-Type: application/vnd.aplazame.v1+json

Listado

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

$ curl "https://api.aplazame.com/me/campaigns/:campaignId/articles" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')
response = client.get_campaign_articles(':merchantId', ':campaignId')

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");
$result = $aplazameClient->get("/me/campaigns/{$campaignId}/articles");

using Aplazame.Api;

Client client = new Client(
  "https://api.aplazame.com",
  Client.EnvironmentProduction,
  "api_private_key"
);
dynamic result = client.Get($"/me/campaigns/{campaignId}/articles");

Respuesta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "cursor": {
    "after": 3,
    "before": 1
  },
  "paging": {
    "count": 314,
    "next": "https://api.aplazame.com/me/campaigns/:campaignId/articles?page=3",
    "previous": "https://api.aplazame.com/me/campaigns/:campaignId/articles?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

Tiendas por categoría

Aumenta tus ventas

Productos

Recursos para comercios

Artículos

Añadir

Borrado

Borrar todos

Listado