Difference between revisions of "Offerit REST API Set Offer Categories"

Revision as of 18:14, 11 May 2017

PATCH /offer/set_offer_categories

Description

• set_offer_categories updates the categories associated with an offer

Resource URL

• http://domain/api/offer/set_offer_categories
• Replace domain with the Offerit domain

Response Format

• JSON

Request Method

• PATCH

Authentication

• HTTP headers

Parameters

• offerid
  • type: int
  • required
  • The offer to update
• categories
  • type: array,string'
  • required
  • Array or comma separated list of category names or ids to associate with this offer. Category names that don't exist will be created.
• append
  • type: bool
  • Adds to existing categories. Default is to replace them.

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 
var_dump(json_decode($resp, true)); 
// Close request to clear up some resources 
curl_close($curl); 
?>