Skip to content
Veeqo, An Amazon company Developers
Login Signup

Create a Customer

POST
/customers

Request Body

Section titled “Request Body ”
object
email
required
string
customer@example.com
customer_type
required

Whether this customer is a retail or wholesale customer.

string
Allowed values: retail business
phone
string
01234 567890
mobile
string
07123456789
notes

This is some extra info about the customer. 255 Character Limit

string
billing_address_attributes
object
first_name
string
John
last_name
string
Doe
company
string
FooBar Ltd
address1
string
221 High Street Lane
address2
string
2nd Address
city
string
Swansea
country
string
GB
zip
string
SA1 1NW
Example
{
  "customer": {
    "email": "Phil+API@veeqo.com",
    "phone": "01234 567890",
    "mobile": "07123456789",
    "notes": "This person buys things",
    "customer_type": "retail",
    "billing_address_attributes": {
      "first_name": "Phil",
      "last_name": "Reynolds",
      "company": "Veeqo Ltd",
      "address1": "Tech Hub",
      "address2": "221 High Street",
      "city": "Swansea",
      "country": "GB",
      "zip": "SA1 1NW"
    }
  }
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

object
id
number
email
string
customer_type
string
Allowed values: retail business
phone
string
mobile
string
notes
string
created_by_id
number
billing_address
object
id
number
first_name
string
last_name
string
company
string
address1
string
address2
string
city
string
country
string
state
nullable
zip
string
phone
nullable
email
nullable
shipping_addresses
Array<object>
object
id
number
first_name
string
last_name
string
company
string
address1
string
address2
string
city
string
country
string
state
string
zip
string
phone
string
last_used_shipping_address
object
id
number
first_name
string
last_name
string
company
string
address1
string
address2
string
city
string
country
string
state
string
zip
string
phone
string
Example
{
  "id": 123,
  "email": "Phil+API@veeqo.com",
  "customer_type": "retail",
  "phone": "01234 567890",
  "mobile": "07123456789",
  "notes": "This person buys things",
  "created_by_id": 12005,
  "billing_address": {
    "id": 12345678,
    "first_name": "Phil",
    "last_name": "Reynolds",
    "company": "Veeqo Ltd",
    "address1": "Tech Hub",
    "address2": "221 High Street",
    "city": "Swansea",
    "country": "GB",
    "state": null,
    "zip": "SA1 1NW",
    "phone": null,
    "email": null
  },
  "shipping_addresses": [
    {
      "id": 12345678,
      "first_name": "Phil",
      "last_name": "Reynolds",
      "company": "Veeqo Ltd",
      "address1": "Tech Hub",
      "address2": "221 High Street",
      "city": "Swansea",
      "country": "GB",
      "state": "",
      "zip": "SA1 1NW",
      "phone": ""
    }
  ],
  "last_used_shipping_address": {
    "id": 12345678,
    "first_name": "Phil",
    "last_name": "Reynolds",
    "company": "Veeqo Ltd",
    "address1": "Tech Hub",
    "address2": "221 High Street",
    "city": "Swansea",
    "country": "GB",
    "state": "",
    "zip": "SA1 1NW",
    "phone": ""
  }
}