Skip to content

Customer

guidstring, <= 36 characters(typeGuidUnlimited)required

Customer GUID

billingAddressobject(billingAddress)required

invoicing address

deliveryAddressArray of objects(deliveryAddressCustomer)required

delivery addresses

creationTimestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

registration date

changeTimestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of last change

customerGroupobject or nullrequired

group of customers

priceListpricelist (object) or nullrequired
One of:

inclusion into the price list

remarkstring or nullrequired

remark for the customer (can be null)

priceRatiostring(typePriceRatio)[0-9]+\.[0-9]{4}$required

additional discount - 0.7800 = discount 22%; 1.0000 = no discount

birthDatestring or null, (date)(typeDateNullable)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date of birth. In YYYY-MM-DD format. (can be null)

accountsArray of objectsrequired

customer login accounts

disabledOrdersbooleanrequired

Ordering disabled? If so, newly created orders will be cancelled automatically. Dependent on the addition of customerReviews. If e-shop does not have an option active, the answer will be false.

remarksArray of objectsrequired

customer notes and ratings, dependent on addon customerReviews. If e-shop does not have an option active, the answer will be blank.

adminUrlstringrequired

link to the customer details in administration

{
  "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "billingAddress": {
    "company": "Shoptet s.r.o.",
    "fullName": "John Doe",
    "street": "French",
    "houseNumber": "123",
    "city": "Praha 2",
    "district": "Praha 2",
    "additional": "4. floor",
    "zip": "120 00",
    "countryCode": "CZ",
    "regionName": "Capital city",
    "regionShortcut": "CC",
    "companyId": "12345678",
    "vatId": "CZ289324675",
    "vatIdValidationStatus": "verified",
    "taxId": "CZ289324675"
  },
  "deliveryAddress": [
    { … }
  ],
  "creationTime": "2018-05-29T09:02:27+0200",
  "changeTime": "2018-05-29T09:02:27+0200",
  "customerGroup": {
    "id": 1,
    "name": "VIP"
  },
  "priceList": {
    "id": 1,
    "name": "Hlavní ceník"
  },
  "remark": "customer is very nice",
  "priceRatio": "0.7800",
  "birthDate": "2017-04-04",
  "accounts": [
    { … }
  ],
  "disabledOrders": false,
  "remarks": [
    { … }
  ],
  "adminUrl": "https://www.domena-eshopu.cz/admin/zakaznici-detail?id=16"
}