This class provides RESTful services to get contact details, register a person as a member, and update a member.
Note: This REST API does not support pagination.
com.ibm.commerce.rest.member.handler.PersonContactHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/person/@self/contact | Gets the contacts in a person's address book. If the addressType optional query parameter is passed in, the returned contacts are filtered by addressType. |
GET | /store/{storeId}/person/@self/contact/{nickName} | Gets a person contact by nick name. |
GET | /store/{storeId}/person/@self/contact/byAddressId/{addressId} | Gets a person contact by address ID. |
POST | /store/{storeId}/person/@self/contact | Creates a new contact in a person's address book. |
PUT | /store/{storeId}/person/@self/contact/{nickName} | Updates the contact in the address book identified by nickName. |
DELETE | /store/{storeId}/person/@self/contact/{nickName} | Deletes the contact in the address book identified by nickName. |
Gets the contacts in a person's address book. If the addressType optional query parameter is passed in, the returned contacts are filtered by addressType.
getAllPersonContact
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
addressType | The address type. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Gets a person contact by nick name.
findPersonContactByNickName
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
nickName | The contact name saved in addressBook by registered shopper. | path | string | true | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Gets a person contact by address ID.
findPersonContactById
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
addressId | The address identifier. | path | string | true | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Creates a new contact in a person's address book.
addPersonContact
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
body | Request body. | body | person-contact | false | N/A |
HTTP Status Code | Description |
---|---|
201 | The requested resource has been created. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.member.handler.PersonContactHandler$UserIdentifier
Updates the contact in the address book identified by nickName.
updatePersonContact
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
nickName | The contact name saved in addressBook by registered shopper. | path | string | true | N/A |
body | Request body. | body | person-contact | false | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.member.handler.PersonContactHandler$AddressIdentifier
Deletes the contact in the address book identified by nickName.
deletePersonContact
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
nickName | The contact name saved in addressBook by registered shopper. | path | string | true | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Name | Data Type | Required |
---|---|---|
uniqueID | string | false |
distinguishedName | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier | false |
uniqueID | string | false |
distinguishedName | string | false |
Name | Data Type | Required |
---|---|---|
identifier | string | false |
Address identitifier.
Name | Data Type | Required |
---|---|---|
addressId | string | true |
User identitifier.
Name | Data Type | Required |
---|---|---|
userId | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
contact | person-contact.contact array | true |
userId | string | false |
addressId | string | false |
Name | Data Type | Required |
---|---|---|
middleName | string | false |
lastName | string | false |
organizationUnitName | string | false |
primary | string | false |
personTitle | string | false |
phone1 | string | true |
phone2 | string | true |
mobilePhone1 | string | true |
addressLine | string array | false |
phone1Publish | string | false |
nickName | string | true |
addressType | string | false |
mobilePhone1Country | string | true |
state | string | false |
email1 | string | true |
email2 | string | true |
country | string | false |
attributes | java.util.Map$Entry array | false |
language | string | false |
internalOfficeAddress | string | false |
firstName | string | false |
phone1Type | string | false |
organizationName | string | false |
phone2Type | string | false |
personIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
userDataField | person-contact.contact.userDataField array | false |
city | string | false |
phone2Publish | string | false |
bestCallingTime | string | false |
zipCode | string | false |
addressId | string | false |
fax1 | string | true |
fax2 | string | true |
geographicalTaxCode | string | false |
businessTitle | string | false |
organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType | false |
geographicalShippingCode | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
middleName | string | false |
lastName | string | false |
organizationUnitName | string | false |
primary | string | false |
personTitle | string | false |
phone1 | string | true |
phone2 | string | true |
mobilePhone1 | string | true |
addressLine | string array | false |
phone1Publish | string | false |
nickName | string | true |
addressType | string | false |
mobilePhone1Country | string | true |
state | string | false |
email1 | string | true |
email2 | string | true |
country | string | false |
attributes | java.util.Map$Entry array | false |
language | string | false |
internalOfficeAddress | string | false |
firstName | string | false |
phone1Type | string | false |
phone2Type | string | false |
organizationName | string | false |
personIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
userDataField | person-singleContact.userDataField array | false |
phone2Publish | string | false |
city | string | false |
bestCallingTime | string | false |
zipCode | string | false |
addressId | string | false |
fax1 | string | true |
fax2 | string | true |
geographicalTaxCode | string | false |
businessTitle | string | false |
organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType | false |
geographicalShippingCode | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |