API

Docs and API's for Weasy.io

Customers

Manage all the customers in your website.

Accepts GET POST PUT DELETE

All requests to the API must be authenticated with an API key on the HTTP Authorization header.

GET

Get all files from website filemanager

GET/customers{?limit,page}

GET/customers/:id|email

Request example

~ curl -i -X GET \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
https://api.weasy.io/v1/customers



Body response example [ HTTP CODE: 200 ]

{  
   "items":[  
       {  
         "id":"1",
         "customer_code":"U369-9",
         "userLastActivity":"2018-12-21 16:31:35",
         "status":"1",
         "name":"John Smith",
         "country":"PT",
         "vat":"123456789",
         "address":"Fifth Avenue",
         "zipcode":"123977",
         "city":"New York",
         "email":"myemail@weasy.io",
         "notes":null,
         "creation_date":"2018-01-31 20:50:02",
         "last_login":"2018-06-13 22:46:09",
         "facebook_id":"2138383838338383",
         "lang":"en",
         "price_table":"0",
         "allowMarketing":"0",
         "other_info":{  
            "where_did_you_find_us":"Google",
            "another_awesome_field":"I love candies"
         }
      },
      ...
   ],
   "paging":{  
      "total":"100",
      "totalpages":4,
      "previous":"https://api.weasy.io/v1/customers?limit=25&page=1",
      "next":"https://api.weasy.io/v1/customers?limit=25&page=3"
   }
}



Path parameters

NAME TYPE REQUIRED DESCRIPTION
limit integer optional define items per page
page integer optional define page to display


POST

Add a new customer to your website.


POST/customers

Request example

~ curl -i -X POST \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
-d '{"name":"John Smith","email":"myemail@weasy.io","customer_code":"ABC", ...}'\
https://api.weasy.io/v1/customers



Body response example [ HTTP CODE: 200 ]

 
   {  
      "status":"ok",
      "customer_id":8
   }
   or
   {  
      "status":"error",
      "message":"email address already in use",
      "message":"customer code already in use"
   }



Body attributes

A json payload containing the following attributes.

NAME TYPE REQUIRED DESCRIPTION
customer_code string required customer code
this field must be unique
status integer required client status
options:
0 for disabled, 1 for enabled
name string required customer name
address string optional customer address
zipcode string optional customer zip address
city string optional customer city
country string optional country code
options:
all the iso country codes (ISO 3166-2) obtained from the Countries endpoint
email string required customer email
this field must be unique
phone string optional customer contact number
password string required customer default password
notes text optional notes for the customer
lang text optional customer default language
options:
all the iso country codes (ISO 3166-2) obtained from the Languages endpoint
price_table integer optional customer default price table
price table id's can be obtained from the price table endpoint
allowMarketing integer optional customer is allowed to recieve campaigns and sms


PUT

Change a url forward from your website.


PUT/customers/:id

Request example

~ curl -i -X PUT \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
-d '{"name":"John Smith","email":"myemail@weasy.io","customer_code":"ABC", ...}'\
https://api.weasy.io/v1/customers/1



Body response example [ HTTP CODE: 200 ]

{  
   "status":"ok"
}
or
{  
   "status":"error"
}



Path parameters

NAME TYPE REQUIRED DESCRIPTION
id integer required url forward id



Body attributes

A json payload containing the following attributes.

NAME TYPE REQUIRED DESCRIPTION
customer_code string required customer code
this field must be unique
status integer required client status
options:
0 for disabled, 1 for enabled
name string required customer name
address string optional customer address
zipcode string optional customer zip address
city string optional customer city
country string optional country code
options:
all the iso country codes (ISO 3166-2) obtained from the Countries endpoint
email string required customer email
this field must be unique
phone string optional customer contact number
password string required customer default password
notes text optional notes for the customer
lang text optional customer default language
options:
all the iso country codes (ISO 3166-2) obtained from the Languages endpoint
price_table integer optional customer default price table
price table id's can be obtained from the price table endpoint
allowMarketing integer optional customer is allowed to recieve campaigns and sms


DELETE

Delete a customer from your website


DELETE/customers

Request example

~ curl -i -X DELETE \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
-d '[1,2]'\
https://api.weasy.io/v1/customers



Body response example [ HTTP CODE: 200 ]

[  
   {  
      "status":"ok",
      "id":1
   },
   {  
      "status":"error",
      "id":2
   }
]



Body attributes

Attribute description
A json payload containing an array of id or ids.
Use GET for collect all the ids.