Difference between revisions of "Offerit REST API Check Orderid Exists"
From Offerit
OfferitRob (talk | contribs) (→GET /offer/check_orderid_exists) |
OfferitRob (talk | contribs) |
||
Line 23: | Line 23: | ||
== '''Parameters''' == | == '''Parameters''' == | ||
* '''orderid''' - The orderid to check. | * '''orderid''' - The orderid to check. | ||
+ | |||
+ | == '''Responses''' == | ||
+ | * Orderid found | ||
+ | ** {"result":"success","message":"TRUE"} | ||
+ | * Orderid not found | ||
+ | ** {"result":"success","message":"FALSE"} | ||
== '''Example Code''' == | == '''Example Code''' == | ||
− | |||
'''PHP''' | '''PHP''' | ||
<pre> | <pre> |
Revision as of 11:46, 6 June 2016
GET /offer/check_orderid_exists
Description
- Offerit supports an API resource to check if an orderid exists.
Resource URL
- http://domain/api/offer/check_orderid_exists
- Replace domain with the Offerit domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
- orderid - The orderid to check.
Responses
- Orderid found
- {"result":"success","message":"TRUE"}
- Orderid not found
- {"result":"success","message":"FALSE"}
Example Code
PHP
<?php $curl = curl_init(); $data = array( 'orderid' => '12345678', ); $data_string = http_build_query($data); $url = 'http://domain/api/offer/check_orderid_exists?'.$data_string; $headers = array( 'api-key: 44b5498dbcb481a0d00b404c0169af62', 'api-username: productsupport' ); curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_URL, $url); $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); ?>