Customers API

Current version: v1.1 beta

Customers List

GET
/clients/list.json
[
    ...
   {
        "fullname": "James Bond",
        "email": "james.bond@007.com",
        "id": "52712951be85f1405f000001"
    },
    ...
   {
        "fullname": "Rachelle Lefevre",
        "email": "rachelle.lefevre@underthedome.com",
        "id": "52712951be85f1405f0fe001"
    },
    ...
]
					

Get Customer Details

View all information about a specified customer

GET
/clients/client.json?id={customer-id}
id required (StoredenId) Unique id of customer.
{
    "fullname": "James Bond",
    "website": "https://007.com",
    "email": "james.bond@007.com",
    "phone": "+1 007 007 007",
    "mobile": "+10 07 007 007",
    "address": "3411 Las Vegas Blvd. South",
    "city": "Las Vegas",
    "zip": "NV89109",
    "state": "Nevada",
    "country": "254",
    "code": "",
    "userUID": 120007,
    "id": "52712951be85f1405f000001"
}
					

Add a new customer

POST
/clients/client.json
fullname required (string)
email required (string) If already exists in your customer database will throw an error
website (string)
phone (string)
mobile (string)
address (string) Full address included apt number
city (string)
zip (string) Specify a valid postal code. Will be validated against country postal code rules
country (uid) A valid country uid
state (uid) Specified state must be a state of specified country. Otherways an error will be thrown
tax_number (string)
metadata (associative array) Sub values:
sdi: Italia Digitial Invoice code
pec: Italian Certified Email address
note (string) April 24th, 2019 Custom Text for customer's data
{
    "client": {
        "id": "569d08bb16f46ac71e7b23c6"
    }
}
					

Remove customer from list

Permanently delete customer from your customers list.

DELETE
/clients/client.json
id required (StoredenId) Unique id of your customer to remove
{
    "ok": 1,
    "err": null,
}