REST Account Contact

Get, create, update or delete contacts. A contact is equivalent to a person. An account contains company-related data. Multiple contacts can be assigned to an account. Assigning multiple contacts to an account is currently not available in the back end UI, but will be implemented in future versions.

Create a contact

/rest/accounts/contacts

Request

Field Type Description
referrerId Float The origin of the contact required
typeId Int The ID of the contact type required
title String The title of the contact, e.g. a doctorate optional
options \Collection A collection of options of the contact optional array
 typeId required
 subTypeId required
 value required
 priority required
accounts \Collection A collection of linked accounts. An ID or a company name must be specified. When the ID is used, a relation will be created. When the company name without an ID is used, a new account with the given data will be created. optional array
 id optional
 companyName optional
 number optional
 taxIdNumber optional
 discountPercent optional
 valuta optional
 discountDays optional
 timeForPaymentAllowedDays optional
tagRelationships \Collection The tag relations of the contact optional array
 tagType required allowed values are contact
 tagId required
{"number":"12XA44BC","externalId":"102030","typeId":4,"firstName":"John","lastName":"Doe","gender":"male","title":"doctorate","formOfAddress":"","newsletterAllowanceAt":"2014-04-09 23:18:24","classId":1,"password":"sdad76dsa6d78dsadsa8asd8as908d","blocked":"0","rating":"3","bookAccount":"","lang":"de","referrerId":1,"plentyId":25378,"userId":1,"birthdayAt":"1984-03-19 00:00:00","lastLoginAt":"2014-04-09 23:18:24","lastOrderAt":"2014-04-09 23:18:24","createdAt":"2014-04-09 23:18:24","updatedAt":"2016-07-22 23:12:15","options":[{"typeId":1,"subTypeId":4,"value":"030 12312234","priority":0},{"typeId":1,"subTypeId":3,"value":"030 98898","priority":0},{"typeId":2,"subTypeId":4,"value":"john@account.com","priority":0}],"accounts":[{"id":4,"number":"1a","companyName":"plentymarkets GmbH","taxIdNumber":"","valuta":"0","discountDays":"0","discountPercent":"0.00","timeForPaymentAllowedDays":"0","salesRepresentativeContactId":null,"userId":"1","deliveryTime":"0","dealerMinOrderValue":"0.00","createdAt":"2018-01-03T09:27:36+01:00","updatedAt":"2018-01-03T09:27:36+01:00","pivot":{"contactId":"120","accountId":"4"}}]}

Success 200

Field Type Description
id Int The ID of the contact
externalId String The external ID of the contact
number String The number of the contact (previous customer number)
typeId Int The ID of the contact type
firstName String The first name of the contact
lastName String The last name of the contact
fullName String The full name of the contact. A concatenation of first and last name.
email String The private email address of the contact
secondaryEmail String The secondary private email address of the contact
gender String The gender of the contact
title String The title of the contact, e.g. a doctorate
formOfAddress String The form of address for the contact
newsletterAllowanceAt String|\Carbon The time the contact registered for the newsletter as unix timestamp
classId Int The ID of the contact class
blocked Int The blocked status of the contact. Contacts can be blocked for a specific client (store). Possible values:
  • 0 = not blocked
  • 1 = blocked
rating Int The rating of the contact. This rating is for internal use only. 5 red stars are for the worst and 5 yellow stars for the best rating. Possible values:
  • -5 = 5 red stars (worst rating)
  • -4 = 4 red stars
  • -3 = 3 red stars
  • -2 = 2 red stars
  • -1 = 1 red star
  • 0 = 5 grey stars, no rating saved for the contact
  • 1 = 1 yellow star
  • 2 = 2 yellow stars
  • 3 = 3 yellow stars
  • 4 = 4 yellow stars
  • 5 = 5 yellow stars (best rating)
