REST API v4: POST /events/webshop/product/search
Deze methode stelt je in staat om een product search event te registreren. Dit event treedt op wanneer een gebruiker een zoekactie uitvoert naar een product in een webshop.
Dit is een HTTP POST methode naar het volgende adres:
https://api.copernica.com/v4/events/webshop/product/search
Deze POST call triggert een product search event. De verdere verwerking van dit event is afhankelijk van de configuratie van je account. Als gevolg van deze POST call:
- Het event wordt gelogd.
- Bijbehorende opvolgacties worden uitgevoerd.
Parameters
De volgende parameter moet verplicht worden meegegeven aan dit endpoint:
- sku: De SKU (Stock Keeping Unit) van het product waarvoor de zoekactie wordt uitgevoerd. (verplicht)
Naast deze verplichte parameter kunnen aan dit evenement extra attributen worden toegevoegd die gebruikt kunnen worden in bijvoorbeeld opvolgacties. Klanten mogen ook andere sleutels toevoegen als aanvullende attributen die relevant kunnen zijn voor hun eigen systemen.
Geaccepteerde formaten
De API-call accepteert zowel JSON-data als traditionele POST-data
(application/x-www-form-urlencoded
). Hieronder staan voorbeelden van beide
formaten.
Voorbeeld met JSON
POST /v4/events/webshop/product/search HTTP/1.1
Host: api.copernica.com
Authorization: Bearer your-access-token
Content-Length: 30
Content-Type: application/json
{
"sku": "PROD001"
}
Voorbeeld met URL-gecodeerde data
POST /v4/events/webshop/product/search HTTP/1.1
Host: api.copernica.com
Authorization: Bearer your-access-token
Content-Length: 13
Content-Type: application/x-www-form-urlencoded
sku=PROD001
Voorbeeld met PHP
// Vereiste scripts
require_once('copernica-rest-api.php');
// Vervang met jouw access token
$api = new CopernicaRestAPI("your-access-token", 4);
// Voer het verzoek uit
$api->post("/events/webshop/product/search", array(
'sku' => 'PROD001'
));
Dit voorbeeld vereist de REST API klasse.