SMS Signup/Notification API

This API is used for your customers to receive SMS notifications for certain changes that may occur to their orders. You can specifically select which change your customers should be notified of. This option is not available in the Free Plan

Step 1
In your WeSupply account, you have to make sure that SMS notification is enabled. For this, navigate to Settings → Notifications and check the Phone notifications for the desired action type, ex: Shipment received, Shipment in transit, Order received, Order cancelled… etc, and click SAVE

Step 2
Make a simple curl call with params order and phone, right after order placement (preferably from Thank You/ Order Success Page to notify WeSupply. The url of this call is:

https://wesupply_client_url/trackers/phone/enrol

<?php

$params = array("order" => ‘000000198’, "phone" => ‘1234567890’);
$buildQuery = http_build_query($params);

$url = “https://wesupply_client_url/trackers/phone/enrol”;

$curl = curl_init();

curl_setopt_array($curl, 
	array(  
	CURLOPT_URL => $url.’?’.$buildQuery,  
	CURLOPT_RETURNTRANSFER => true,  
	CURLOPT_MAXREDIRS => 10,  
	CURLOPT_TIMEOUT => 30,  
	CURLOPT_CUSTOMREQUEST => "GET",  
	CURLOPT_FOLLOWLOCATION => TRUE  
		));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err) {  
	echo "cURL Error #:" . $err;
	} else {  
	echo $response;	
	}

?>

Possible Responses:
"true" - the call went ok and WeSupply was successfully notified
“error”:“Parameters missing!” - there are missing parameters in your call (order or phone) or the phone parameter has a length smaller then 10

Estimate delivery date

Estimations based on Shipper replies
To get estimations based on Shipper replies, you will need to provide a list of parameters as follows:
ipAddress - the ip address of the customer (used to identify the customer’s delivery address post code)
supplierId - the id of the store from where the purchase is done
postcode - the post code of the customer, if empty the ipAddress will be used to identify the customer post code
countrycode - the country code of the customer ( must be 2 letter ISO code ex: US, GB, DE, IT ... ), if empty, the ipAddress will be used to identify the customer country code
price - total price in cart
currency - currency of your store
carriers - a list of all available shippers from your store;.
Available shippers at this moment are: UPS, USPS, FedEx

<?php
$accesToken = 'previously_generated';
$carriers = array('UPS');
$params = array('ipAddress' => '91.204.211.38', 'supplierId' => '1', 'postcode' => '', 'price' => '300.0000', 'currency' => 'USD', 'carriers' => $carriers);
$buildQuery = http_build_query($params);

$url = 'https://wesupply_client_url/api/shippingQuotes?'.$buildQuery;

$curl = curl_init();

curl_setopt_array($curl, array(

		CURLOPT_URL => $url,

		CURLOPT_RETURNTRANSFER => true,

		CURLOPT_ENCODING => "",

		CURLOPT_MAXREDIRS => 10,

		CURLOPT_TIMEOUT => 30,

		CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,

		CURLOPT_CUSTOMREQUEST => "GET",

		CURLOPT_FOLLOWLOCATION => TRUE,

		CURLOPT_HTTPHEADER => array("Authorization: Bearer $accesToken")

));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err) {

	echo "cURL Error #:" . $err;

} else {

	echo $response;

}

?>

You will receive a JSON Object response as follows:

{
	"UPS":{
		"1DM":1542758400,
		"1DA":1542758400,
		"1DP":1542758400,
		"GND":1542758400
		}
}

For each carrier requested you will receive a list of services and estimation arrival date for that service in timestamp format

My Account view order link

This API provides a direct link to WeSupply, where your customers can see a detailed page regarding their order

<?php				
$accesToken = 'previously_generated'
$externalOrderIdString = '00000001,0000002,0000003';
$params = array("orders"=>$externalOrderIdString);
$buildQuery = http_build_query($params);
$url = 'http://wesupply_client_url/api/authLinks?'.$buildQuery;
$curl = curl_init();