bookAccount String The book account (debtor account) of the contact. An additional, separate number that generally corresponds to the customer number or the debtor number in your financial accounting.
lang String The language of the contact
referrerId Float The origin of the contact
plentyId Int The client (store) that is assigned to the contact
userId Int The owner ID of the contact
birthdayAt String|\Carbon The date of birth of the contact
lastLoginAt String|\Carbon The date of the last login of the contact
lastLoginAtTimestamp String|\Carbon The date of the last login of the contact
lastOrderAt String|\Carbon The date of the last order
createdAt String|\Carbon The date the contact was created
updatedAt String|\Carbon The date the contact was last updated
privatePhone String The private phone number of the contact
privateFax String The private fax number of the contact
privateMobile String The private mobile phone number of the contact
ebayName String The eBay account name of the contact
paypalEmail String The email address of the PayPal account of the contact
paypalPayerId String The PayPal payer id of the contact
klarnaPersonalId String The Klarna personal id of the contact
dhlPostIdent String The DHL PostIdent of the contact
forumUsername String The user name of the contact in the forum
forumGroupId String The ID of the forum group that is assigned to the contact
singleAccess String The access type of the contact
contactPerson String The contact person of the contact
marketplacePartner String The marketplace partner status of the contact
valuta Int The foreign currency of the contact
discountDays Int The early payment discount period in days specified for the account
discountPercent Float The early payment discount in percent specified for the account
timeForPaymentAllowedDays Int The payment due date in days specified for the account
salesRepresentativeContactId Int The salesRepresentative ID of the contact
{"id":103,"number":"12XA44BC","externalId":"102030","typeId":4,"firstName":"John","lastName":"Doe","gender":"male","title":"doctorate","formOfAddress":"","newsletterAllowanceAt":"2014-04-09T23:18:24+02:00","classId":1,"blocked":0,"rating":3,"bookAccount":"","lang":"de","referrerId":1,"userId":3,"salesRepresentativeContactId":null,"birthdayAt":"1984-03-19T00:00:00+01:00","lastLoginAt":"2014-04-09T23:18:24+02:00","lastOrderAt":"2014-04-09T23:18:24+02:00","createdAt":"2014-04-09T23:18:24+02:00","updatedAt":"2016-07-22T23:12:15+02:00","options":[{"id":4,"contactId":103,"typeId":1,"subTypeId":4,"value":"030 12312234","priority":0,"createdAt":"2014-04-09 23:18:24","updatedAt":"2016-07-22 23:12:16"},{"id":5,"contactId":103,"typeId":1,"subTypeId":3,"value":"030 98898","priority":0,"createdAt":"2014-04-09 23:18:24","updatedAt":"2016-07-22 23:12:16"},{"id":6,"contactId":103,"typeId":2,"subTypeId":4,"value":"john@account.com","priority":0,"createdAt":"2014-04-09 23:18:24","updatedAt":"2016-07-22 23:12:16"}],"accounts":[{"id":4,"number":"1a","companyName":"plentymarkets GmbH","taxIdNumber":"","valuta":"0","discountDays":"0","discountPercent":"0.00","timeForPaymentAllowedDays":"0","userId":"1","deliveryTime":"0","dealerMinOrderValue":"0.00","createdAt":"2018-01-03T09:27:36+01:00","updatedAt":"2018-01-03T09:27:36+01:00","pivot":{"contactId":"120","accountId":"4"}}],"plentyId":94,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"John Doe"}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a contact

Gets a contact. The ID of the contact must be specified.

/rest/accounts/contacts/{contactId}

Parameters

Field Type Description
with String Includes the specified contact information in the results. The following parameters are available: addresses, accounts. More than one parameter should be separated by commas.

Success 200

Field Type Description
id Int The ID of the contact
externalId String The external ID of the contact
number String The number of the contact (previous customer number)
typeId Int The ID of the contact type
firstName String The first name of the contact
lastName String The last name of the contact
fullName String The full name of the contact. A concatenation of first and last name.
email String The private email address of the contact
secondaryEmail String The secondary private email address of the contact
gender String The gender of the contact
title String The title of the contact, e.g. a doctorate
formOfAddress String The form of address for the contact
newsletterAllowanceAt String|\Carbon The time the contact registered for the newsletter as unix timestamp
classId Int The ID of the contact class
blocked Int The blocked status of the contact. Contacts can be blocked for a specific client (store). Possible values:
  • 0 = not blocked
  • 1 = blocked
rating Int The rating of the contact. This rating is for internal use only. 5 red stars are for the worst and 5 yellow stars for the best rating. Possible values:
  • -5 = 5 red stars (worst rating)
  • -4 = 4 red stars
  • -3 = 3 red stars
  • -2 = 2 red stars
  • -1 = 1 red star
  • 0 = 5 grey stars, no rating saved for the contact
  • 1 = 1 yellow star
  • 2 = 2 yellow stars
  • 3 = 3 yellow stars
  • 4 = 4 yellow stars
  • 5 = 5 yellow stars (best rating)
