REST API v4: POST /events/webshop/order/cancel

Deze methode stelt je in staat om een order cancel te registreren. Dit is een HTTP POST methode naar het volgende adres:

https://api.copernica.com/v4/events/webshop/order/cancel

Deze POST call triggert een order-cancel event. Echter, hoe dit event precies wordt verwerkt hangt af van de configuratie van je account. Naar aanleiding van deze POST call zal:

  • Het event worden gelogd
  • De bijbehorende opvolgacties worden uitgevoerd

Parameters

De volgende parameters moeten verplicht worden meegegeven aan dit endpoint:

  • id: De ID van de bestelling (verplicht)

Naast de verplichte parameters kunnen aan dit evenement extra attributen worden toegevoegd die gebruikt kunnen worden in bijvoorbeeld opvolgacties. Extra attributen kunnen bijvoorbeeld productinformatie bevatten.

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/order/cancel HTTP/1.1
Host: api.copernica.com
Authorization: Bearer your-access-token
Content-Length: 71
Content-Type: application/json

{
    "id": "123",
    "additional_attribute": "value"
}

Voorbeeld met PHP

// vereiste scripts
require_once('copernica-rest-api.php');

// verander dit naar je access token
$api = new CopernicaRestAPI("your-access-token", 4);

// voer het verzoek uit
$api->post("/events/webshop/order/cancel", array(
    'id'       => '123',
    'additional_attribute' => 'value'
));

Dit voorbeeld vereist de REST API klasse.

Meer informatie