curl_setopt_array($curl, 
	array(    
		CURLOPT_URL => $url,
		CURLOPT_RETURNTRANSFER => true,
		CURLOPT_ENCODING => "", 
		CURLOPT_MAXREDIRS => 10,
		CURLOPT_TIMEOUT => 30,
		CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
		CURLOPT_CUSTOMREQUEST => "GET",
		CURLOPT_FOLLOWLOCATION => TRUE,
		CURLOPT_HTTPHEADER => array("Authorization: Bearer $accesToken")
		));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err) { 
   echo "cURL Error #:" . $err;
 } else { 
   echo $response;
 }
?>
			

If everything went ok, you should receive an json object response as follows
“order_id_1” => “link”,
“order_id_2” => “link2”
…
“order_id_N” => “linkN”
If one of the requested order id’s does not exist yet in WeSupply, then it will not appear in the response.
Response example:

{
	"00000001":"http://wesupply_client_url/vieworder?k=W%2BEKKeKccfy",
	"0000002":"http://wesupply_client_url/vieworder?k=RR4weT5iuvJ9QKW2",
	"0000003":"http://wesupply_client_url/vieworder?k=0%2B1tKpqbJBW%2FP2D"
}

Grab Returns

This API allows you to get a list of all returns made to your orders, from WeSupply.
Condition - account type must be startup or professional

<?php			

$curl = curl_init();
$url = "https://wesupply_client_url/api/returns";
$accesToken = 'previously_generated'

curl_setopt_array($curl, array(
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer $accesToken",
    "Content-Type: application/x-www-form-urlencoded",
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

You receive a Json Object as a response as follows:

[
{
        "return_number": "11111",
        "created_at": 1558356599,
        "updated_at": 1558356599,
        "state": "refunded",
        "return_comment": "test 23",
        "return_logic": {
            "id": 1554123772810,
            "name": "Caa",
            "priority": 5,
            "return_window": 348,
            "requires_authorization": {
                "auth_type": "automatic",
                "state": "pending"
            }
        },
        "logistics": {
            "return_store_id": "",
            "return_label_cost": 0,
            "return_location": {
                "address_1": "",
                "address_2": "",
                "city": "",
                "state": "",
                "zip_code": "",
                "country": ""
            },
            "return_shipping_info": {
                "tracking_number": "",
                "return_carrier": "",
                "status": "",
                "at": ""
            }
        },
        "refund_currency": false,
        "refund_cost": "free",
        "refund_control": {
            "refund_cost_value": 0,
            "refund_shipping_fee": "no",
            "refund_shipping_fee_value": 0,
            "refund_type": {
                "type": "refund",
                "total_value": 47.55,
                "refund_status": "Refunded",
                "at": 1558432179
            }
        },
        "customer": {
            "id": "52345",
            "email": "ionuthrive@yahoo.com"
        },
        "order": {
            "created_at": "2019-01-03T08:22:43",
            "number_ext": "KICKS100000000115879",
            "number_int": "68089"
        },
        "items": [
            {
                "id": "117891",
                "name": "Title unavailable",
                "qty": 1,
                "sku": "836277-091",
                "return_reason": "Damaged in Shipment",
                "price": 45.55,
                "restock_item": "False"
            }
        ]
    }
]

Flag Processed Returns

If your application was successful in processing a return, you can notify the WeSupply API so as not to receive that same return in the future.

<?php			

$curl = curl_init();
$url = "https://wesupply_client_url/api/returns";
$accesToken = 'previously_generated'
$params = "references=11111&references=22222",

curl_setopt_array($curl, array(
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => $params,
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer $accesToken",
    "Content-Type: application/x-www-form-urlencoded",
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

If everything went ok, you will receive a response as follows:

{
    "success": true,
    "references": [
        "11111",
        "22222"
    ]
}