bookAccount String The book account (debtor account) of the contact. An additional, separate number that generally corresponds to the customer number or the debtor number in your financial accounting.
lang String The language of the contact
referrerId Float The origin of the contact
plentyId Int The client (store) that is assigned to the contact
userId Int The owner ID of the contact
birthdayAt String|\Carbon The date of birth of the contact
lastLoginAt String|\Carbon The date of the last login of the contact
lastLoginAtTimestamp String|\Carbon The date of the last login of the contact
lastOrderAt String|\Carbon The date of the last order
createdAt String|\Carbon The date the contact was created
updatedAt String|\Carbon The date the contact was last updated
privatePhone String The private phone number of the contact
privateFax String The private fax number of the contact
privateMobile String The private mobile phone number of the contact
ebayName String The eBay account name of the contact
paypalEmail String The email address of the PayPal account of the contact
paypalPayerId String The PayPal payer id of the contact
klarnaPersonalId String The Klarna personal id of the contact
dhlPostIdent String The DHL PostIdent of the contact
forumUsername String The user name of the contact in the forum
forumGroupId String The ID of the forum group that is assigned to the contact
singleAccess String The access type of the contact
contactPerson String The contact person of the contact
marketplacePartner String The marketplace partner status of the contact
valuta Int The foreign currency of the contact
discountDays Int The early payment discount period in days specified for the account
discountPercent Float The early payment discount in percent specified for the account
timeForPaymentAllowedDays Int The payment due date in days specified for the account
salesRepresentativeContactId Int The salesRepresentative ID of the contact

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List contacts

/rest/accounts/contacts

Parameters

Field Type Description
fullText String Filter for a fulltext search
contactEmail String Filter that restricts the search result to contacts resembling to the given email address
email String Filter that restricts the search result to contacts with a specific email address
postalCode String Filter that restricts the search result to contacts with a specific postal code
plentyId Int Filter that restricts the search result to contacts with a specific plentyId
externalId Int Filter that restricts the search result to contacts with a specific externalId
number Int Filter that restricts the search result to contacts with a specific number
typeId Int Filter that restricts the search result to contacts with a specific contact type
rating Int Filter that restricts the search result to contacts with a specific rating
createdAtBefore String Filter that restricts the search result to contacts that were created before a specific date. Possible formats: yyyy-mm-dd, mm/dd/yyyy.
createdAtAfter String Filter that restricts the search result to contacts that were created after a specific date. Possible formats: yyyy-mm-dd, mm/dd/yyyy.
updatedAtBefore String Filter that restricts the search result to contacts that were updated before a specific date. Possible formats: yyyy-mm-dd, mm/dd/yyyy.
updatedAtAfter String Filter that restricts the search result to contacts that were updated after a specific date. Possible formats: yyyy-mm-dd, mm/dd/yyyy.
with String Includes the specified contact information in the results. The following parameters are available: addresses, accounts, options, orderSummary, primaryBillingAddress. More than one parameter should be separated by commas.
page Int The page of results to search for
itemsPerPage Int The number of items to list per page
newsletterAllowanceAfter String Filter that restricts the search result to contacts who registered for the newsletter after a specific date. Possible formats: yyyy-mm-dd, mm/dd/yyyy.
newsletterAllowanceBefore String Filter that restricts the search result to contacts who registered for the newsletter before a specific date. Possible formats: yyyy-mm-dd, mm/dd/yyyy.
newsletterAllowance String Filter that restricts the search result to contacts who registered for the newsletter. Possible values: 'true' and 'false'. True: newsletter registration was successful. False: newsletter registration was not successful.
contactId Int Filter that restricts the search result to a specific contact
contactAddress String Filter that restricts the search result to contacts with a specific address
countryId String Filter that restricts the search result to contacts with a specific country
userId String Filter that restricts the search result to contacts with a specific user
referrerId String Filter that restricts the search result to contacts with a specific referrer
name String Filter that restricts the search result to contacts with a specific name
nameOrId String Filter that restricts the search result to contacts with a specific name or id.
town String Filter that restricts the search result to contacts with a specific town
privatePhone String Filter that restricts the search result to contacts with a private phone number
billingAddressId String Filter that restricts the search result to contacts with a billing address with the id provided
deliveryAddressId String Filter that restricts the search result to contacts with a delivery address with the id provided
tagIds Int[] Filter restricts the list of results to contacts with the specified tagIds. More than one ID should be separated by commas.

Success 200

