CleanCloud API](/content/site-root.html)

PHPcURLJavascriptNode.jsPythonRubyIntroduction Getting Started Create Customer Update Customer Delete Customer Login Customer Get Customer Information Reset Customer Password Create Order Update an Order Delete an Order Get a Garment Get all Garments in Order Update a Garment Create Repeat Pickup Update Repeat Pickup Delete Repeat Pickup Get Repeat Pickups Create Message Get Messages Get Orders Get Price Lists Get Products Get Inventory Get Invoices Get Payments Get Pickup/Delivery Dates Get Pickup/Delivery Times Get Route from Lat/Lng Get Business Accounts Get Referral Code and Gift Use Promo Code Convert Loyalty Points Add Subscription Delete Subscription Get Subscription Add Credit Card Charge Credit Card Get Credit Cards Set Default Credit Card Add Push Token Delete Push Token Add To Customer Group Daily Summary Driver Location Get Photos

Introduction

The CleanCloud API allows you to send information into and out of CleanCloud. It is typically used for the following use cases

• You have made your own iOS/Android pickup and delivery app and wish to integrate with CleanCloud
• You wish to get a list of orders for a customer account using your own dashboard
• Accessing order and summary data for reporting or accounting purposes

The API is a RESTful API, and requires you to use POST requests to communicate with it. You can use any programming language to communicate with the API, and we have code examples for PHP, cURL, Javascript, node.js, Python and Ruby. You can switch the code examples between languages using the dropdown at the top left.

The API requires you to have Grow or Grow+ subscription and is limited to 50,000 requests per month, with a maximum of 3 requests per second. If you require more capacity please contact your CleanCloud Account Manager.

Getting Started

To begin you will need to:

• Have created an account with CleanCloud ( https://cleancloudapp.com/register)
• Obtained your API key from the Admin->Pickup and Delivery->API section

Once done you be able to complete the following tasks

• Create a Customer Account
• Update a Customer Account
• Delete a Customer
• Login Customer
• Get Customer Information
• Reset Customer Password
• Create an Order
• Update an Order
• Delete an Order
• Get a Garment
• Get all Garments in Order
• Update a Garment
• Create Repeat Pickup
• Update Repeat Pickup
• Delete Repeat pickup
• Get Repeat Pickups
• Create Message
• Get Messages
• Get Order(s) Details
• Get Price Lists
• Get Products
• Get Inventory
• Get Invoices
• Get Payments
• Get Pickup/Delivery Dates
• Get Available Pickup/Delivery Time Slots
• Get Route Number From Latitude/Longitude
• Get Business Accounts
• Get Referral Code and Gift
• Use Promo Code
• Convert Loyalty Points
• Add Subscription to Customer Account
• Delete Subscription
• Get Subscription
• Add Credit Card
• Charge Credit Card
• Get Credit Cards
• Set Default Credit Card
• Add Push Token (for your custom app)
• Delete Push Token
• Add To Customer Group
• Get Summary Metrics By Day
• Get Driver Location Associated with an Order
• Get Photos

Create a Customer Account

To create a customer account you send a POST request to https://cleancloudapp.com/api/addCustomer with the below parameters. The response will contain the ID of the newly created customer account which you will need to store on your server to perform other tasks for this customer.

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "customerName": "John Doe", "customerTel": "5554432324", "customerEmail": "emailexample@email.com", "customerAddress": "113 Street Avenue, New York, 10012", "customerNotes": "Notes about the customer" }"
'https://cleancloudapp.com/api/addCustomer' `` //SET YOUR TOKEN HERE $api_token = "MY_API_TOKEN"; $url="https://cleancloudapp.com/api/addCustomer";

//CREATE JSON ARRAY TO SEND $jsonArray = array('api_token' => $api_token, 'customerName' => 'John Doe', 'customerTel' => '5554432324', 'customerEmail' => 'emailexample@email.com', 'customerAddress' => '113 Street Avenue, New York, 10012', 'customerNotes' => 'Notes about the customer'); $postFields = json_encode($jsonArray);

//SEND TO CLEANCLOUD API USING CURL

$ch = curl_init($url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_HEADER, FALSE); curl_setopt($ch, CURLOPT_HTTPHEADER, array("Content-Type: application/json")); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POSTFIELDS,$postFields);

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") { //SUCCESS AND RETURNS CUSTOMER ID. YOU WILL NEED THIS CUSTOMER ID FOR WHEN YOU SEND IN NEW ORDERS INTO CLEANCLOUD echo "Success Submitting to API with New Customer ID: ".$json_response->CustomerID; } else if($json_response->Error!="") { echo "Error Submitting to API: ".$json_response->Error; die(); }

}

