Offerit REST API Set Offer Countries
From Offerit
Revision as of 19:03, 11 May 2017 by Offeritnick (talk | contribs) (Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''PATCH /offer/set_offer_countries''' == '''Description''' *set_offer_countries updates the countries authorized for a...")
PATCH /offer/set_offer_countries
Description
- set_offer_countries updates the countries authorized for an offer
Resource URL
- http://domain/api/offer/set_offer_countries
- Replace domain with the Offerit domain
Response Format
- JSON
- PATCH
- HTTP headers
Parameters
- offerid
- type: int
- required
- The offer to update
- authorized
- type: string,array
- A list of 2 character country codes that should be authorized. Everything not in the list will be unauthorized
- unauthorized
- type: string,array
- A list of 2 character country codes that should be unauthorized. Everything not in the list will be authorized
Example Request
PATCH
http://domain/api/offer/set_offer_countries offerid=1 authorized='DE,GB'
- Response:
{
"result":"Success",
}
Example Code
PHP
<?php
$url = 'http://domain/api/offer/set_offer_countries';
$curl = curl_init();
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
$data = Array(
'offerid' => 1,
'authorized' => 'DE,GB',
);
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);
?>
