/api/site/option‑types

get

Get option types

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

get

/api/site/option-types

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array();

$request = array(
	'method' => 'GET',
	'path' => 'site/option-types',
	'data' => $data
);

/*code below is the same for (almost) every API call */

$curl = curl_init();

$url = $url.'/api/'.$request['path'];

$query = http_build_query($request['data']);

if($request['method'] == 'GET'){
	//add query string parameters to the end of the url
	$url = $url.'?'.$query;
}else{
	//send parameters as POST fields
	curl_setopt($curl, CURLOPT_POST, 1);
	curl_setopt($curl, CURLOPT_POSTFIELDS, $query);

	if($request['method'] != 'POST'){
		$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
	}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);


$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);
?>

200

success

{
  "success": true,
  "option_types": [
    {
      "key": 0,
      "name": "normal",
      "mapping": "optioninfo",
      "special": 0,
      "nosite": 0,
      "extra_offers": 1,
      "incoming_sale": 0,
      "rule_type": "option"
    },
    {
      "key": 1,
      "name": "incoming_xsells",
      "mapping": "xsellinfo_incoming",
      "special": 0,
      "nosite": 0,
      "extra_offers": 1,
      "incoming_sale": 1,
      "sale_type": "xsell",
      "flow": "Incoming",
      "sort": 0,
      "type_description": "Cross Sale"
    },
    {
      "key": 2,
      "name": "incoming_upsells",
      "mapping": "upsellinfo_incoming",
      "special": 0,
      "nosite": 0,
      "extra_offers": 1,
      "incoming_sale": 1,
      "sale_type": "upsell",
      "flow": "Incoming",
      "sort": 0,
      "type_description": "Up Sell"
    },
    {
      "key": 3,
      "name": "outgoing_xsells",
      "mapping": "xsellinfo_outgoing",
      "special": 0,
      "nosite": 1,
      "extra_offers": 0,
      "incoming_sale": 0,
      "sale_type": "xsell",
      "flow": "Outgoing",
      "sort": 1,
      "type_description": "Cross Sale",
      "rule_type": "upsells"
    },
    {
      "key": 4,
      "name": "outgoing_upsells",
      "mapping": "upsellinfo_outgoing",
      "special": 0,
      "nosite": 1,
      "extra_offers": 0,
      "incoming_sale": 0,
      "sale_type": "upsell",
      "flow": "Outgoing",
      "sort": 0,
      "type_description": "Up Sell",
      "rule_type": "upsells"
    },
    {
      "key": 5,
      "name": "special",
      "mapping": "optioninfo",
      "special": 1,
      "nosite": 0,
      "extra_offers": 1,
      "incoming_sale": 0,
      "rule_type": "option"
    }
  ]
}