Shoptrader API docs

Image Description

Post - Categorie

Met deze API call is het mogelijk om een nieuwe categorie toe te voegen of een categorie te wijzigen

Parameters

Parameter Type Verplicht Omschrijving
token string Ja Token, wordt verstrekt door Shoptrader op verzoek
category_id int Nee Een categorie wordt gewijzigd wanneer u een category_id opgeeft. Zonder category_id wordt er een nieuwe categorie toegevoegd. Er wordt een controle uitgevoerd of de category_id bestaat.
De category_id valt buiten de categories array. Alle andere waardes moeten in de categories array staan. Bekijk het voorbeeld voor de opbouw.
parent_id integer Nee Dit is de category_id van de bovenliggende categorie. Voor het hoogste niveau geeft u hier 1 op.
sort_order integer Nee De volgorde waarin de categorie getoond wordt.
sorteerbalkWeergeven bool Nee Toon de sorteer dropdown lijst bij een categorie om te sorteren op bijv. prijs. Vul hier 1 of 0 in.
isActive bool Nee Zet categorie actief. Vul hier 1 of 0 in.
inCategoriesBox bool Nee Toon de categorie in de categorieën box. Vul hier 1 of 0 in.
inDropdownMenu bool Nee Toon de categorie in het menu. Vul hier 1 of 0 in.
onHomepage bool Nee Toon de sorteer dropdown lijst bij een categorie om te sorteren op bijv. prijs. Vul hier 1 of 0 in.
categories_name_languages array Nee De categorie naam. Geef hierin alle talen op die bij uw winkel aanwezig zijn (voor het wijzigen alleen de taal die u wilt wijzigen).

De volgende waardes kunnen in de array te zitten.
  • name (de categorie naam)
Bekijk het voorbeeld voor de opbouw.
description array Nee De beschrijvingen van de categorie. Geef hierin alle talen op die bij uw winkel aanwezig zijn (voor wijzigen alleen de taal die u wilt wijzigen).

De volgende waardes kunnen in de array te zitten.
  • aboveProducts (de beschrijving die boven de producten getoond wordt)
  • belowProducts (de beschrijving die onder de producten getoond wordt)
Bekijk het voorbeeld voor de opbouw.
meta array Nee Hierin kunt u uw meta gegevens van het categorie opgeven. Geef hierin alle talen op die bij uw winkel aanwezig zijn (voor wijzigen alleen de taal die u wilt wijzigen).

De volgende waardes kunnen in de array te zitten.
  • categories_seo_url (de url van het categorie, geen spaties of gekke tekens)
  • categories_meta_title (de meta titel die getoond wordt bij de categorie)
  • categories_meta_description (de meta beschrijving die getoond wordt bij de categorie)
  • categories_meta_keywords (de meta keywords die getoond worden bij de categorie)
Bekijk het voorbeeld voor de opbouw.
images array Nee Geef hier op waar de afbeelding vandaan moet komen en de alt tekst De afbeelding wordt dan van die locatie opgehaald en opgeslagen in de winkel.
Een categorie kan 1 afbeelding bevatten.

De volgende waardes dienen in de array te zitten.
  • image_source_url (url waar de afbeelding vandaan gekopieërd moet worden)
  • image_alt (de alt tekst van de afbeelding)
  • action (add of delete). LET OP: Bij delete wordt de afbeelding alleen uit de database gehaald. De afbeelding blijft op de server staan.
Bekijk het voorbeeld voor de opbouw.
beslist_nice_name integer Nee Categorie opbouw van beslist.
google_shopping_nice_name integer Nee Categorie opbouw van google shopping.

Advertentieplanet Addon
(Let op, om de properties toe te voegen heeft u een xml nodig met daarin de properties, ook dient u altijd alle properties van de categorie mee te sturen).