Field Type Description
page Int Current page of the response
totalsCount Int The total number of entries in the response
isLastPage Bool Flag that indicates if the page shown is the last page of the response
lastPageNumber Int The last page number
firstOnPage Int The index of the first item of the current page result
lastOnPage Int The index of the last item of the current page result
itemsPerPage Int The requested amount of items per result page
entries Contact[] List of Contact
 id Int The ID of the contact
 externalId String The external ID of the contact
 number String The number of the contact (previous customer number)
 typeId Int The ID of the contact type
 firstName String The first name of the contact
 lastName String The last name of the contact
 fullName String The full name of the contact. A concatenation of first and last name.
 email String The private email address of the contact
 secondaryEmail String The secondary private email address of the contact
 gender String The gender of the contact
 title String The title of the contact, e.g. a doctorate
 formOfAddress String The form of address for the contact
 newsletterAllowanceAt String|\Carbon The time the contact registered for the newsletter as unix timestamp
 classId Int The ID of the contact class
 blocked Int The blocked status of the contact. Contacts can be blocked for a specific client (store). Possible values:
  • 0 = not blocked
  • 1 = blocked
 rating Int The rating of the contact. This rating is for internal use only. 5 red stars are for the worst and 5 yellow stars for the best rating. Possible values:
  • -5 = 5 red stars (worst rating)
  • -4 = 4 red stars
  • -3 = 3 red stars
  • -2 = 2 red stars
  • -1 = 1 red star
  • 0 = 5 grey stars, no rating saved for the contact
  • 1 = 1 yellow star
  • 2 = 2 yellow stars
  • 3 = 3 yellow stars
  • 4 = 4 yellow stars
  • 5 = 5 yellow stars (best rating)
 bookAccount String The book account (debtor account) of the contact. An additional, separate number that generally corresponds to the customer number or the debtor number in your financial accounting.
 lang String The language of the contact
 referrerId Float The origin of the contact
 plentyId Int The client (store) that is assigned to the contact
 userId Int The owner ID of the contact
 birthdayAt String|\Carbon The date of birth of the contact
 lastLoginAt String|\Carbon The date of the last login of the contact
 lastLoginAtTimestamp String|\Carbon The date of the last login of the contact
 lastOrderAt String|\Carbon The date of the last order
 createdAt String|\Carbon The date the contact was created
 updatedAt String|\Carbon The date the contact was last updated
 privatePhone String The private phone number of the contact
 privateFax String The private fax number of the contact
 privateMobile String The private mobile phone number of the contact
 ebayName String The eBay account name of the contact
 paypalEmail String The email address of the PayPal account of the contact
 paypalPayerId String The PayPal payer id of the contact
 klarnaPersonalId String The Klarna personal id of the contact
 dhlPostIdent String The DHL PostIdent of the contact
 forumUsername String The user name of the contact in the forum
 forumGroupId String The ID of the forum group that is assigned to the contact
 singleAccess String The access type of the contact
 contactPerson String The contact person of the contact
 marketplacePartner String The marketplace partner status of the contact
 valuta Int The foreign currency of the contact
 discountDays Int The early payment discount period in days specified for the account
 discountPercent Float The early payment discount in percent specified for the account
 timeForPaymentAllowedDays Int The payment due date in days specified for the account
 salesRepresentativeContactId Int The salesRepresentative ID of the contact

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update a contact

Updates a contact. The ID of the contact must be specified.

/rest/accounts/contacts/{contactId}

Parameters

Field Type Description
tagRelationships String[] When this parameter is used, the current relations between contacts and tags will be deleted and replaced by the given ones. If the parameter is not used, the current relations remain.

Request

Field Type Description
title String The title of the contact, e.g. a doctorate optional
options \Collection A collection of options of the contact optional array
 typeId required
 subTypeId required
 value optional
 priority required
{"number":"12XA44BC","externalId":"102030","typeId":4,"firstName":"John","lastName":"Doe","gender":"male","title":"doctorate","formOfAddress":"","newsletterAllowanceAt":"2014-04-09 23:18:24","classId":1,"password":"sdad76dsa6d78dsadsa8asd8as908d","blocked":"0","rating":"3","bookAccount":"","lang":"de","referrerId":1,"plentyId":25378,"userId":1,"birthdayAt":"1984-03-19 00:00:00","lastLoginAt":"2014-04-09 23:18:24","lastOrderAt":"2014-04-09 23:18:24","createdAt":"2014-04-09 23:18:24","updatedAt":"2016-07-22 23:12:15","options":[{"typeId":1,"subTypeId":4,"value":"030 12312234","priority":0},{"typeId":1,"subTypeId":3,"value":"030 98898","priority":0},{"typeId":2,"subTypeId":4,"value":"john@account.com","priority":0}],"accounts":[{"id":4,"number":"1a","companyName":"plentymarkets GmbH","taxIdNumber":"","valuta":"0","discountDays":"0","discountPercent":"0.00","timeForPaymentAllowedDays":"0","salesRepresentativeContactId":null,"userId":"1","deliveryTime":"0","dealerMinOrderValue":"0.00","createdAt":"2018-01-03T09:27:36+01:00","updatedAt":"2018-01-03T09:27:36+01:00","pivot":{"contactId":"120","accountId":"4"}}]}