``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/addCustomer');

request.setRequestHeader('Content-Type', 'application/json');

request.onreadystatechange = function () { if (this.readyState === 4) { console.log('Status:', this.status); console.log('Headers:', this.getAllResponseHeaders()); console.log('Body:', this.responseText); } };

var body = { 'api_token': 'MY_API_TOKEN', 'customerName': 'John Doe', 'customerTel': '5554432324', 'customerEmail': 'emailexample@email.com', 'customerAddress': '113 Street Avenue, New York, 10012', 'customerNotes': 'Notes about the customer' };

request.send(JSON.stringify(body)); `` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/addCustomer', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "customerName": "John Doe", "customerTel": "5554432324", "customerEmail": "emailexample@email.com", "customerAddress": "113 Street Avenue, New York, 10012", "customerNotes": "Notes about the customer"}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); });

`` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "customerName": "John Doe", "customerTel": "5554432324", "customerEmail": "emailexample@email.com", "customerAddress": "113 Street Avenue, New York, 10012", "customerNotes": "Notes about the customer" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/addCustomer', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "customerName": "John Doe", "customerTel": "5554432324", "customerEmail": "emailexample@email.com", "customerAddress": "113 Street Avenue, New York, 10012", "customerNotes": "Notes about the customer" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/addCustomer', values, headers puts response `

Update a Customer Account

To update a customer account you send a POST request to https://cleancloudapp.com/api/updateCustomer with the below parameters. Only submit the parameters that you wish to update.

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "customerID": "1", "customerTel": "5554432324" }"
'https://cleancloudapp.com/api/updateCustomer' `` //SET PARAMETERS $api_token = "MY_API_TOKEN"; $url="https://cleancloudapp.com/api/updateCustomer";

//SET CUSTOMER ID. THIS IS THE CUSTOMER YOU ARE UPDATING $customerID="1"; /// ///WHEN UPDATING YOU SHOULD ONLY SEND THE FIELDS THAT WISH TO UPDATE. ///

//EXAMPLE 1: CHANGE ONLY CUSTOMER PHONE NUMBER $jsonArray = array("api_token" => $api_token, "customerID" => $customerID, "customerTel" => "55512321");

//EXAMPLE 2: UPDATE ALL AVAILABLE FIELDS IN THE API

$jsonArray = array("api_token" => $api_token, "customerID" => $customerID, "customerName" => "New Name", "customerTel" => "12345", "customerEmail" => "apiupdate@cleancloudapp.com", "customerAddress" => "20 API Street, API Land", "customerNotes" => "New Customer Notes from API");

$postFields = json_encode($jsonArray);

//SEND TO CLEANCLOUD API USING CURL

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") { //CUSTOMER UPDATED echo "Success Submitting to API";

} else if($json_response->Error!="") { //ERROR WITH DATA THAT SENT TO CLEANCLOUD. PLEASE CORRECT THE ERROR MENTIONED echo "Error Submitting to API: ".$json_response->Error; die(); }

}

``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/updateCustomer');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'customerID': '1', 'customerTel': '5554432324' };

request.send(JSON.stringify(body)); `` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/updateCustomer', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "customerID": "1", "customerTel": "5554432324"}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); }); `` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "customerID": "1", "customerTel": "5554432324" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/updateCustomer', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "customerID": "1", "customerTel": "5554432324" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/updateCustomer', values, headers puts response `

Delete a Customer Account

To update a customer account you send a POST request to https://cleancloudapp.com/api/deleteCustomer with the below parameters.

Login to Customer Account

To check the email and password of a customer and retrieve their customer ID you can send a POST request to https://cleancloudapp.com/api/loginCustomer with the below parameters

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "customerEmail": "emailexample@email.com", "customerPassword": "thisWasMyPassword" }"
'https://cleancloudapp.com/api/loginCustomer'

`` //SET PARAMETERS $api_token = "MY_API_TOKEN"; $url="https://cleancloudapp.com/api/loginCustomer";

/// //CREATE JSON ARRAY ///

$jsonArray = array("api_token" => $api_token, "customerEmail" => "emailexample@email.com", "customerPassword" => "thisWasMyPassword"); $postFields = json_encode($jsonArray);

