Dev Docs

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 importconfigkey for the simple item import defaultimportcontactsV1.

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}}
],
"keyValuePair": [
{
"key": "Test",
"value": "123"
}
}
]


Definition

Field



__id

Type: "NNNNN" - string

Sample: "12345" or "ABC-123"

Description: The internal, unique ID for the contact.

__organizationalId

Type: -

Sample: "-1"

Description: The unique ID for the concerning organization.

companyId

Type: "NNNNN" - string

Sample: "12345" or "ABC-123"

Description: The unique number of the contact. (Contact Number)

name

Type: "TEXT" - string

Sample: "John Doe"

Description: The name of the contact.

url

Type: "www.TEXT.domain" - string

Sample: "www.retail7.io"

Description: The url of the website of the contact.

address_type

Type: "DEFAULTADRESS" / "INVOICEADDRESS" / "DELIVERYADDRESS" / "OTHERADDRESS"

Sample: "DEFAULT_ADDRESS"

Description: The type of the of the corresponding address.

postalCode

Type: "NNNNN" - string

Sample: "10117"

Description: The postal or zip code of the corresponding address.

address

Type: "TEXT" - string

Sample: "Friedrichstraße 204"

Description: The street of the corresponding address.

city

Type: "TEXT" - string

Sample: "Berlin"

Description: The city of the corresponding address.

country

Type: "TEXT" - string

Sample: "DE"

Description: The country code of the corresponding address.

state

Type: "TEXT" - string

Sample: "Berlin"

Description: The state of the corresponding address.

telephone

Type: "NNNNN" - string

Sample: "030800989310"

Description: The phone number of the contact.

fax

Type: "NNNNN" - string

Sample: "030800989310"

Description: The fax number of the contact.

addressLine

Type: "TEXT" - string

Sample: "Apartment 2"

Description: Additional information about the address.

email

Type: "[email protected]" - string

Sample: "[email protected]"

Description: The email address of the contact.

contactGroups

Type: "TEXT" - string

Sample: "Group 1"

Description: The group to which the contact should be assigned.

localeCode

Type: "TEXT" - string

Sample: "DE"

Description: The local code the contact is belongig to.

vatId

Type: "NNNNN" - string

Sample: "12345" or "ABC-123"

Description: The vat. id of the contact.

taxId

Type: "NNNNN" - string

Sample: "12345" or "ABC-123"

Description: The tax id of the contact.

externalContactID

Type: "NNNNN" - string

Sample: "12345" or "ABC-123"

Description: A possibly existing external contact number.

subContacts

Type: Object

Sample: "John Doe"

Description: A specific contact person of the contact.

Key

Type: Object

Sample: "Email Subscription"

Description: A plain text information description.

Value

Type: Object

Sample: "Yes"

Description: The Value regarding to the Key-Field.

Postman Collection

To have a quickstart, please download the postman ressources:

  • Postman Collection for Item Import - DOWNLOAD

  • Postman Environment for Item Import - DOWNLOAD