advertentieplanet_category_id (Advertentieplanet addon) integer Nee De advertentieplanet category_id.
advertentieplanet_nice_name (Advertentieplanet addon) string Nee Categorie opbouw van advertentieplanet.
advertentieplanet_properties array Nee De properties van advertentieplanet.

De volgende waardes dienen in de array te zitten.
  • property_id
  • property_value
  • property_required

Marktplaats Addon
(Let op, hiervoor heeft u een xml nodig waarin deze gegevens van Marktplaats staan).

categories_adTtlBudg decimal Nee Totaal budget.
categories_adDayBudg decimal Nee Dagelijks budget.
categories_adCPC decimal Nee Kosten per klik.
adGroup_id integer Nee Groep.
adParent_id integer Nee Rubriek.
adPrijstype_id integer Nee Prijstype.
categories_adOnderschrift string Nee Onderschrift.

PHP Example

<?php
ini_set
('max_execution_time'0);

$strApiBaseUrl 'uwdomeinnaam.uwdomeinextentie';
$strOutput 'xml';
$strUrl 'http://' $strApiBaseUrl '/Api/Post/Category/?' $strOutput;        

// standaard parameters
$arrParams = array();
$arrParams['token']         = '8f00f89310945a0ca35666c8c9ced2e314e37aa6c32e900932e19902b42208767';

// $arrParams['category_id'] = 72;
$arrParams['categories']['category'] = array(
    
'images'                => array(
        
'image'    => array(
            
'image_source_url'            => 'https://domeinnaam.nl/afbeelding.png',
            
'image_alt'                    => 'Afbeelding alt tekst',
            
'action'                    => 'add'
        
)
    ),
    
'categories_name_languages'    => array(
        
'dutch'    => array(
            
'name'                    => 'Accessoires nl'
        
),
        
'english'    => array(
            
'name'                    => 'Accessoires en'
        
)
    ),
    
'description'                => array(
        
'dutch'    => array(
            
'aboveProducts'            => 'Testing nl boven artikelen',
            
'belowProducts'            => 'Testing nl onder artikelen'
        
),
        
'english'    => array(
            
'aboveProducts'            => 'Testing en above products',
            
'belowProducts'            => 'Testing en below products'
        
)
    ),
    
'meta'                        => array(
        
'dutch'    => array(
            
'categories_seo_url'    => 'accessoires_test_nl'
        
),
        
'english'    => array(
            
'categories_seo_url'    => 'accessoires_test_en'
        
)
    ),
    
'advertentieplanet_properties'    => array(
        
'property1'    => array(
            
'property_id'        => 45665,
            
'property_value'    => 268937,
            
'property_required'    => 1
        
)
    ),
    
'inDropdownMenu'        => 0
); // required

$objCurl curl_init();
curl_setopt($objCurlCURLOPT_URL$strUrl);
curl_setopt($objCurlCURLOPT_RETURNTRANSFERtrue);
curl_setopt($objCurlCURLOPT_TIMEOUT30);
curl_setopt($objCurlCURLOPT_USERAGENT'Shoptrader');
curl_setopt($objCurlCURLOPT_POSTtrue);
curl_setopt($objCurlCURLOPT_POSTFIELDShttp_build_query($arrParams));

// execute cURL, array, xml output
$strCurlData curl_exec($objCurl);
if (
$strCurlData === FALSE) {
    echo 
"cURL Error: " curl_error($objCurl);
} else {
    
print_r($strCurlData);
}

// execute cURL, array, xml output
// $strCurlData = curl_exec($objCurl);
// if ($strCurlData === FALSE) {
//    echo "cURL Error: " . curl_error($objCurl);
// } else {
//    $arrShopResult = json_decode($strCurlData, true);
//    print_r($arrShopResult);
// }
?>

Resultaat (array)

<?php
Array (
    [
type] => Array (
        [@
attributes] => Array (
            [
category_id] => 79
        
)
        [
success] => Success
    
)
    [
success] => Array (
        [
message] => Category with ID79 inserted successful
    
)
)
?>