//SEND TO CLEANCLOUD API USING CURL $ch = curl_init($url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_HEADER, FALSE); curl_setopt($ch, CURLOPT_HTTPHEADER, array("Content-Type: application/json")); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POSTFIELDS,$postFields);

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") { //SUCCESSFUL LOGIN echo "Success Logging In with ID: ".$json_response->cid; } else if($json_response->Error!="") { //ERROR WITH DATA THAT SENT TO CLEANCLOUD. PLEASE CORRECT THE ERROR MENTIONED echo "Error Submitting to API: ".$json_response->Error; die(); }

} ``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/loginCustomer');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'customerEmail': 'emailexample@email.com', 'customerPassword': 'thisWasMyPassword' };

request.send(JSON.stringify(body)); `` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/loginCustomer', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "customerEmail": "emailexample@email.com", "customerPassword": "thisWasMyPassword"}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); }); `` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "customerEmail": "emailexample@email.com", "customerPassword": "thisWasMyPassword" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/loginCustomer', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "customerEmail": "emailexample@email.com", "customerPassword": "thisWasMyPassword" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/loginCustomer', values, headers puts response `

Get Customer Information

To retrieve available information about a particular customer, or customers that signed up within a date range, you send a POST request to https://cleancloudapp.com/api/getCustomer with the below parameters.

Note that the response is structured differently if you are requesting customers by date range. Date Range is also limited to 31 days.

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "customerID": "1" }"
'https://cleancloudapp.com/api/getCustomer' `` //SET TOKEN $api_token = "MY_API_TOKEN";

//URL FOR GET CUSTOMER $url="https://cleancloudapp.com/api/getCustomer";

//CUSTOMER ID THAT YOU WANT INFORMATION FOR $customerID="12";

$jsonArray = array("api_token" => $api_token, "customerID" => $customerID); $postFields = json_encode($jsonArray);

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") {

//SUCCESS echo "Success Getting Customer Information: ".$json_response->Success;

//SHOW RESPONSE IN JSON var_dump($json_response);

} else if($json_response->Error!="") {

//ERROR WITH DATA THAT SENT TO CLEANCLOUD echo "Error Submitting to API: ".$json_response->Error; die(); }

}

``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/getCustomer');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'customerID': '1' };

request.send(JSON.stringify(body)); `` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/getCustomer', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "customerID": "1"}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); });

`` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "customerID": "1" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/getCustomer', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "customerID": "1" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/getCustomer', values, headers puts response

