API Reference
  1. Stok.ly API
  2. Customers

Create a customer

post
https://api.stok.ly/v0/customers
Body Params
string

The customer's ID. If omitted, one will be generated

string

The barcode to identify this customer. Will be automatically generated if omitted

string
enum
Allowed:
name
object
deprecated

The customer's forename and surname

string
required

The customer's name

billingAddress
object
shippingAddresses
array of objects

A maximum of 5 addresses can be saved

shippingAddresses
string
enum
Allowed:
date

ISO-8601 format

emailAddresses
array of strings
deprecated
emailAddresses
phoneNumbers
array of strings
deprecated
phoneNumbers
string
deprecated
boolean
number
number
integer

How many days the customer has to pay generated invoices

groupIds
array of strings

If automatic groups are provided, the customer may be automatically removed from the group if they do not match the logic

groupIds
string
required
contacts
array of objects
required
contacts*
integer
enum
required

0: Individual, 1: Organisation

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?