Skip to content

Set Offer Categories

PATCH /offer/set_offer_categories

Description URL Response Format Request Method Authentication
Update categories associated with an offer https://domain/api/offer//set_offer_categories JSON PATCH HTTP headers

Parameters

Name Description Type Required
offerid id of the offer to be updated integer yes
categories array or comma separated list of category names or ids to associate with this offer. Category names that don't exist will be created. array, string yes
append adds to existing categories. Default is to replace them. boolean no

Example Request

PATCH

http://domain/api/offer/set_offer_categories
offerid=2
categories=1,2,new cat

Response:

{
    "result":"Success",
}

Example Code

php

<?php 
$url = 'http://domain/api/offer/set_offer_categories';
$curl = curl_init(); 

$headers = array( 
    'api-key: 44b5498dbcb481a0d00b404c0169af62', 
    'api-username: productsupport' 
);

 $data = Array(
    'offerid' => 2,
    'categories' => Array(1,2,'new cat')
); 

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$resp = curl_exec($curl); 
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
    //json was valid. Dump the decoded array
    print_r($output);
}
else {
    //invalid json, just dump the raw response
    print_r($resp);
}
// Close request to clear up some resources 
curl_close($curl); 
?>