`

Reset Customer Password

To iniate a password reset for a customer and send them an email with reset instructions you send a POST request to https://cleancloudapp.com/api/passwordCustomer with the below parameters

Create an Order

To create an order you send a POST request to https://cleancloudapp.com/api/addOrder with the below parameters. You will need the ID of the customer account that you are creating the order for. This ID is obtained when you create a customer using the API.

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "customerID": "1", "products": [{ "id": "10", "price": "45", "pieces": "1", "quantity": "1", "name": "Product Name"},
{"id": "9", "price": "20", "pieces": "2", "quantity": "2", "name": "Second Product"},
{"id": "0", "price": "10", "pieces": "1", "quantity": "3", "name": "Custom Product Name"}], "discount": "1.03", "tax": "1.08", "finalTotal": "10.60", "pickupDate": "1505736000", "pickupStart": "10am", "pickupEnd": "11am", "delivery": "1", "deliveryDate": "1506686400", "deliveryStart": "1pm", "deliveryEnd": "2pm", "orderNotes": "Notes for the Order", "notifyMethod": "2", "priceListID": "" }"
'https://cleancloudapp.com/api/addOrder' `` //SET PARAMETERS $api_token = "MY_API_TOKEN"; $url="https://cleancloudapp.com/api/addOrder";

//SET CUSTOMER ID $customerID="1";

//CREATE LIST OF PRODUCTS OF ORDER IN AN ARRAY

$products_array = array();

//NOTES: /// ID CORRESPONDS TO ID OF PRODUCT IN YOUR CLEANCLOUD ACCOUNT, IF ITEM DOES NOT EXIST IN CLEANCLOUD THEN CREATE ONE TIME CUSTOM ITEM BY SETTING ID TO 0. YOU CAN USE UP TO 5 CUSTOM PRODUCTS PER ORDER /// ALL FIELDS MUST BE PROVIDED /// PIECES IS PIECES PER ITEM. FOR EXAMPLE SPECIFYING 2 PIECES AND 2 QUANTITY MEANS 4 PIECES IN TOTAL /// PRICE IS PRICE PER ITEM. FOR EXAMPLE PRICE OF $20 AND QUANTITY OF 2 MEANS $40 TOTAL

$product1 = array("id" => "10", "price" => "45", "pieces" => "1", "quantity" => "1", "name" => "Product Name"); $product2 = array("id" => "9", "price" => "20", "pieces" => "2", "quantity" => "2", "name" => "Second Product"); $productCustom = array("id" => "0", "price" => "10", "pieces" => "1", "quantity" => "3", "name" => "Custom Product Name");

//PUSH ITEMS INTO PRODUCTS ARRAY FOR JSON. PRODUCTS ARRAY WILL BE NESTED INSIDE THE MAIN JSON ARRAY SENT TO CLEANCLOUD API $products_array[] = $product1; $products_array[] = $product2; $products_array[] = $productCustom;

/// //CREATE JSON ARRAY ///

$jsonArray = array("api_token" => $api_token, "customerID" => $customerID, "products" => $products_array, "discount" => "1.05", "tax" => "1.07", "finalTotal" => "10.06", "pickupStart" => "10am", "pickupDate" => "1505736000", "pickupEnd" => "11am", "delivery" => "1", "deliveryDate" => "1506686400","deliveryStart" => "1pm", "deliveryEnd" => "2pm", "orderNotes" => "Notes for the Order", "notifyMethod" => "2", "priceListID" => ""); $postFields = json_encode($jsonArray);

//SEND TO CLEANCLOUD API USING CURL

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") { //ORDER SUCCESSFULLY INSERTED INTO CLEANCLOUD ACCOUNT AND RETURNS ORDER ID FROM CLEANCLOUD echo "Success Submitting to API with New ORDER ID: ".$json_response->orderID; } else if($json_response->Error!="") { //ERROR WITH DATA THAT SENT TO CLEANCLOUD, ORDER WAS NOT INSERTED INTO ACCOUNT. PLEASE CORRECT THE ERROR MENTIONED echo "Error Submitting to API: ".$json_response->Error; die(); }

}

``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/addOrder');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'customerID': '1', 'products': [{ 'id': '10', 'price': '45', 'pieces': '1', 'quantity': '1', 'name': 'Product Name'},
{'id': '9', 'price': '20', 'pieces': '2', 'quantity': '2', 'name': 'Second Product'},
{'id': '0', 'price': '10', 'pieces': '1', 'quantity': '3', 'name': 'Custom Product Name'}], 'discount': '1.03', 'tax': '1.08', 'finalTotal': '10.60', 'pickupDate': '1505736000', 'pickupStart': '10am', 'pickupEnd': '11am', 'delivery': '1', 'deliveryDate': '1506686400', 'deliveryStart': '1pm', 'deliveryEnd': '2pm', 'orderNotes': 'Notes for the Order', 'notifyMethod': '2', 'priceListID': '' };

request.send(JSON.stringify(body)); `` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/addOrder', headers: { 'Content-Type': 'application/json' }, body: "{"api_token": "MY_API_TOKEN", "customerID": "1", "products": [{ "id": "10", "price": "45", "pieces": "1", "quantity": "1", "name": "Product Name"}, {"id": "9", "price": "20", "pieces": "2", "quantity": "2", "name": "Second Product"}, {"id": "0", "price": "10", "pieces": "1", "quantity": "3", "name": "Custom Product Name"}], "discount": "1.03", "tax": "1.08", "finalTotal": "10.60", "pickupDate": "1505736000", "pickupStart": "10am", "pickupEnd": "11am", "delivery": "1", "deliveryDate": "1506686400", "deliveryStart": "1pm", "deliveryEnd": "2pm", "orderNotes": "Notes for the Order", "notifyMethod": "2", "priceListID": ""}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); }); `` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "customerID": "1", "products": [{ "id": "10", "price": "45", "pieces": "1", "quantity": "1", "name": "Product Name"},
{"id": "9", "price": "20", "pieces": "2", "quantity": "2", "name": "Second Product"},
{"id": "0", "price": "10", "pieces": "1", "quantity": "3", "name": "Custom Product Name"}], "discount": "1.03", "tax": "1.08", "finalTotal": "10.60", "pickupDate": "1505736000", "pickupStart": "10am", "pickupEnd": "11am", "delivery": "1", "deliveryDate": "1506686400", "deliveryStart": "1pm", "deliveryEnd": "2pm", "orderNotes": "Notes for the Order", "notifyMethod": "2", "priceListID": "" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/addOrder', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "customerID": "1", "products": [{ "id": "10", "price": "45", "pieces": "1", "quantity": "1", "name": "Product Name"},
{"id": "9", "price": "20", "pieces": "2", "quantity": "2", "name": "Second Product"},
{"id": "0", "price": "10", "pieces": "1", "quantity": "3", "name": "Custom Product Name"}], "discount": "1.03", "tax": "1.08", "finalTotal": "10.60", "pickupDate": "1505736000", "pickupStart": "10am", "pickupEnd": "11am", "delivery": "1", "deliveryDate": "1506686400", "deliveryStart": "1pm", "deliveryEnd": "2pm", "orderNotes": "Notes for the Order", "notifyMethod": "2", "priceListID": "" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/addOrder', values, headers puts response `

