Articles

Add

Once the campaign is created, you must add the list of the articles to which it applies.

http

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"
  }
]

shell

$ 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"
  }
]'

python

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')
response = client.post_campaign_articles(':merchantId', ':campaignId', [
  {
    'id': '89793238462643383279',
    'name': '$message{ es: "Reloj en oro blanco de 18 quilates y diamantes", en: "18 ct white gold watch with diamonds" }',
    'description': '$message{ es: "Movimiento de cuarzo de alta precisión", en: "High-precision quartz movement" }',
    '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',
  }
])

php

use Aplazame\Api\Client as AplazameClient;

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

$articles = [
  [
    "id" => "89793238462643383279",
    "name" => "$message{ es: "Reloj en oro blanco de 18 quilates y diamantes", en: "18 ct white gold watch with diamonds" }",
    "description" => "$message{ es: "Movimiento de cuarzo de alta precisión", en: "High-precision quartz movement" }",
    "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);

C#

using Aplazame.Api;

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

dynamic[] articles = new dynamic[] {
  new {
    id = "89793238462643383279",
    name = "$message{ es: "Reloj en oro blanco de 18 quilates y diamantes", en: "18 ct white gold watch with diamonds" }",
    description = "$message{ es: "Movimiento de cuarzo de alta precisión", en: "High-precision quartz movement" }",
    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);

Parameter	Type	Required	Description
id	string	Yes	Article id.
name	string	Yes	Article name.
description	string	No	Article description.
url	URL	Yes	Article absolute URL.
image_url	URL	No	Article image absolute URL.

Response

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

Delete

Individual deletion of an article included in a campaign.

http

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

shell

$ 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'

python

import aplazame_sdk

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

php

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}");

C#

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}");

Response

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

Delete all

if you do not include the article id in the URL, all campaign articles are referenced.

http

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

shell

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

python

import aplazame_sdk

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

php

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");

C#

using Aplazame.Api;

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

Response

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

List

http

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

shell

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

python

import aplazame_sdk

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

php

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");

C#

using Aplazame.Api;

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

info

See pagination docs 3

Response

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": [
  ]
}

Parameter	Type	Description
cursor	object	Pagination cursor object
paging	object	Pagination status
results	collection	List of campaigns