Success 200

Field Type Description
id Int The ID of the contact
externalId String The external ID of the contact
number String The number of the contact (previous customer number)
typeId Int The ID of the contact type
firstName String The first name of the contact
lastName String The last name of the contact
fullName String The full name of the contact. A concatenation of first and last name.
email String The private email address of the contact
secondaryEmail String The secondary private email address of the contact
gender String The gender of the contact
title String The title of the contact, e.g. a doctorate
formOfAddress String The form of address for the contact
newsletterAllowanceAt String|\Carbon The time the contact registered for the newsletter as unix timestamp
classId Int The ID of the contact class
blocked Int The blocked status of the contact. Contacts can be blocked for a specific client (store). Possible values:
  • 0 = not blocked
  • 1 = blocked
rating Int The rating of the contact. This rating is for internal use only. 5 red stars are for the worst and 5 yellow stars for the best rating. Possible values:
  • -5 = 5 red stars (worst rating)
  • -4 = 4 red stars
  • -3 = 3 red stars
  • -2 = 2 red stars
  • -1 = 1 red star
  • 0 = 5 grey stars, no rating saved for the contact
  • 1 = 1 yellow star
  • 2 = 2 yellow stars
  • 3 = 3 yellow stars
  • 4 = 4 yellow stars
  • 5 = 5 yellow stars (best rating)
bookAccount String The book account (debtor account) of the contact. An additional, separate number that generally corresponds to the customer number or the debtor number in your financial accounting.
lang String The language of the contact
referrerId Float The origin of the contact
plentyId Int The client (store) that is assigned to the contact
userId Int The owner ID of the contact
birthdayAt String|\Carbon The date of birth of the contact
lastLoginAt String|\Carbon The date of the last login of the contact
lastLoginAtTimestamp String|\Carbon The date of the last login of the contact
lastOrderAt String|\Carbon The date of the last order
createdAt String|\Carbon The date the contact was created
updatedAt String|\Carbon The date the contact was last updated
privatePhone String The private phone number of the contact
privateFax String The private fax number of the contact
privateMobile String The private mobile phone number of the contact
ebayName String The eBay account name of the contact
paypalEmail String The email address of the PayPal account of the contact
paypalPayerId String The PayPal payer id of the contact
klarnaPersonalId String The Klarna personal id of the contact
dhlPostIdent String The DHL PostIdent of the contact
forumUsername String The user name of the contact in the forum
forumGroupId String The ID of the forum group that is assigned to the contact
singleAccess String The access type of the contact
contactPerson String The contact person of the contact
marketplacePartner String The marketplace partner status of the contact
valuta Int The foreign currency of the contact
discountDays Int The early payment discount period in days specified for the account
discountPercent Float The early payment discount in percent specified for the account
timeForPaymentAllowedDays Int The payment due date in days specified for the account
salesRepresentativeContactId Int The salesRepresentative ID of the contact
{"id":103,"number":"12XA44BC","externalId":"102030","typeId":4,"firstName":"John","lastName":"Doe","gender":"male","title":"doctorate","formOfAddress":"","newsletterAllowanceAt":"2014-04-09T23:18:24+02:00","classId":1,"blocked":0,"rating":3,"bookAccount":"","lang":"de","referrerId":1,"userId":3,"salesRepresentativeContactId":null,"birthdayAt":"1984-03-19T00:00:00+01:00","lastLoginAt":"2014-04-09T23:18:24+02:00","lastOrderAt":"2014-04-09T23:18:24+02:00","createdAt":"2014-04-09T23:18:24+02:00","updatedAt":"2016-07-22T23:12:15+02:00","options":[{"id":4,"contactId":103,"typeId":1,"subTypeId":4,"value":"030 12312234","priority":0,"createdAt":"2014-04-09 23:18:24","updatedAt":"2016-07-22 23:12:16"},{"id":5,"contactId":103,"typeId":1,"subTypeId":3,"value":"030 98898","priority":0,"createdAt":"2014-04-09 23:18:24","updatedAt":"2016-07-22 23:12:16"},{"id":6,"contactId":103,"typeId":2,"subTypeId":4,"value":"john@account.com","priority":0,"createdAt":"2014-04-09 23:18:24","updatedAt":"2016-07-22 23:12:16"}],"accounts":[{"id":4,"number":"1a","companyName":"plentymarkets GmbH","taxIdNumber":"","valuta":"0","discountDays":"0","discountPercent":"0.00","timeForPaymentAllowedDays":"0","userId":"1","deliveryTime":"0","dealerMinOrderValue":"0.00","createdAt":"2018-01-03T09:27:36+01:00","updatedAt":"2018-01-03T09:27:36+01:00","pivot":{"contactId":"120","accountId":"4"}}],"plentyId":94,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"John Doe"}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete a contact