Update an Order

To update an order you send a POST request to https://cleancloudapp.com/api/updateOrder with the below parameters. You will need the ID of the order that you are updating. Only submit the parameters that you wish to update.

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "orderID": "1", "status": "2" }"
'https://cleancloudapp.com/api/updateOrder' `` //SET PARAMETERS $api_token = "MY_API_TOKEN"; $url="https://cleancloudapp.com/api/updateOrder";

//SET ORDER ID. THIS IS THE ORDER ID YOU ARE UPDATING $orderID="255";

/// ///WHEN UPDATING YOU SHOULD ONLY SEND THE FIELDS THAT WISH TO UPDATE. ///

//EXAMPLE 1: SET ORDER AS PAID, WITH PAYMENT TYPE PAID BY CARD $jsonArray = array("api_token" => $api_token, "orderID" => $orderID, "paid" => "1", "paymentType" => "2");

//EXAMPLE 2: JUST UPDATING STATUS OF ORDER $jsonArray = array("api_token" => $api_token, "orderID" => $orderID, "status" => "2");

//EXAMPLE 3: UPDATE LOTS OF FIELDS IN THE API, INCLUDING CHANGING THE CUSTOMER ID $customerID = 1; $jsonArray = array("api_token" => $api_token, "orderID" => $orderID, "customerID" => $customerID, "status" => "2", "discount" => "1.05","discount" => "1.05", "tax" => "1.07", "tax2" => "0.95", "finalTotal" => "10.06", "pickupStart" => "10am", "pickupDate" => "1505736000", "pickupEnd" => "11am", "delivery" => "1", "deliveryDate" => "1506686400","deliveryStart" => "1pm", "deliveryEnd" => "2pm", "orderNotes" => "New Notes for the Order", "paid" => "1", "paymentType" => "2");

$postFields = json_encode($jsonArray);

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") { //ORDER SUCCESSFULLY UPDATED echo "Success Submitting to API";

} else if($json_response->Error!="") { //ERROR WITH DATA THAT SENT TO CLEANCLOUD echo "Error Submitting to API: ".$json_response->Error; die(); }

} ``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/updateOrder');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'orderID': '1', 'status': '2' };

request.send(JSON.stringify(body));

`` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/updateOrder', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "orderID": "1", "status": "2"}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); }); `` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "orderID": "1", "status": "2" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/updateOrder', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "orderID": "1", "status": "2" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/updateOrder', values, headers puts response `

Delete an Order

You can delete an existing order by sending a POST request to https://cleancloudapp.com/api/deleteOrder with the below parameters

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "orderID": "1" }"
'https://cleancloudapp.com/api/deleteOrder' `` //SET PARAMETERS $api_token = "MY_API_TOKEN"; $url="https://cleancloudapp.com/api/deleteOrder";

$orderID="670";

