» Support » Entwicklerdokumentation » Contacts API

Contacts API

On the POS and in the Management Console, you can work with contacts for CRM processes.

If you need more information about contacts, please have a look for the user documentation.

Endpoint

The endoint definition can be found in the common information <link>.

The importconfigkey for the simple item import cjbxjyoaksqbtqlm

Body

The valid json looks like that:

[
{
"__id": "{{__id}}",
"__organizationalId": "{{__organizationalId}}",
"companyId": "{{companyId}}",
"name": "{{contact_name}}",
"url": "{{url}}",
"addresses": [
{
"type": "{{address_type}}",
"postalCode": "{{address_postal_code}}",
"address": "{{address_address}}",
"city": "{{address_city}}",
"country": "{{address_country}}",
"state": "{{address_state}}",
"telephone": [
"{{address_telephone}}"
],
"fax": [
"{{address_fax}}"
],
"addressLine": [
"{{address_addressline}}"
]
}
],
"emails": [
{
"type": "{{email_type}}",
"email": "{{email_email}}"
}
],
"contactGroups": [
"{{contactsGroups_Group1}}"
],
"localeCode": "{{localeCode}}",
"vatId": "{{vatId}}",
"taxId": "{{taxId}}",
"externalContactID": "{{externalContactID}}",
"subContacts": [
{{subContacts}}
]
}
]

Definition

Field

Type

Sample

Description

__id

"NNNNN" - string

"12345" or "ABC-123"

The internal, unique ID for the contact.

__organizationalId

"-1"

The unique ID for the concerning organization.

companyId

"NNNNN" - string

"12345" or "ABC-123"

The unique number of the contact. (Contact Number)

name

"TEXT" - string

"John Doe"

The name of the contact.

url

"www.TEXT.domain" - string

"www.retail7.io"

The url of the website of the contact.

address_type

"DEFAULT_ADRESS" / "INVOICE_ADDRESS" / "DELIVERY_ADDRESS" / "OTHER_ADDRESS"

"DEFAULT_ADDRESS"

The type of the of the corresponding address.

postalCode

"NNNNN" - string

"10117"

The postal or zip code of the corresponding address.

address

"TEXT" - string

"Friedrichstraße 204"

The street of the corresponding address.

city

"TEXT" - string

"Berlin"

The city of the corresponding address.

country

"TEXT" - string

"DE"

The country code of the corresponding address.

state

"TEXT" - string

"Berlin"

The state of the corresponding address.

telephone

"NNNNN" - string

"030800989310"

The phone number of the contact.

fax

"NNNNN" - string

"030800989310"

The fax number of the contact.

addressLine

"TEXT" - string

"Apartment 2"

Additional information about the address.

email

"[email protected]" - string

"[email protected]"

The email address of the contact.

contactGroups

"TEXT" - string

"Group 1"

The group to which the contact should be assigned.

localeCode

"TEXT" - string

"DE"

The local code the contact is belongig to.

vatId

"NNNNN" - string

"12345" or "ABC-123"

The vat. id of the contact.

taxId

"NNNNN" - string

"12345" or "ABC-123"

The tax id of the contact.

externalContactID

"NNNNN" - string

"12345" or "ABC-123"

A possibly existing external contact number.

subContacts

Object

"John Doe"

A specific contact person of the contact.

Postman Collection

To have a quickstart, please download the postman ressources:

  • Postman Collection for Item Import - DOWNLOAD

  • Postman Environment for Item Import - DOWNLOAD