LogicTrade API
  1. Customer
LogicTrade API
  • Authentication
  • Pagination
  • Rate limits
  • Error codes
  • Changelog
  • Configuration Service
  • Endpoints
    • Authentication
      • Introspection
    • Customer
      • List all customers
        GET
      • Retrieve a customer by id
        GET
      • Create a customer
        POST
      • Update a customer
        PUT
      • Remove the customer
        DELETE
    • Supplier
      • List all suppliers
      • Retrieve a supplier by id
      • Create a supplier
      • Update a supplier
      • Remove the supplier
    • Product
      • Product
        • List all products
        • Retrieve a product by id
        • Create a product
        • Remove the products
        • Update a product
        • Search products
      • Groups
        • List all product groups
      • Discount
        • List all discounts for products
        • Get all discounts for product by id
        • List all discounts for customers
        • Get all discounts for a customer by id
      • Stock
        • Get stock for products
        • Search stock for products
      • Prices
        • Get product prices
      • Descriptions
        • Get the descriptions for a product
      • Refereces
        • Get the product references
    • Quote
      • List all quotes
      • Retrieve a quote by id
      • Create a quote
      • Update a quote
    • Sales order
      • List all orders
      • Retrieve an orders by id
      • Create an order
      • Update an order
    • Invoice
      • List all invoices
      • Retrieve a invoice by id
      • Create a invoice
      • Update a invoice
    • Delivery
      • Get list of orders that can be delivered
      • Update the order with delivery information
    • Purchase order
      • List all purchase orders
      • Retrieve a purchase orders by id
      • Create a purchase order
      • Update a purchase order
  1. Customer

Create a customer

POST
/rest/v1/customers
Create a new customer in LogicTrade.
When the company name is filled, the customer will be added as a business client. If the company name is not filled, the customer will be added as an indivual. In that case the first and last name are required.
The address object is used for both postal and visiting addresses. The country must be added based on the ISO 3166-1 alfa-2 code.
After successful creation the customer object will be returned.

Request

Authorization
Add parameter in header
api-key
Example:
api-key: ********************
Body Params application/json
gender
string 
optional
The customer's gender male/female/unknown
title
string 
optional
The title of the relation.
initials
string 
optional
The customer's initials.
firstName
string 
required
The customer's first name.
infix
string 
optional
The infix of the relation. A new one will be created if the infix does not exist.
lastName
string 
required
The customer's last name.
companyName
string 
optional
Only filled if it is a business customer and contains the customer's company name.
phoneNumber
string 
optional
The first phone number of the customer.
mobileNumber
string 
optional
The mobile phone number of the customer.
email
string 
required
The e-mail adress of the customer
remark
string 
optional
Any customer comments.
address
object 
optional
The address of the customer.
street
string 
optional
houseNumber
string 
optional
zipCode
string 
optional
city
string 
optional
country
string 
optional
invoiceAddress
object 
optional
The invoice address of the customer.
street
string 
optional
houseNumber
string 
optional
zipCode
string 
optional
city
string 
optional
country
string 
optional
deliveryAddress
object 
optional
The delivery address of the customer.
name
string 
optional
street
string 
optional
houseNumber
string 
optional
zipCode
string 
optional
city
string 
optional
country
string 
optional
phoneNumber
string 
optional
newsLetter
boolean 
optional
This indicates whether the customer wants to receive a newsletter.
birthdate
string <date> | null 
optional
The customer’s birthdate.
Example
{
  "gender": "male",
  "title": "Dhr.",
  "initials": "J.",
  "firstName": "Jan",
  "lastName": "Jansen",
  "mobileNumber": "06-12345678",
  "email": "jan@jansen.com",
  "remark": "Niet beschikbaar op maandag en dinsdag!",
  "address": {
    "street": "Wethouder Buitenhuisstraat",
    "houseNumber": "2B",
    "zipCode": "7951 SM",
    "city": "Staphorst",
    "country": "NL"
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.logictrade.cloud/rest/v1/customers' \
--header 'Content-Type: application/json' \
--header 'api-key;' \
--data-raw '{
  "gender": "male",
  "title": "Dhr.",
  "initials": "J.",
  "firstName": "Jan",
  "lastName": "Jansen",
  "mobileNumber": "06-12345678",
  "email": "jan@jansen.com",
  "remark": "Niet beschikbaar op maandag en dinsdag!",
  "address": {
    "street": "Wethouder Buitenhuisstraat",
    "houseNumber": "2B",
    "zipCode": "7951 SM",
    "city": "Staphorst",
    "country": "NL"
  }
}'

Responses

🟢200Success
application/json
Body
id
integer 
read-onlyrequired
The unique identifier of the customer.
number
string 
read-onlyoptional
A unique number with which the customer can be found.
gender
string 
optional
The customer's gender male/female/unknown
title
string 
optional
The title of the relation.
initials
string 
optional
The customer's initials.
firstName
string 
optional
The customer's first name.
infix
string 
optional
The infix of the relation. A new one will be created if the infix does not exist.
lastName
string 
optional
The customer's last name.
companyName
string 
optional
Only filled if it is a business customer and contains the customer's company name.
cocNumber
string 
optional
Chain of Custody Number (KvK number).
vatNumber
string 
optional
The VAT number (BTW nummer) of the customer.
phoneNumber
string 
optional
The first phone number of the customer.
phoneNumber2
string 
optional
The second phone number of the customer.
mobileNumber
string 
optional
The mobile phone number of the customer.
email
string 
optional
The e-mail adress of the customer
remark
string 
optional
Any customer comments.
address
object 
optional
The address of the customer.
name
string 
optional
street
string 
optional
houseNumber
string 
optional
zipCode
string 
optional
city
string 
optional
country
string 
optional
phoneNumber
string 
optional
invoiceAddress
object 
optional
The invoice address of the customer.
name
string 
optional
street
string 
optional
houseNumber
string 
optional
zipCode
string 
optional
city
string 
optional
country
string 
optional
phoneNumber
string 
optional
deliveryAddress
object 
optional
The delivery address of the customer.
name
string 
optional
street
string 
optional
houseNumber
string 
optional
zipCode
string 
optional
city
string 
optional
country
string 
optional
phoneNumber
string 
optional
newsLetter
boolean 
optional
This indicates whether the customer wants to receive a newsletter.
externNumbers
object 
optional
In this section, the external numbers are displayed. These numbers can be used by external applications.
number1
string 
optional
number2
string 
optional
number3
string 
optional
birthdate
string <date>
optional
The customer’s birthdate.
modifiedDate
string <date-time>
optional
The date on which the entity was last modified.
createdDate
string <date-time>
optional
The date on which the entity was created.
Example
{
  "id": 14,
  "number": "R0000016",
  "gender": "male",
  "title": "Dhr.",
  "initials": "J.",
  "firstName": "Jan",
  "lastName": "Jansen",
  "mobileNumber": "06-12345678",
  "email": "jan@jansen.com",
  "remark": "Niet beschikbaar op maandag en dinsdag!",
  "address": {
    "street": "Wethouder Buitenhuisstraat",
    "houseNumber": "2B",
    "zipCode": "7951 SM",
    "city": "Staphorst",
    "country": "NL"
  }
}
🟠403Forbidden
🟠400Bad Request
Modified at 2024-11-13 08:53:35
Previous
Retrieve a customer by id
Next
Update a customer