$jsonArray = array("api_token" => $api_token, "orderID" => $orderID); $postFields = json_encode($jsonArray);

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else { if($json_response->Success=="True") { echo "Success"; //SHOW RESPONSE IN JSON var_dump($json_response); } else if($json_response->Error!="") { //ERROR WITH DATA THAT SENT TO CLEANCLOUD. PLEASE CORRECT THE ERROR MENTIONED echo "Error Submitting to API: ".$json_response->Error; die(); }

} ``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/deleteOrder');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'orderID': '1' };

request.send(JSON.stringify(body)); `` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/deleteOrder', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "orderID": "1"}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); }); `` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "orderID": "1" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/deleteOrder', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "orderID": "1" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/deleteOrder', values, headers puts response `

Get a Garment

You can get information about a particular garment in an order by sending a POST request to https://cleancloudapp.com/api/getGarment with the below parameters.

Get All Garments in an Order

You can get information about all individual garments of a particular order by sending a POST request to https://cleancloudapp.com/api/getGarments with the below parameters.

Update a Garment

You can update details about an existing garment by sending a POST request to https://cleancloudapp.com/api/updateGarment with the below parameters. Only send the optional fields that you wish to update.

Create Repeat Pickup

Create a Repeat Pickup scheduler by sending a POST request to https://cleancloudapp.com/api/repeatPickup with the below parameters

Update Repeat Pickup

Update an Existing Repeat Pickup scheduler by sending a POST request to https://cleancloudapp.com/api/updateRepeatPickup with the below parameters

Delete Repeat Pickup

Delete a Repeat Pickup for a customer by sending a POST request to https://cleancloudapp.com/api/deletePickup with the below parameters

Get Repeat Pickups

Get a list of Repeat Pickups for a customer by sending a POST request to https://cleancloudapp.com/api/getPickups with the below parameters

Create Message

This POST request to https://cleancloudapp.com/api/addMessage allows you send a message from the customer to the store.

Get List of Messages

This POST request to https://cleancloudapp.com/api/getMessages allows you to return a JSON response of the messaging history with a customer.

Get List of Orders

This POST request to https://cleancloudapp.com/api/getOrders allows you to return a JSON response of details for a particular order or multiple orders, which can be filtered using the parameters below.

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "customerID": "1" }"
'https://cleancloudapp.com/api/getOrders' `` //SET TOKEN $api_token = "MY_API_TOKEN";

//URL FOR GET ORDERS $url="https://cleancloudapp.com/api/getOrders";

//CUSTOMER ID $customerID="19";

$jsonArray = array("api_token" => $api_token, "customerID" => $customerID); $postFields = json_encode($jsonArray);

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") {

echo "Success Getting Orders: ".$json_response->Success;

//SHOW RESPONSE IN JSON var_dump($json_response);

} else if($json_response->Error!="") {

//ERROR WITH DATA SENT TO CLEANCLOUD echo "Error Submitting to API: ".$json_response->Error; die(); }

}

``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/getOrders');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'customerID': '1' };

request.send(JSON.stringify(body)); `` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/getOrders', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "customerID": "1"}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); }); `` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "customerID": "1" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/getOrders', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "customerID": "1" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/getOrders', values, headers puts response `

Get Price Lists

This POST request to https://cleancloudapp.com/api/getPriceLists allows you to return a JSON response of all the active price lists for a store, by sending the following parameters.

Get List of Products

This POST request to https://cleancloudapp.com/api/getProducts allows you to return a JSON response of all active products, by sending the following parameters.

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "priceListID": "" }"
'https://cleancloudapp.com/api/getProducts' `` //SET TOKEN $api_token = "MY_API_TOKEN";

//URL FOR GET PRODUCTS $url="https://cleancloudapp.com/api/getProducts";

//PRICE LIST ID (optional) $priceListID="";

$jsonArray = array("api_token" => $api_token, "priceListID" => $priceListID); $postFields = json_encode($jsonArray);

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") {

echo "Success Getting Products: ".$json_response->Success;

//SHOW RESPONSE IN JSON var_dump($json_response);

} else if($json_response->Error!="") {

//ERROR WITH DATA SENT TO CLEANCLOUD echo "Error Submitting to API: ".$json_response->Error; die(); }

}

``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/getProducts');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'priceListID': '' };

request.send(JSON.stringify(body));

`` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/getProducts', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "priceListID": ""}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); }); `` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "priceListID": "" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/getProducts', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "priceListID": "" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/getProducts', values, headers puts response `

Get Inventory

This POST request to https://cleancloudapp.com/api/getInventory returns a JSON response of the current inventory levels of all inventory products in your store.

Get Invoices

This POST request to https://cleancloudapp.com/api/getInvoices returns a JSON response of the Invoices you have created.

Get Payments

This POST request to https://cleancloudapp.com/api/getPayments returns a JSON response of all the payments that have happened on your account.

Get Available Pickup/Delivery Dates

This POST request to https://cleancloudapp.com/api/getDates allows you to return a JSON response of all the available pickup and delivery dates with their available slot times for a particular route, by sending the following parameters. The response will contain a list of dates, with available slot times and the remaining number of available slots.

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "routeID": "1", "day": "1558353600" }"
'https://cleancloudapp.com/api/getDates' `` //SET TOKEN $api_token = "MY_API_TOKEN";