Deletes a contact. The ID of the contact must be specified.

/rest/accounts/contacts/{contactId}

Parameters

Field Type Description
checkExistingOrders Bool Flag that checks if the contact is linked to orders. If the contact is linked to orders, CustomerDeleteException is thrown and the contact will not be deleted.

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Returns all contact related data.

/rest/accounts/contacts/{contactId}/related_data

Success 200

Field Type Description
id Int The ID of the contact
externalId String The external ID of the contact
number String The number of the contact (previous customer number)
typeId Int The ID of the contact type
firstName String The first name of the contact
lastName String The last name of the contact
fullName String The full name of the contact. A concatenation of first and last name.
email String The private email address of the contact
secondaryEmail String The secondary private email address of the contact
gender String The gender of the contact
title String The title of the contact, e.g. a doctorate
formOfAddress String The form of address for the contact
newsletterAllowanceAt String|\Carbon The time the contact registered for the newsletter as unix timestamp
classId Int The ID of the contact class
blocked Int The blocked status of the contact. Contacts can be blocked for a specific client (store). Possible values:
  • 0 = not blocked
  • 1 = blocked
rating Int The rating of the contact. This rating is for internal use only. 5 red stars are for the worst and 5 yellow stars for the best rating. Possible values:
  • -5 = 5 red stars (worst rating)
  • -4 = 4 red stars
  • -3 = 3 red stars
  • -2 = 2 red stars
  • -1 = 1 red star
  • 0 = 5 grey stars, no rating saved for the contact
  • 1 = 1 yellow star
  • 2 = 2 yellow stars
  • 3 = 3 yellow stars
  • 4 = 4 yellow stars
  • 5 = 5 yellow stars (best rating)
bookAccount String The book account (debtor account) of the contact. An additional, separate number that generally corresponds to the customer number or the debtor number in your financial accounting.
lang String The language of the contact
referrerId Float The origin of the contact
plentyId Int The client (store) that is assigned to the contact
userId Int The owner ID of the contact
birthdayAt String|\Carbon The date of birth of the contact
lastLoginAt String|\Carbon The date of the last login of the contact
lastLoginAtTimestamp String|\Carbon The date of the last login of the contact
lastOrderAt String|\Carbon The date of the last order
createdAt String|\Carbon The date the contact was created
updatedAt String|\Carbon The date the contact was last updated
privatePhone String The private phone number of the contact
privateFax String The private fax number of the contact
privateMobile String The private mobile phone number of the contact
ebayName String The eBay account name of the contact
paypalEmail String The email address of the PayPal account of the contact
paypalPayerId String The PayPal payer id of the contact
klarnaPersonalId String The Klarna personal id of the contact
dhlPostIdent String The DHL PostIdent of the contact
forumUsername String The user name of the contact in the forum
forumGroupId String The ID of the forum group that is assigned to the contact
singleAccess String The access type of the contact
contactPerson String The contact person of the contact
marketplacePartner String The marketplace partner status of the contact
valuta Int The foreign currency of the contact
discountDays Int The early payment discount period in days specified for the account
discountPercent Float The early payment discount in percent specified for the account
timeForPaymentAllowedDays Int The payment due date in days specified for the account
salesRepresentativeContactId Int The salesRepresentative ID of the contact

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!