//URL FOR GET DATES $url="https://cleancloudapp.com/api/getDates";

$jsonArray = array("api_token" => $api_token, "routeID" => '1'); $postFields = json_encode($jsonArray);

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") {

//SHOW RESPONSE IN JSON var_dump($json_response);

} else if($json_response->Error!="") {

//ERROR WITH DATA THAT SENT TO CLEANCLOUD echo "Error Submitting to API: ".$json_response->Error; die();

}

} ``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/getDates');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'routeID': '1' };

request.send(JSON.stringify(body));

`` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/getDates', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "routeID": "1"}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); }); `` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "routeID": "1" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/getDates', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "routeID": "1" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/getDates', values, headers puts response `

Get Available Pickup/Delivery Times

This POST request to https://cleancloudapp.com/api/getSlots allows you to return a JSON response of all the available pickup and delivery slots for a particular route on a particular day, by sending the following parameters. The response will contain a comma separated list of available slot times.

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "routeID": "1", "day": "1558353600" }"
'https://cleancloudapp.com/api/getSlots' `` //SET TOKEN $api_token = "MY_API_TOKEN";

//URL FOR GET SLOTS $url="https://cleancloudapp.com/api/getSlots";

$jsonArray = array("api_token" => $api_token, "routeID" => '1', "day" => '1558353600'); $postFields = json_encode($jsonArray);

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") {

//SHOW RESPONSE IN JSON var_dump($json_response);

} else if($json_response->Error!="") {

//ERROR WITH DATA THAT SENT TO CLEANCLOUD echo "Error Submitting to API: ".$json_response->Error; die();

}

} ``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/getSlots');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'routeID': '1', 'day': '1558353600' };

request.send(JSON.stringify(body));

`` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/getSlots', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "routeID": "1", "day": "1558353600"}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); }); `` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "routeID": "1", "day": "1558353600" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/getSlots', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "routeID": "1", "day": "1558353600" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/getSlots', values, headers puts response `

Get Route Number from Latitude/Longitude or Address

This POST request to https://cleancloudapp.com/api/getRoute allows you to send in latitude/longitude values for a customer's address or their street address and the response will provide a JSON response with the route number. If no route is available for that route an error will return.

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "lat": "10.14", "lng": "34.43" }"
'https://cleancloudapp.com/api/getRoute' `` //SET TOKEN $api_token = "MY_API_TOKEN";

//URL FOR GET SLOTS $url="https://cleancloudapp.com/api/getRoute";

$jsonArray = array("api_token" => $api_token, "lat" => '10.14', "lng" => '34.43'); $postFields = json_encode($jsonArray);

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") {

//SHOW RESPONSE IN JSON var_dump($json_response);

} else if($json_response->Error!="") {

//ERROR WITH DATA THAT SENT TO CLEANCLOUD echo "Error Submitting to API: ".$json_response->Error; die();

}

} ``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/getRoute');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'lat': '10.14', 'lng': '34.43' };

request.send(JSON.stringify(body));

`` var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/getRoute', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "lat": "10.14", "lng": "34.43"}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); }); `` from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "lat": "10.14", "lng": "34.43" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/getRoute', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "lat": "10.14", "lng": "34.43" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/getRoute', values, headers puts response `

Get Business Accounts

This POST request to https://cleancloudapp.com/api/getBusinessAccounts allows you to retrieve information about the business accounts you have setup on your store.

Get Referral Code and Gift

This POST request to https://cleancloudapp.com/api/getReferral allows you to get the unique referral code for a customer and the gift that they and the customer they they refer will receive

PHP Code Example

cURL Code Example

Java Code Example

Javascript Code Example

Node.js Code Example

Python Code Example

Ruby Code Example

` curl --include
--request POST
--header "Content-Type: application/json"
--data-binary "{ "api_token":"MY_API_TOKEN", "customerID": "1" }"
'https://cleancloudapp.com/api/getReferral' `` //SET TOKEN $api_token = "MY_API_TOKEN";

//URL FOR GET CUSTOMER $url="https://cleancloudapp.com/api/getReferral";

//CUSTOMER ID THAT YOU WANT INFORMATION FOR $customerID="12";

$jsonArray = array("api_token" => $api_token, "customerID" => $customerID); $postFields = json_encode($jsonArray);

$response = curl_exec($ch); curl_close($ch); $json_response=json_decode($response);

if(curl_error($ch)) { //ERROR SENDING TO CLEANCLOUD API echo "Error with cURL Submitting to API: ".curl_error($ch); die(); } else {

if($json_response->Success=="True") {

//SUCCESS echo "Success Getting Customer Information: ".$json_response->Success;

//SHOW RESPONSE IN JSON var_dump($json_response);

} else if($json_response->Error!="") {

//ERROR WITH DATA THAT SENT TO CLEANCLOUD echo "Error Submitting to API: ".$json_response->Error; die(); }

}

``

`` var request = new XMLHttpRequest();

request.open('POST', 'https://cleancloudapp.com/api/getReferral');

request.setRequestHeader('Content-Type', 'application/json');

var body = { 'api_token': 'MY_API_TOKEN', 'customerID': '1' };

request.send(JSON.stringify(body)); ``

var request = require('request');

request({ method: 'POST', url: 'https://cleancloudapp.com/api/getReferral', headers: { 'Content-Type': 'application/json' }, body: "{ "api_token": "MY_API_TOKEN", "customerID": "1"}" }, function (error, response, body) { console.log('Status:', response.statusCode); console.log('Headers:', JSON.stringify(response.headers)); console.log('Response:', body); });

``

from urllib2 import Request, urlopen

values = """ { "api_token": "MY_API_TOKEN", "customerID": "1" } """

headers = { 'Content-Type': 'application/json' } request = Request('https://cleancloudapp.com/api/getReferral', data=values, headers=headers)

response_body = urlopen(request).read() print response_body `` require 'rubygems' if RUBY_VERSION < '1.9' require 'rest_client'

values = '{ "api_token": "MY_API_TOKEN", "customerID": "1" }'

headers = { :content_type => 'application/json' }

response = RestClient.post 'https://cleancloudapp.com/api/getReferral', values, headers puts response

`

Use Promo Code

This POST request to https://cleancloudapp.com/api/usePromo allows you use a promo code. This will update the customer's account with their new discount/credit level and the response will contain the discount percentage or credit amount to apply to the customer's order

Convert Loyalty Points to Credit

This POST request to https://cleancloudapp.com/api/convertLoyaltyPoints allows you convert a customer's unused loyalty points to credit. This will update the customer's account with their new total credit level and the response will contain information about the new total credit amount as well as the credit gained

Add Subscription to Customer Account

This POST request to https://cleancloudapp.com/api/addSubscription allows you to subscribe a customer to a regular subscription created in Clearent/Stripe and begin charging them. If the Error response is "3D Secure Authentication required", then you will need to prompt the user to authenticate, then send again with subscriptionConfirmed = 1 if authentication was successful.

Delete Subscription from a Customer Account

This POST request to https://cleancloudapp.com/api/deleteSubscription allows you to delete the subscription on a customer's account.

Get Subscription from a Customer Account

This POST request to https://cleancloudapp.com/api/getSubscription allows you to get information about the subscription on a customer's account.

Add Credit Card to Customer Account

This POST request to https://cleancloudapp.com/api/addCard allows you to add a credit card to a customer account by sending in the card token

Charge Saved Credit Card

This POST request to https://cleancloudapp.com/api/chargeCard allows you to charge a customers saved credit card for an order

Get Saved Credit Cards

This POST request to https://cleancloudapp.com/api/getCards allows you to fetch all of the saved cards for a customer

Set Default Credit Card

This POST request to https://cleancloudapp.com/api/setDefaultCard allows you to set the default card for a customer

Add Push Token

This POST request to https://cleancloudapp.com/api/addPushToken allows you to send a Firebase push notification authentication token from your customer iOS/Android app into CleanCloud. This is so that CleanCloud can automatically send a push token to your customer when their order status changes or if you would like to send them marketing from CleanCloud.

Delete Push Token

This POST request to https://cleancloudapp.com/api/deletePushToken allows you to delete a Firebase push notification authentication token from your customer database after the customer logs out of or uninstalls your app. This is so you do not try to send push notifications to a customer that is no longer using your app.

Add To Customer Group

This POST request to https://cleancloudapp.com/api/addToCustomerGroup allows you to assign a customer to a customer group.

Get Summary Metrics Report By Day

This POST request to https://cleancloudapp.com/api/summaryReport allows you to get summary metrics for your store

Get Driver Location

This POST request to https://cleancloudapp.com/api/driverLocation allows you to get the most recent location of a driver based on the order ID associated with a customer

Get Photos

This POST request to https://cleancloudapp.com/api/getPhotos allows you to get the photos associated with an order