WebSphere Commerce Service - User and Organization Management
These services provide APIs related to user and organization management in a B2B or B2C store. Use these classes to:
- Get member groups
- Get person details
- Add or update a member
- Get order and buyer approval status records and approve or reject them
- Register a person as a member
- Update a member
- Get or update organization information
- Get or update a checkout profile
- Switch organizations
Summary
Tag: Member Group
A member group is a grouping of members - users, organizations, or other member groups - used for various business purposes.
Operation Description GET /store/{storeId}/member_group/{memberGroupId} Get member group by ID
GET /store/{storeId}/member_group/member/{memberId} Get member group membership
GET /store/{storeId}/member_group Get approval member groups by properties filter
Tag: Person
This class provides RESTful services to get person details, register a member, and update a member. This class also provides RESTful services used by an administrator to find person information, register new and update existing user information.
Operation Description POST /store/{storeId}/person/updateMemberPassword Reset password
DELETE /store/{storeId}/person/@self/contextattributes/{jobNames}/{values} Delete context attribute values
POST /store/{storeId}/person Register user
GET /store/{storeId}/person Get user by query
PUT /store/{storeId}/person/{userId} Update account data
POST /store/{storeId}/person/{userId} Upate user (by administrator)
GET /store/{storeId}/person/{userId} Get user information by identifier
POST /store/{storeId}/person/updateMemberUser/{userId} Update member group assignment
PUT /store/{storeId}/person/@self Update account data
GET /store/{storeId}/person/@self Get account data
PUT /store/{storeId}/person/@self/languageCurrency Change language and currency preference
GET /store/{storeId}/person/@self/optOut Get opt out preferences
Tag: Approval Status
Accurate, secure transactions require that a second individual approve some electronic marketplace actions before they proceed. This individual, called an approver, can accept or reject requests to perform a specific action. This class provides RESTful services to retrieve order and buyer approval status record details and to approve or reject them.
Operation Description POST /store/{storeId}/approval_status/{approvalStatusId} Update status
GET /store/{storeId}/approval_status/{approvalStatusId} Get status by ID
GET /store/{storeId}/approval_status Get status by user
Tag: Contact
This class provides RESTful services to get contact details, register a person as a member, and update a member.
Operation Description POST /store/{storeId}/person/@self/contact Create contact in address book
GET /store/{storeId}/person/@self/contact Get contact from address book
GET /store/{storeId}/person/@self/contact/byAddressId/{addressId} Get contact by address ID
PUT /store/{storeId}/person/@self/contact/{nickName} Update contact by nickname
GET /store/{storeId}/person/@self/contact/{nickName} Get contact by nickname
DELETE /store/{storeId}/person/@self/contact/{nickName} Delete contact from address book
Tag: Organization
This class provides RESTful services to register an organization, to get or update organization information.
Operation Description POST /store/{storeId}/organization Register organization
GET /store/{storeId}/organization Get organization hierarchy
POST /store/{storeId}/organization/buyer Register buyer organization
GET /store/{storeId}/organization/@self/entitled_orgs Get entitled organizations
PUT /store/{storeId}/organization/{organizationId} Update organization information
POST /store/{storeId}/organization/{organizationId} Update approval group
GET /store/{storeId}/organization/{organizationId} Get information by identifier
Tag: Checkout Profile
This class provides RESTful services to get and update a checkout profile.
Operation Description PUT /store/{storeId}/person/@self/checkoutProfile Update check out profile
GET /store/{storeId}/person/@self/checkoutProfile Get check out profile
Tag: User Activate
Operation Description PUT /store/{storeId}/useractivate/emailactivate Activate email by logon ID
POST /store/{storeId}/useractivate/resendemail Resend email by logon ID
Tag: Switch Organization
This class provides RESTful services to switch organization.
Operation Description PUT /store/{storeId}/switchOrganization/switchTo Switch organization
Paths
Get status by userGET /store/{storeId}/approval_status
Tags: Approval StatusFinds order approval status records available to the current user.
storeId The store identifier.
path string q The query name.
query string , x ∈ { orderApprovals } submitterFirstName Query by the first name of the approval request submitter.
query string submitterMiddleName Query by the middle name of the approval request submitter.
query string submitterLastName Query by last name of the approval request submitter.
query string startSubmitTime Query by approval request start time.
query string (date) endSubmitTime Query by approval request end time.
query string (date) status Query by approval request status.
query integer (int32) approvalStatusId Query by approval request approval status id.
query integer (int64) entityId Query by approval request entity ID, such as order ID.
query integer (int64) approverId Query by approver id. Only returns approval requests that can be approved by the current user.
query integer (int64) orderBy Order by.
query string , x ∈ { A-approvalStatusId , A-entityId , A-submitTime , A-approveTime , A-status , A-flowTypeId , A-stateId , D-approvalStatusId , D-entityId , D-submitTime , D-approveTime , D-status , D-flowTypeId , D-stateId } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int64) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int64)
Get status by ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"recordSetCompleteIndicator": true,
"recordSetCount": 1,
"recordSetStartNumber": 0,
"recordSetTotal": 1,
"resultList": [
{
"approvalStatusId": "13003",
"approveTime": null,
"approverGroupId": "-999",
"approverId": "-1004",
"comment": null,
"entityId": "12050",
"flowId": "10004",
"flowTypeId": "10004",
"stateId": "10030",
"status": "0",
"submitTime": "2014-11-24T18:58:06.804000000Z",
"submitter": {
"firstName": "Jane",
"lastName": "Smith",
"middleName": ""
},
"submitterId": "12050"
}
]
}com.ibm.commerce.approval.beans.OrderApprovalStatusListDataBean_IBM_Store_Summary
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/approval_status/{approvalStatusId}
Tags: Approval StatusFinds an approval status record by its ID.
storeId The store identifier.
path string approvalStatusId The approval status ID.
path string
Update status application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"resultList": [
{
"approvalStatusId": "13002",
"approveTime": "2014-11-24T19:13:18.583000000Z",
"approverGroupId": "-999",
"approverId": "-1004",
"comment": null,
"entityId": "12049",
"flowId": "10004",
"flowTypeId": "10004",
"stateId": "10030",
"status": "1",
"submitTime": "2014-11-24T16:43:38.562000000Z",
"submitterId": "12049"
}
]
}com.ibm.commerce.approval.beans.ApprovalStatusDataBean_IBM_Store_Summary
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/approval_status/{approvalStatusId}
Tags: Approval StatusUpdates the status to approve or reject and adds an optional comment to the approval status record.
The request body for updating an approval status record. com.ibm.commerce.rest.approvalstatus.handler.ApprovalStatusHandler$UpdateApprovalStatusParameterDescription
storeId The store identifier.
path string approvalStatusId The approval status ID.
path string
Get approval member groups by properties filter application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.rest.approvalstatus.handler.ApprovalStatusHandler$UpdateApprovalStatusResponse
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/member_group
Tags: Member GroupFinds approval member groups types for an organization based on properties filter.
storeId The store identifier.
path string propertiesFilter Properties value based on which approval member groups to filter.
query string q The query name.
query string , x ∈ { approvalMemberGroupTypes }
Get member group membership application/json application/xml application/atom+xml application/xhtml+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"recordSetCompleteIndicator": true,
"recordSetCount": 2,
"recordSetStartNumber": 0,
"recordSetTotal": 2,
"resultList": [
{
"description": null,
"memberGroupId": -158,
"name": "AccountAdministratorsForOrg",
"ownerId": "-2001"
},
{
"description": null,
"memberGroupId": -23,
"name": "BuyerApprovers",
"ownerId": "-2001"
}
]
}com.ibm.commerce.approval.beans.ApprovalGroupTypeListBean_IBM_Store_Summary
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/member_group/member/{memberId}
Tags: Member GroupFinds a member group current shopper explicitly belongs.
storeId The store identifier.
path string memberId The memberID.
path string
Get member group by ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.member.beans.MemberGroupListDataBean_IBM_Store_Summary
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/member_group/{memberGroupId}
Tags: Member GroupFinds a member group by its ID.
storeId The store identifier.
path string memberGroupId The member group ID.
path string
Get organization hierarchy application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"resultList": [
{
"description": null,
"memberGroupId": -23,
"name": "BuyerApprovers",
"ownerId": "-2001"
}
]
}com.ibm.commerce.member.beans.MemberGroupListDataBean_IBM_Store_Summary
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/organization
Tags: OrganizationGets the organization hierarchy required by the Digital Analytics Integration.
storeId The storeId.
path string profileName Profile name. Profiles determine the subset of data returned by a query.
query string , x ∈ { IBM_Store_Summary } q The query name.
query string , x ∈ { organizationHierarchy } accountId The Trading account Id.
query string
Register organization application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"roleDataBeans": [
]
}com.ibm.commerce.user.beans.OrganizationHierarchyDataBean_IBM_Store_Summary
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/organization
Tags: OrganizationAllows an administrator to register an organization.
application/json application/xml
Request body. com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityAddRequest
storeId The store identifier.
path string
Get entitled organizations application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"addressId": "15802",
"orgEntityId": "7000000000000004402",
"viewTaskName": "RedirectView"
}com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityIdentity
201 Created The requested resource has been created.
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/organization/@self/entitled_orgs
Tags: OrganizationAllows users to find their own entitled organizations.
responseFormat query string storeId path string accountCheck query string explicitEntitlement query string
Register buyer organization application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.member.beans.OrganizationListDataBean_IBM_Organization_Summary
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
POST /store/{storeId}/organization/buyer
Tags: OrganizationRegisters a buyer organization and a buyer organization administrator.
application/json application/xml
Request body. com.ibm.commerce.rest.member.handler.OrganizationHandler$BuyerRegistrationAddRequest
storeId The store identifier.
path string
Get information by identifier application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityBuyerIdentifier
- 201 Created
The requested resource has been created.
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/organization/{organizationId}
Tags: OrganizationAllows administrators to find organization information by organization identifier.
storeId The store identifier.
path string organizationId The organization identifier.
path string profileName Profile name. Profiles determine the subset of data returned by a query. Default profile name = IBM_Organization_Summary.
query string , x ∈ { IBM_Organization_Short_Summary , IBM_Organization_Summary , IBM_Organization_Details , IBM_Org_Entity_Details , IBM_Assigned_Roles_Details , IBM_Parent_Assigned_Roles_Details }
Update approval group application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"addressBook": [
],
"businessCategory": null,
"contactInfo": {
"address1": "",
"address2": "",
"address3": "",
"addressId": "-2000",
"addressType": "",
"city": "",
"country": "",
"countryDisplayName": "",
"email1": "",
"email2": "",
"firstName": "",
"lastName": "",
"middleName": "",
"mobilePhone1": "",
"nickName": "Default Organization",
"organizationName": "",
"phone1": "",
"phone2": "",
"state": "",
"stateProvDisplayName": "",
"zipCode": ""
},
"description": null,
"displayName": "Default Organization",
"organizationDisplayName": "Default Organization (Root Organization)",
"organizationId": "-2000",
"organizationName": "Default Organization",
"state": "1",
"status": 0
}com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/organization/{organizationId}
Tags: OrganizationUpdates an approval group.
Request body. com.ibm.commerce.rest.member.handler.OrganizationHandler$UpdateApprovalGroups
storeId The store identifier.
path string organizationId The organization identifier.
path string action The action of the rest service.
query string , x ∈ { updateApprovalGroups }
Update organization information application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"viewTaskName": "RedirectView"
}com.ibm.commerce.rest.member.handler.OrganizationHandler$UpdateApprovalGroupsResponse
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
PUT /store/{storeId}/organization/{organizationId}
Tags: OrganizationAllows administrators to update organization information.
application/json application/xml
Request body. com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityUpdateRequest
storeId The store identifier.
path string organizationId The organization identifier.
path string
Get user by query application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"addressId": "12338",
"orgEntityId": "7000000000000000919",
"viewTaskName": "RedirectView"
}com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityIdentity
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/person
Tags: PersonAllows administrators to find users based on a query name. See each query for details on input and output.
storeId The store identifier.
path string q The query name.
query string , x ∈ { usersICanAdmin }
Register user application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"pageNumber": 1,
"pageSize": "3",
"recordSetCompleteIndicator": false,
"recordSetCount": 3,
"recordSetTotal": 25,
"userDataBeans": [
{
"businessProfile": {
"employeeId": null,
"organizationId": "7000000000000000904"
},
"demographics": null,
"displayName": "admin5020",
"firstName": null,
"lastName": null,
"logonId": "admin5020",
"memberId": "4037",
"personalizationId": null,
"preferredCurrency": "USD",
"preferredLanguageId": "",
"state": "0",
"userId": "4037",
"userProfile": null
},
{
"businessProfile": {
"employeeId": null,
"organizationId": "7000000000000000905"
},
"demographics": null,
"displayName": "admin5021",
"firstName": null,
"lastName": null,
"logonId": "admin5021",
"memberId": "4038",
"personalizationId": null,
"preferredCurrency": "USD",
"preferredLanguageId": "",
"state": "0",
"userId": "4038",
"userProfile": null
},
{
"businessProfile": {
"employeeId": null,
"organizationId": "7000000000000000914"
},
"demographics": null,
"displayName": "admin50210",
"firstName": null,
"lastName": null,
"logonId": "admin50210",
"memberId": "4047",
"personalizationId": null,
"preferredCurrency": "USD",
"preferredLanguageId": "",
"state": "0",
"userId": "4047",
"userProfile": null
}
]
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/person
Tags: PersonRegisters a user. When the mode is set to admin, the registration is done by an administrator.
application/json application/xml
Request body. com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminAddRequest
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } mode The mode of the rest service.
query string , x ∈ { self , admin }
Get account data application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminAddResponse
- 201 Created
The requested resource has been created.
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/person/@self
Tags: PersonGets the account data for a registered user.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Update account data application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"accountStatus": "Enabled",
"addressId": "15309",
"addressLine": [
"123 Main St",
"",
""
],
"addressType": "ShippingAndBilling",
"challengeQuestion": "-",
"city": "Toronto",
"contact": [
{
"addressId": "15810",
"addressLine": [
"123 Main St",
"",
""
],
"addressType": "Billing",
"city": "Toronto",
"country": "CA",
"email1": "john@example.com",
"firstName": "John",
"lastName": "Smith",
"nickName": "Default_Billing_10001",
"primary": "false",
"state": "ON",
"zipCode": "M1M1M1"
},
{
"addressId": "15811",
"addressLine": [
"123 Main St",
"",
""
],
"addressType": "Shipping",
"city": "Toronto",
"country": "CA",
"email1": "john@example.com",
"firstName": "John",
"lastName": "Smith",
"nickName": "Default_Shipping_10001",
"primary": "false",
"state": "ON",
"zipCode": "M1M1M1"
},
{
"addressId": "15308",
"addressLine": [
"123 Main St",
"",
""
],
"addressType": "ShippingAndBilling",
"city": "Toronto",
"country": "CA",
"email1": "jane@example.com",
"firstName": "Jane",
"lastName": "Smith",
"nickName": "jane",
"phone1": "4161234567",
"primary": "false",
"state": "ON",
"zipCode": "M1M1M1"
}
],
"country": "CA",
"distinguishedName": "uid=john,o=default organization,o=root organization",
"email1": "john@example.com",
"firstName": "John",
"gender": "Unspecified",
"lastName": "Smith",
"lastUpdate": "2014-11-20T14:32:21.459Z",
"logonId": "john",
"nickName": "john",
"organizationDistinguishedName": "o=default organization,o=root organization",
"orgizationId": "-2000",
"passwordExpired": "false",
"preferredCurrency": "USD",
"preferredLanguage": "en_US",
"primary": "true",
"profileType": "Consumer",
"receiveEmailPreference": [
{
"storeID": "10001",
"value": "false"
}
],
"receiveSMSPreference": [
{
"storeID": "10001",
"value": "false"
}
],
"registrationApprovalStatus": "Approved",
"registrationDateTime": "2014-11-20T14:32:21.469Z",
"registrationStatus": "RegisteredPerson",
"resourceId": "https://localhost:443/wcs/resources/store/10001/person/@self?responseFormat=json",
"resourceName": "person",
"state": "ON",
"userId": "11051",
"zipCode": "M1M1M1"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
PUT /store/{storeId}/person/@self
Tags: PersonUpdates account data for a registered user. This also supports resetting password for unauthenticated and authenticated users. When action is set to 'updateUserRegistration', user account data is updated using UserRegistrationUpdateCmd
application/json application/xml
Request body. com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationUpdateRequest
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } action The action of the rest service.
query string , x ∈ { updateUserRegistration }
Get check out profile application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.rest.member.handler.PersonHandler$UserIdentifier
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/person/@self/checkoutProfile
Tags: Checkout ProfileGets the Check Out Profile for the logged in user using the Member service. The shopper must log in before invoking this method.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Update check out profile application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. person-checkoutProfile
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
PUT /store/{storeId}/person/@self/checkoutProfile
Tags: Checkout ProfileUpdates the CheckOutProfile for the logged in user using the Member service. The shopper must log in before invoking this method.
Update checkout profile body. person-checkoutProfile
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get contact from address book application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"userId": "11051"
}com.ibm.commerce.rest.member.handler.PersonCheckoutProfileHandler$UserIdContainer
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/person/@self/contact
Tags: ContactGets the contacts in a person's address book. If the addressType optional query parameter is passed in, the returned contacts are filtered by addressType.
storeId The store identifier.
path string addressType The address type.
query string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Create contact in address book application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. person-contact
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
POST /store/{storeId}/person/@self/contact
Tags: ContactCreates a new contact in a person's address book.
application/json application/xml
Request body. person-contact
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get contact by address ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
No response was specified. com.ibm.commerce.rest.member.handler.PersonContactHandler$UserIdentifier
- 201 Created
The requested resource has been created.
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/person/@self/contact/byAddressId/{addressId}
Tags: ContactGets a person contact by address ID.
storeId The store identifier.
path string addressId The address identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Delete contact from address book application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. person-singleContact
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
DELETE /store/{storeId}/person/@self/contact/{nickName}
Tags: ContactDeletes the contact in the address book identified by nickname.
storeId The store identifier.
path string nickName The contact name saved in addressBook by registered shopper.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get contact by nickname application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Empty
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/person/@self/contact/{nickName}
Tags: ContactGets a person contact by nickname.
storeId The store identifier.
path string nickName The contact name saved in addressBook by registered shopper.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Update contact by nickname application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. person-singleContact
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
PUT /store/{storeId}/person/@self/contact/{nickName}
Tags: ContactUpdates the contact in the address book identified by nickname.
application/json application/xml
Request body. person-contact
storeId The store identifier.
path string nickName The contact name saved in addressBook by registered shopper.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Delete context attribute values application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.rest.member.handler.PersonContactHandler$AddressIdentifier
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
DELETE /store/{storeId}/person/@self/contextattributes/{jobNames}/{values}
Tags: PersonDeletes one or more values of a context attribute for a registered user.
jobNames Name of the person's job function to use for the request.
path string values Value of the person's job function.
path string storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Change language and currency preference application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"addressId": [
"12344"
],
"userId": [
"4054"
]
}com.ibm.commerce.rest.member.handler.PersonHandler$DeleteContextAttribute
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
PUT /store/{storeId}/person/@self/languageCurrency
Tags: PersonChanges language and currency preference in profile and in context.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get opt out preferences application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.price.commands.SetCurrencyPreferenceCmd
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/person/@self/optOut
Tags: PersonFinds personal opt-out. When the store level personal opt-out does not exist, the site level personal opt-out is returned.
storeId The store identifier.
path string profileName Profile name. Profiles determine the subset of data returned by a query. Default profile name = IBM_optOut_email.
query string , x ∈ { IBM_optOut_email , IBM_optOut_sms , IBM_optOut_all }
Reset password application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"userReceive": false,
"userReceiveSMS": false
}com.ibm.commerce.emarketing.beans.EmailUserReceiveDataBean_IBM_optOut_all
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/person/updateMemberPassword
Tags: PersonAllows a CSR or CSS to reset the password for a registered user. It also allows resetting password when the CSR / CSS has established a session to act on behalf of a user.
application/json application/xml
Request body. com.ibm.commerce.rest.member.handler.PersonHandler$ResetPasswordAdministratorRequest
storeId The store identifier.
path string mode The mode in which resetPassword is run. ResetPassword can be executed in an administrator session or in an on-behalf session for a user Default value is 'resetPasswordAdmin'.
query string , x ∈ { resetPasswordAdmin , resetPasswordOnBehalf }
Update member group assignment application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.security.commands.ResetPasswordAdministratorCmd
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
POST /store/{storeId}/person/updateMemberUser/{userId}
Tags: PersonUpdates the user to include, exclude, or unassign the user from a member group.
Request body. com.ibm.commerce.rest.member.handler.PersonHandler$UpdateMemberUser
storeId The store identifier.
path string userId The user identifier.
path string
Get user information by identifier application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
}com.ibm.commerce.rest.member.handler.PersonHandler$UpdateMemberUserResponse
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/person/{userId}
Tags: PersonAllows administrators to find user information by user identifier.
storeId The store identifier.
path string userId The user identifier.
path string profileName Profile name. Profiles determine the subset of data returned by a query. The default profile name is IBM_User_Display_Details.
query string , x ∈ { IBM_User_Display_Details , IBM_User_Registration_Details , IBM_User_Top_Level_Org_Administered , IBM_Assigned_Roles_Details , IBM_Roles_Of_User_All , IBM_Roles_Of_User_In_Orgs_I_Can_Admin }
Upate user (by administrator) application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"address": {
"address1": null,
"address2": null,
"address3": null,
"addressId": "-1000",
"addressType": null,
"city": null,
"country": null,
"email1": null,
"email2": null,
"fax1": null,
"fax2": null,
"firstName": null,
"lastName": "wcsadmin",
"memberId": "-1000",
"middleName": null,
"mobilePhone1": null,
"mobilePhone1Country": null,
"nickName": "wcsadmin",
"phone1": null,
"phone2": null,
"state": null,
"zipCode": null
},
"demographics": {
"age": "",
"dateOfBirth": "",
"gender": null
},
"logonId": "wcsadmin",
"organizationId": "-2001",
"organizationName": "",
"parentMemberId": "-2001",
"personTitle": "",
"preferredCurrency": "",
"preferredLanguage": "",
"registerType": "S",
"userId": "-1000",
"userProfile": {
"description": "Internal use only.",
"displayName": null,
"receiveSMSNotification": "0"
}
}com.ibm.commerce.user.beans.MemberRoleAssignDataBean_IBM_Roles_Of_User_In_Orgs_I_Can_Admin
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/person/{userId}
Tags: PersonPerforms an action on a person by an administrator. See each action for details on input and output.
application/json application/xml
storeId The store identifier.
path string userId The user identifier.
path string action The action of the rest service.
query string , x ∈ { assignRole , unassignRole }
Update account data application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"viewTaskName": "RedirectView"
}201 Created The requested resource has been created.
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
PUT /store/{storeId}/person/{userId}
Tags: PersonAllows administrators to update account data for a registered user.
application/json application/xml
Request body. com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminUpdateRequest
storeId The store identifier.
path string userId The user identifier.
path string
Switch organization application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"addressId": "15805",
"userId": "4053",
"viewTaskName": "RedirectView"
}com.ibm.commerce.rest.member.handler.PersonHandler$UserIdentifier
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
PUT /store/{storeId}/switchOrganization/switchTo
Tags: Switch OrganizationResponds to the organization change action.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Activate email by logon ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Empty
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
PUT /store/{storeId}/useractivate/emailactivate
Tags: User ActivateActivates the user by LogonId.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Resend email by logon ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.member.facade.server.commands.UserRegistrationEmailActivateCmd
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
POST /store/{storeId}/useractivate/resendemail
Tags: User ActivateResends and email to the active user by LogonId.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.member.facade.server.commands.UserRegistrationEmailActivateResendCmd
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
Schema definitions
com.ibm.commerce.approval.beans.ApprovalGroupTypeListBean_IBM_Store_Summary: object
- resultList: object[]
com.ibm.commerce.approval.beans.ApprovalGroupTypeListBean_IBM_Store_Summary.resultList
com.ibm.commerce.approval.beans.ApprovalGroupTypeListBean_IBM_Store_Summary.resultList: object
- memberGroupTypeId: string
- properties: string
- description: string
- name: string
com.ibm.commerce.approval.beans.ApprovalStatusDataBean_IBM_Store_Summary: object
- approvalStatusId: string
- approverGroupId: string
- submitTime: string (date)
- flowTypeId: string
- stateId: string
- comment: string
- submitterId: string
- flowId: string
- approveTime: string (date)
- status: string
- approverId: string
- entityId: string
com.ibm.commerce.approval.beans.OrderApprovalStatusListDataBean_IBM_Store_Summary: object
- recordSetCount: integer (int32)
- recordSetCompleteIndicator: boolean
- recordSetStartNumber: integer (int32)
- resultList: object[]
com.ibm.commerce.approval.beans.OrderApprovalStatusListDataBean_IBM_Store_Summary.resultList - recordSetTotal: integer (int32)
com.ibm.commerce.approval.beans.OrderApprovalStatusListDataBean_IBM_Store_Summary.resultList: object
- approvalStatusId: string
- approverGroupId: string
- submitTime: string (date)
- flowTypeId: string
- stateId: string
- comment: string
- submitterId: string
- flowId: string
- approveTime: string (date)
- status: string
- approverId: string
- entityId: string
com.ibm.commerce.emarketing.beans.EmailUserReceiveDataBean_IBM_optOut_all: object
- userReceiveSMS: boolean
- userReceive: boolean
com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType: object
- distinguishedName: string
- uniqueID: string
com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType: object
- distinguishedName: string
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier: object
- identifier: string
com.ibm.commerce.member.beans.MemberGroupListDataBean_IBM_Store_Summary: object
- recordSetCount: integer (int32)
- recordSetCompleteIndicator: boolean
- recordSetStartNumber: integer (int32)
- resultList: object[]
com.ibm.commerce.member.beans.MemberGroupListDataBean_IBM_Store_Summary.resultList - recordSetTotal: integer (int32)
com.ibm.commerce.member.beans.MemberGroupListDataBean_IBM_Store_Summary.resultList: object
- ownerId: string
- description: string
- name: string
- memberGroupId: integer (int64)
com.ibm.commerce.member.beans.OrganizationListDataBean_IBM_Organization_Summary: object
- entitledOrganizations: object[]
com.ibm.commerce.member.beans.OrganizationListDataBean_IBM_Organization_Summary.entitledOrganizations - accountCheck: boolean
com.ibm.commerce.member.beans.OrganizationListDataBean_IBM_Organization_Summary.entitledOrganizations: object
- distinguishedName: string
- organizationId: integer (int64)
- displayName: string
- memberId: integer (int64)
- organizationName: string
com.ibm.commerce.member.facade.server.commands.UserRegistrationEmailActivateCmd: object
com.ibm.commerce.member.facade.server.commands.UserRegistrationEmailActivateResendCmd: object
com.ibm.commerce.price.commands.SetCurrencyPreferenceCmd: object
com.ibm.commerce.rest.approvalstatus.handler.ApprovalStatusHandler$UpdateApprovalStatusParameterDescription: object
Description of the post input body to update an approval status record.
- comments: string
Comment text for status change.
- aprv_act: string , x ∈ { 1 , 2 }
Approval status. Valid values are 1 for approve and 2 for reject.
com.ibm.commerce.rest.approvalstatus.handler.ApprovalStatusHandler$UpdateApprovalStatusResponse: object
Description of approval status record update response.
- resultmsg: string
Update approval status message.
com.ibm.commerce.rest.member.handler.OrganizationHandler$BuyerRegistrationAddRequest: object
Request of BuyerRegistrationAddCmd.
- usr_: string[]
Parameters from UserRegistrationAdd with "usr_".
string - org_: string[]
Parameters from OrgEntityAdd with "org_".
string
com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityAddRequest: object
Request of OrgEntityAddCmd.
- addressType: string
Type of address, valid values are configurable by using a properties file: S (shipto), B (billto), and SB (both shipto and billto). A single address may be of different types. If a properties file cannot be found, a default of SB is used.
- personTitle: string
The title of the user whose address is being entered (for example, Dr., Rev., Mr. or Ms.).
- orgEntityName: string
The name of the organization or organizational unit. Leading and trailing spaces is trimmed. When the system is configured with LDAP, the following characters are not allowed when the orgEntityName is used to construct the distinguished name: 1. The # character occurring at the beginning of orgEntityName. 2. Any of the following characters: = , + " \ < > ;.
- billingCodeType: string
Code designating the method of code structure used for the billing code. Default is D, assigned by buyer.
- customMemberAttributes: string[]
We can manage custom member attributes (MBRATTRVAL table) for this organization using the following syntax: &attributeName_storeId_action_number=value.
string - email2: string
The registrant's secondary e-mail or Web address.
- email1: string
The registrant's primary e-mail or Web address.
- distinguishedName: string
DN of the organization or organizational unit, for LDAP use.
- city: string
The name of the city where the registrant resides.
- administratorMiddleName: string
The middle name of the administrator.
- middleName: string
The middle name of the registrant.
- administratorLastName: string
The last name of the administrator.
- state: string
The name of the state, province, or equivalent where the registrant resides.
- addressField1: string
Customizable field.
- phone2: string
The registrant's secondary phone number.
- addressField3: string
Customizable field.
- addressField2: string
Customizable field.
- fax2: string
The registrant's secondary facsimile number.
- fax1: string
The registrant's primary facsimile number.
- phone1Type: string
The type of phone used for the registrant's primary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
- orgEntityField1: string
Customizable field.
- orgEntityField2: string
Customizable field.
- orgEntityField3: string
Customizable field.
- phone2Type: string
The type of phone used for the registrant's secondary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
- description: string
A description of the registrant.
- publishPhone2: string
1 - An indicator that the registrant's secondary phone number is listed; 0 - An indicator that the registrant's secondary phone number is unlisted.
- taxPayerId: string
The ID for the tax payer.
- URL: string
The URL to call when the command completes successfully.
- address1: string
The registrant's street address, to a maximum of three lines of information.
- address2: string
The registrant's street address, to a maximum of three lines of information.
- address3: string
The registrant's street address, to a maximum of three lines of information.
- zipCode: string
The ZIP or postal code of the registrant's address.
- packageSuppression: string
1 - An indicator to include package inserts when the order is shipped; 0 - An indicator to not include package inserts when the order is shipped. There is no default for this field. If the field is left unused, it remains null in the database.
- bestCallingTime: string
D - An indicator that daytime is the best time to call the registrant; E - An indicator that evening is the best time to call the registrant.
- phone1: string
The registrant's primary phone number.
- taxGeoCode: string
A tax code based on geographical region, especially useful with tax software.
- publishPhone1: string
1 - An indicator that the registrant's primary phone number is listed; 0 - An indicator that the registrant's primary phone number is unlisted. There is no default for these publishPhone fields. If the field is left unused, it remains null in the database.
- organizationUnitName: string
The name of the unit within the organization that the registrant represents.
- firstName: string
The first name of the registrant.
- organizationName: string
The name of the organization that the registrant represents.
- businessCategory: string
Describes the kind of business performed by an organization or organizational unit.
- preferredDelivery: string
The registrant's preferred mode of delivery.
- shippingGeoCode: string
A shipping code based on geographical region, especially useful with tax software.
- country: string
The name of the country or region where the registrant resides.
- parentMemberId: string
Required if orgEntityType equals 'OU': The member ID of the parent organizational entity where the new organizational entity is added. For an organization (orgEntityType=O), this parameter is not mandatory; it defaults to Root Organization.
- administratorFirstName: string
The first name of the administrator.
- billingCode: string
The registrant's organization's code to identify the shipping or billing addresses and cost center.
- lastName: string
Required if the authentication mode is LDAP: The last name of the registrant. If the authentication mode is LDAP, this parameter is mandatory.
- orgEntityType: string
The type of the organizational entity being added. O - Organization; OU - Organizational Unit.
- legalId: string
Registered organization identifier; may be null for an organizational unit.
com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityBuyerIdentifier: object
Response of registering an organization entity and a buyer.
- orgEntityId: string
The organization entity identifier.
- userId: string
The buyer identifier.
com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityIdentity: object
Information about an organization entity identity.
- orgEntityId: string
The organization entity identifier.
- addressId: string
The address identifier of the organization entity.
com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityUpdateRequest: object
Request of OrgEntityUpdateCmd.
- addressType: string
Type of address, valid values are configurable by using a properties file: S (shipto), B (billto), and SB (both shipto and billto). A single address may be of different types. If a properties file cannot be found, a default of SB is used.
- personTitle: string
The title of the user whose address is being entered (for example, Dr., Rev., Mr. or Ms.).
- orgEntityName: string
The name of the organization or organizational unit.
- billingCodeType: string
Code designating the method of code structure used for the billing code. Default is D, assigned by buyer.
- orgEntityId: string
The ID for this organization or organizational unit.
- customMemberAttributes: string[]
We can manage custom member attributes (MBRATTRVAL table) for this organization using the following syntax: &attributeName_storeId_action_number=value.
string - email2: string
The registrant's secondary e-mail or Web address.
- email1: string
The registrant's primary e-mail or Web address.
- city: string
The name of the city where the registrant resides.
- administratorMiddleName: string
The middle name of the administrator.
- middleName: string
The middle name of the registrant.
- administratorLastName: string
The last name of the administrator.
- addressField3: string
Customizable field.
- addressField1: string
Customizable field.
- phone2: string
The registrant's secondary phone number.
- state: string
The name of the state, province, or equivalent where the registrant resides.
- addressField2: string
Customizable field.
- fax2: string
The registrant's secondary facsimile number.
- fax1: string
The registrant's primary facsimile number.
- phone1Type: string
The type of phone used for the registrant's primary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
- orgEntityField1: string
Customizable field.
- orgEntityField2: string
Customizable field.
- orgEntityField3: string
Customizable field.
- phone2Type: string
The type of phone used for the registrant's secondary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
- description: string
A description of the registrant.
- publishPhone2: string
1 - An indicator that the registrant's secondary phone number is listed; 0 - An indicator that the registrant's secondary phone number is unlisted.
- taxPayerId: string
The ID for the tax payer.
- URL: string
The URL to call when the command completes successfully.
- address1: string
The registrant's street address, to a maximum of three lines of information.
- address2: string
The registrant's street address, to a maximum of three lines of information.
- address3: string
The registrant's street address, to a maximum of three lines of information.
- zipCode: string
The ZIP or postal code of the registrant's address.
- packageSuppression: string
1 - An indicator to include package inserts when the order is shipped; 0 - An indicator to not include package inserts when the order is shipped. There is no default for this field. If the field is left unused, it remains null in the database.
- bestCallingTime: string
D - An indicator that daytime is the best time to call the registrant; E - An indicator that evening is the best time to call the registrant.
- phone1: string
The registrant's primary phone number.
- taxGeoCode: string
A tax code based on geographical region, especially useful with tax software.
- publishPhone1: string
1 - An indicator that the registrant's primary phone number is listed; 0 - An indicator that the registrant's primary phone number is unlisted. There is no default for these publishPhone fields. If the field is left unused, it remains null in the database.
- organizationUnitName: string
The name of the unit within the organization that the registrant represents.
- firstName: string
The first name of the registrant.
- organizationName: string
The name of the organization that the registrant represents.
- businessCategory: string
Describes the kind of business performed by an organization or organizational unit.
- preferredDelivery: string
The registrant's preferred mode of delivery.
- shippingGeoCode: string
A shipping code based on geographical region, especially useful with tax software.
- country: string
The name of the country or region where the registrant resides.
- administratorFirstName: string
The first name of the administrator.
- billingCode: string
The registrant's organization's code to identify the shipping or billing addresses and cost center.
- lastName: string
Required if the authentication mode is LDAP: The last name of the registrant. If the authentication mode is LDAP, this parameter is mandatory.
- legalId: string
Registered organization identifier; may be null for an organizational unit.
com.ibm.commerce.rest.member.handler.OrganizationHandler$UpdateApprovalGroups: object
Information about an organization entity identity.
- URL: string
The URL to call when the command completes successfully.
- orgEntityId: string
The organization entity identifier.
- segmentId: string
The ApprovalGroup identifier for a specific organization.
com.ibm.commerce.rest.member.handler.OrganizationHandler$UpdateApprovalGroupsResponse: object
Information about an organization entity identity.
- orgEntityId: string
The organization entity identifier.
- segmentId: string
The ApprovalGroup identifier for a specific organization.
- URL: string
The URL to call when the command completes successfully.
- storeId: string
The current store identifier.
- catalogId: string
The catalog identifier.
- requesttype: string
The request type for example, ajax.
com.ibm.commerce.rest.member.handler.PersonCheckoutProfileHandler$UserIdContainer: object
User identification container.
- userId: string
User identification.
com.ibm.commerce.rest.member.handler.PersonContactHandler$AddressIdentifier: object
Address identifier.
- addressId: string
The address identifier.
com.ibm.commerce.rest.member.handler.PersonContactHandler$UserIdentifier: object
User identifier.
- userId: string
The user identifier.
com.ibm.commerce.rest.member.handler.PersonHandler$DeleteContextAttribute: object
Delete context attribute response.
- userId: string[]
The user identifier list.
string - addressId: string[]
The address identifier list.
string
com.ibm.commerce.rest.member.handler.PersonHandler$ResetPasswordAdministratorRequest: object
Request of ResetPasswordAdministratorCmd.
- URL: string
The URL to call when the command completes successfully.
- administratorPassword: string
The administrator password.
- logonId: string
The logonId of shopper to reset the password for.
com.ibm.commerce.rest.member.handler.PersonHandler$UpdateMemberUser: object
Body of MemberGroupMemberUpdateCmd.
- addAsExplicitInclusionToMemberGroupId: string
MemberGroup Identifiers to explicitly add the user too .
- addAsExplicitExclusionToMemberGroupId: string
MemberGroup Identifiers to explicitly exclude the user from.
- removeFromMemberGroupId: string
MemberGroup Identifiers to remove the user from.
com.ibm.commerce.rest.member.handler.PersonHandler$UpdateMemberUserResponse: object
response of MemberGroupMemberUpdateCmd.
- storeId: string
The current store identifier.
- addAsExplicitExclusionToMemberGroupId: string
MemberGroup Identifiers to explicitly exclude the user from.
- URL: string
The URL to call when the command completes successfully.
- addAsExplicitInclusionToMemberGroupId: string
MemberGroup Identifiers to explicitly add the user to.
- userId: string
The user identifier.
- catalogId: string
The catalog identifier.
- requesttype: string
The request type for example, ajax.
- removeFromMemberGroupId: string
MemberGroup Identifiers to remove the user from.
com.ibm.commerce.rest.member.handler.PersonHandler$UserIdentifier: object
User identifier.
- userId: string
The user identifier.
com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminAddRequest: object
Request of UserRegistrationAdminAdd.
- maritalStatus: string
The registrant's marital status.
- photo: string
URL or path to a photo of the registrant.
- manager: string
The name of the registrant's manager.
- email2: string
The registrant's secondary e-mail or Web address.
- children: string
The number of children the registrant has.
- email1: string
The registrant's primary e-mail or Web address.
- middleName: string
The middle name of the registrant.
- logonPassword: string
The registrant's password. In database mode, the password is encrypted before it is saved in the database. In LDAP mode, the password is only stored on the LDAP server.
- profileType: string
The profile type of the user.
- officeAddress: string
The internal address (for example, mail stop).
- preferredMeasure: string
The registrant's preferred unit of measure.
- URL: string
The URL to call when the command completes successfully.
- address1: string
The registrant's street address, to a maximum of three lines of information.
- address2: string
The registrant's street address, to a maximum of three lines of information.
- address3: string
The registrant's street address, to a maximum of three lines of information.
- zipCode: string
The ZIP or postal code of the registrant's address.
- logonPasswordVerify: string
Required if the logonPassword is used: The registrant's password, entered a second time.
- mobilePhone1: string
The registrant's mobile phone number used for SMS, for example, 4161235555.
- organizationName: string
The name of the organization that the registrant represents.
- firstName: string
The first name of the registrant.
- gender: string
The registrant's gender.
- receiveSMSNotification: string
Indicates whether the user wants to receive order notification SMS text messages. Valid values are true or false (default).
- billingCode: string
The registrant's organization's code to identify the shipping or billing addresses and cost center.
- secretary: string
The name of the registrant's secretary.
- billingCodeType: string
Code designating the method of code structure used for the billing code. Default is D, assigned by buyer.
- receiveSMS: string
Specifies whether the registrant wants to receive marketing SMS messages for the current store (or all stores if no stores have been visited during the session). Valid values are true or false (default).
- publishPhone1: string
1 - An indicator that the registrant's primary phone number is listed; 0 - An indicator that the registrant's primary phone number is unlisted. There is no default for these publishPhone fields. If the field is left unused, it remains null in the database.
- employeeId: string
The registrant's ID with his or her employer.
- preferredLanguage: string
The registrant's preferred language.
- challengeQuestion: string
Challenge question for verbal confirmation of the customer's identity.
- dateOfBirth: string
Date of birth. The format is yyyy-mm-dd, for example: 1980-01-01.
- state: string
The name of the state, province, or equivalent where the registrant resides.
- phone1Type: string
The type of phone used for the registrant's primary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
- phone2Type: string
The type of phone used for the registrant's secondary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
- companyName: string
The company name of the organization that the registrant represents, obtained when filling in demographic information.
- phone2: string
The registrant's secondary phone number.
- phone1: string
The registrant's primary phone number.
- taxGeoCode: string
A tax code based on geographical region, especially useful with tax software.
- organizationUnitName: string
The name of the unit within the organization that the registrant represents.
- lastName: string
Required if the authentication mode is LDAP: The last name of the registrant. If the authentication mode is LDAP, this parameter is mandatory.
- timeZone: string
The time zone in which the registrant does business (report as GMT +/- hours).
- mobilePhone1Country: string
The country code used for the registrant's mobile phone number, for example, CA for Canada.
- incomeCurrency: string
The currency in which the registrant's income is paid.
- shippingGeoCode: string
A shipping code based on geographical region, especially useful with tax software.
- preferredCommunication: string[]
The preferred phone for the registrant (stored in the ADDRESS table), for example: P1=phone 1 P2=phone 2.
string - city: string
The name of the city where the registrant resides.
- addressField1: string
Customizable field.
- addressField3: string
Customizable field.
- addressField2: string
Customizable field.
- fax2: string
The registrant's secondary facsimile number.
- fax1: string
The registrant's primary facsimile number.
- departmentNumber: string
The department identifier for the registrant.
- logonId: string
The registrant's logon ID. If we are using LDAP, changing a user's logonID is not supported because it would require deleting and recreating the user in LDAP. This process would cause all non-WebSphere Commerce user attributes, such as the password, to be lost. If we are not using LDAP, changing the user's logon ID is not recommended, because the promotion subsystem stores the logon ID of the creator of the promotion in the XMLPARAM column of the PX_PROMOTION table.
Note: When the UserRegistrationUpdate command is used to change the logonID, the command will automatically update the USERS.DN database column. Do not assume that ADDRESS.NICKNAME will also change. Instead, the following finder should be used to get the single self address of a user: AddressAccessBean.findSelfAddressByMember(Long memberID).
- taxPayerId: string
A string used to identify the user for taxation, especially useful with tax software.
- parentMemberId: string
The parent member identifier of the user.
- demographicField6: string
Customizable field for demographic information; an integer field.
- demographicField7: string
Customizable field for demographic information; a field var char, length 6.
- demographicField4: string
Customizable field for demographic information; this is single-character field.
- demographicField5: string
Customizable field for demographic information; a field of 254 characters.
- userField3: string
Customizable field.
- userField2: string
Customizable field.
- userField1: string
Customizable field.
- demographicField1: string
Customizable field for demographic information; this is single-character field.
- receiveEmail: string
Determines whether the registrant wants to receive marketing e-mail activities for the current store (or all stores if no stores have been visited during the session): true - The user wants to receive marketing e-mail activities; false - The user does not want to receive e-mail activities (the default).
- preferredDelivery: string
The registrant's preferred mode of delivery.
- country: string
The name of the country or region where the registrant resides.
- orderBefore: string
Whether the registrant has previously placed an order. This value is supplied by the registrant.
- addressType: string
The purpose of the address. Valid values are: S - shipto, B - billto, SB - shipto and billto (The default value.).
- personTitle: string
The title of the user whose address is being entered (for example, Dr., Rev., Mr. or Ms.).
- household: string
The number of people in the registrant's household; the default is 1.
- customMemberAttributes: string[]
We can manage custom member attributes (MBRATTRVAL table) for this user using the following syntax: &attributeName_storeId_action_number=value.
string - hobbies: string
The registrant's hobbies.
- alternateId: string
A special ID assigned by the registrant's business organization or organizational unit to this particular registrant..
- employeeType: string
The registrant's status as an employee (for example, regular, permanent, contractor, or part time).
- challengeAnswer: string
Answer to the challenge question.
- userProfileField1: string
Customizable field.
- userProfileField2: string
Customizable field.
- income: string
The registrant's annual income.
- description: string
A description of the registrant.
- publishPhone2: string
1 - An indicator that the registrant's secondary phone number is listed; 0 - An indicator that the registrant's secondary phone number is unlisted.
- organizationUnitId: string
The identifier of the registrant's organizational unit.
- packageSuppression: string
1 - An indicator to include package inserts when the order is shipped; 0 - An indicator to not include package inserts when the order is shipped. There is no default for this field. If the field is left unused, it remains null in the database.
- bestCallingTime: string
D - An indicator that daytime is the best time to call the registrant; E - An indicator that evening is the best time to call the registrant.
- preferredCurrency: string
The registrant's preferred currency for transactions.
- organizationId: string
The identifier of the registrant's company.
- age: string
The registrant's age.
- demographicField2: string
Customizable field for demographic information; this is single-character field.
- demographicField3: string
Customizable field for demographic information; this is single-character field.
com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminAddResponse: object
Response of UserRegistrationAdminAddCmd.
- userId: string
The user unique identifier.
- logonId: string
The logon ID of the user.
- addressId: string
The address identifier of the user.
com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminUpdateRequest: object
Request of UserRegistrationAdminUpdateCmd.
- maritalStatus: string
The registrant's marital status.
- photo: string
URL or path to a photo of the registrant.
- userId: string
The user the administrator will update.
- manager: string
The name of the registrant's manager.
- email2: string
The registrant's secondary e-mail or Web address.
- children: string
The number of children the registrant has.
- email1: string
The registrant's primary e-mail or Web address.
- middleName: string
The middle name of the registrant.
- logonPassword: string
The registrant's password. In database mode, the password is encrypted before it is saved in the database. In LDAP mode, the password is only stored on the LDAP server.
- officeAddress: string
The internal address (for example, mail stop).
- preferredMeasure: string
The registrant's preferred unit of measure.
- URL: string
The URL to call when the command completes successfully.
- address1: string
The registrant's street address, to a maximum of three lines of information.
- address2: string
The registrant's street address, to a maximum of three lines of information.
- address3: string
The registrant's street address, to a maximum of three lines of information.
- zipCode: string
The ZIP or postal code of the registrant's address.
- logonPasswordVerify: string
Required if the logonPassword is used: The registrant's password, entered a second time.
- mobilePhone1: string
The registrant's mobile phone number used for SMS, for example, 4161235555.
- organizationName: string
The name of the organization that the registrant represents.
- firstName: string
The first name of the registrant.
- gender: string
The registrant's gender.
- receiveSMSNotification: string
Indicates whether the user wants to receive order notification SMS text messages. Valid values are true or false (default).
- billingCode: string
The registrant's organization's code to identify the shipping or billing addresses and cost center.
- secretary: string
The name of the registrant's secretary.
- billingCodeType: string
Code designating the method of code structure used for the billing code. Default is D, assigned by buyer.
- receiveSMS: string
Specifies whether the registrant wants to receive marketing SMS messages for the current store (or all stores if no stores have been visited during the session). Valid values are true or false (default).
- publishPhone1: string
1 - An indicator that the registrant's primary phone number is listed; 0 - An indicator that the registrant's primary phone number is unlisted. There is no default for these publishPhone fields. If the field is left unused, it remains null in the database.
- employeeId: string
The registrant's ID with his or her employer.
- preferredLanguage: string
The registrant's preferred language.
- challengeQuestion: string
Challenge question for verbal confirmation of the customer's identity.
- dateOfBirth: string
Date of birth. The format is yyyy-mm-dd, for example: 1980-01-01.
- state: string
The name of the state, province, or equivalent where the registrant resides.
- phone1Type: string
The type of phone used for the registrant's primary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
- phone2Type: string
The type of phone used for the registrant's secondary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
- companyName: string
The company name of the organization that the registrant represents, obtained when filling in demographic information.
- phone2: string
The registrant's secondary phone number.
- phone1: string
The registrant's primary phone number.
- taxGeoCode: string
A tax code based on geographical region, especially useful with tax software.
- organizationUnitName: string
The name of the unit within the organization that the registrant represents.
- lastName: string
Required if the authentication mode is LDAP: The last name of the registrant. If the authentication mode is LDAP, this parameter is mandatory.
- timeZone: string
The time zone in which the registrant does business (report as GMT +/- hours).
- mobilePhone1Country: string
The country code used for the registrant's mobile phone number, for example, CA for Canada.
- incomeCurrency: string
The currency in which the registrant's income is paid.
- shippingGeoCode: string
A shipping code based on geographical region, especially useful with tax software.
- preferredCommunication: string[]
The preferred phone for the registrant (stored in the ADDRESS table), for example: P1=phone 1 P2=phone 2.
string - city: string
The name of the city where the registrant resides.
- addressField1: string
Customizable field.
- addressField3: string
Customizable field.
- addressField2: string
Customizable field.
- fax2: string
The registrant's secondary facsimile number.
- fax1: string
The registrant's primary facsimile number.
- departmentNumber: string
The department identifier for the registrant.
- logonId: string
The registrant's logon ID. If we are using LDAP, changing a user's logonID is not supported because it would require deleting and recreating the user in LDAP. This process would cause all non-WebSphere Commerce user attributes, such as the password, to be lost. If we are not using LDAP, changing the user's logon ID is not recommended, because the promotion subsystem stores the logon ID of the creator of the promotion in the XMLPARAM column of the PX_PROMOTION table.
Note: When the UserRegistrationUpdate command is used to change the logonID, the command will automatically update the USERS.DN database column. Do not assume that ADDRESS.NICKNAME will also change. Instead, the following finder should be used to get the single self address of a user: AddressAccessBean.findSelfAddressByMember(Long memberID).
- taxPayerId: string
A string used to identify the user for taxation, especially useful with tax software.
- demographicField6: string
Customizable field for demographic information; an integer field.
- demographicField7: string
Customizable field for demographic information; a field var char, length 6.
- demographicField4: string
Customizable field for demographic information; this is single-character field.
- demographicField5: string
Customizable field for demographic information; a field of 254 characters.
- userField3: string
Customizable field.
- userField2: string
Customizable field.
- userField1: string
Customizable field.
- demographicField1: string
Customizable field for demographic information; this is single-character field.
- receiveEmail: string
Determines whether the registrant wants to receive marketing e-mail activities for the current store (or all stores if no stores have been visited during the session): true - The user wants to receive marketing e-mail activities; false - The user does not want to receive e-mail activities (the default).
- preferredDelivery: string
The registrant's preferred mode of delivery.
- country: string
The name of the country or region where the registrant resides.
- orderBefore: string
Whether the registrant has previously placed an order. This value is supplied by the registrant.
- addressType: string
The purpose of the address. Valid values are: S - shipto, B - billto, SB - shipto and billto (The default value.).
- personTitle: string
The title of the user whose address is being entered (for example, Dr., Rev., Mr. or Ms.).
- household: string
The number of people in the registrant's household; the default is 1.
- customMemberAttributes: string[]
We can manage custom member attributes (MBRATTRVAL table) for this user using the following syntax: &attributeName_storeId_action_number=value.
string - hobbies: string
The registrant's hobbies.
- alternateId: string
A special ID assigned by the registrant's business organization or organizational unit to this particular registrant..
- employeeType: string
The registrant's status as an employee (for example, regular, permanent, contractor, or part time).
- challengeAnswer: string
Answer to the challenge question.
- userProfileField1: string
Customizable field.
- userProfileField2: string
Customizable field.
- income: string
The registrant's annual income.
- description: string
A description of the registrant.
- publishPhone2: string
1 - An indicator that the registrant's secondary phone number is listed; 0 - An indicator that the registrant's secondary phone number is unlisted.
- organizationUnitId: string
The identifier of the registrant's organizational unit.
- packageSuppression: string
1 - An indicator to include package inserts when the order is shipped; 0 - An indicator to not include package inserts when the order is shipped. There is no default for this field. If the field is left unused, it remains null in the database.
- bestCallingTime: string
D - An indicator that daytime is the best time to call the registrant; E - An indicator that evening is the best time to call the registrant.
- preferredCurrency: string
The registrant's preferred currency for transactions.
- organizationId: string
The identifier of the registrant's company.
- age: string
The registrant's age.
- demographicField2: string
Customizable field for demographic information; this is single-character field.
- demographicField3: string
Customizable field for demographic information; this is single-character field.
com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationUpdateRequest: object
Request of UserRegistrationUpdateCmd.
- maritalStatus: string
The registrant's marital status.
- photo: string
URL or path to a photo of the registrant.
- manager: string
The name of the registrant's manager.
- email2: string
The registrant's secondary e-mail or Web address.
- children: string
The number of children the registrant has.
- email1: string
The registrant's primary e-mail or Web address.
- middleName: string
The middle name of the registrant.
- logonPassword: string
The registrant's password. In database mode, the password is encrypted before it is saved in the database. In LDAP mode, the password is only stored on the LDAP server.
- officeAddress: string
The internal address (for example, mail stop).
- preferredMeasure: string
The registrant's preferred unit of measure.
- URL: string
The URL to call when the command completes successfully.
- address1: string
The registrant's street address, to a maximum of three lines of information.
- address2: string
The registrant's street address, to a maximum of three lines of information.
- address3: string
The registrant's street address, to a maximum of three lines of information.
- zipCode: string
The ZIP or postal code of the registrant's address.
- logonPasswordVerify: string
Required if the logonPassword is used: The registrant's password, entered a second time.
- mobilePhone1: string
The registrant's mobile phone number used for SMS, for example, 4161235555.
- organizationName: string
The name of the organization that the registrant represents.
- firstName: string
The first name of the registrant.
- gender: string
The registrant's gender.
- receiveSMSNotification: string
Indicates whether the user wants to receive order notification SMS text messages. Valid values are true or false (default).
- billingCode: string
The registrant's organization's code to identify the shipping or billing addresses and cost center.
- secretary: string
The name of the registrant's secretary.
- billingCodeType: string
Code designating the method of code structure used for the billing code. Default is D, assigned by buyer.
- receiveSMS: string
Specifies whether the registrant wants to receive marketing SMS messages for the current store (or all stores if no stores have been visited during the session). Valid values are true or false (default).
- publishPhone1: string
1 - An indicator that the registrant's primary phone number is listed; 0 - An indicator that the registrant's primary phone number is unlisted. There is no default for these publishPhone fields. If the field is left unused, it remains null in the database.
- employeeId: string
The registrant's ID with his or her employer.
- preferredLanguage: string
The registrant's preferred language.
- challengeQuestion: string
Challenge question for verbal confirmation of the customer's identity.
- dateOfBirth: string
Date of birth. The format is yyyy-mm-dd, for example: 1980-01-01.
- state: string
The name of the state, province, or equivalent where the registrant resides.
- phone1Type: string
The type of phone used for the registrant's primary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
- phone2Type: string
The type of phone used for the registrant's secondary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
- companyName: string
The company name of the organization that the registrant represents, obtained when filling in demographic information.
- phone2: string
The registrant's secondary phone number.
- phone1: string
The registrant's primary phone number.
- taxGeoCode: string
A tax code based on geographical region, especially useful with tax software.
- organizationUnitName: string
The name of the unit within the organization that the registrant represents.
- lastName: string
Required if the authentication mode is LDAP: The last name of the registrant. If the authentication mode is LDAP, this parameter is mandatory.
- timeZone: string
The time zone in which the registrant does business (report as GMT +/- hours).
- mobilePhone1Country: string
The country code used for the registrant's mobile phone number, for example, CA for Canada.
- incomeCurrency: string
The currency in which the registrant's income is paid.
- shippingGeoCode: string
A shipping code based on geographical region, especially useful with tax software.
- preferredCommunication: string[]
The preferred phone for the registrant (stored in the ADDRESS table), for example: P1=phone 1 P2=phone 2.
string - city: string
The name of the city where the registrant resides.
- addressField1: string
Customizable field.
- addressField3: string
Customizable field.
- addressField2: string
Customizable field.
- fax2: string
The registrant's secondary facsimile number.
- fax1: string
The registrant's primary facsimile number.
- departmentNumber: string
The department identifier for the registrant.
- logonId: string
The registrant's logon ID. If we are using LDAP, changing a user's logonID is not supported because it would require deleting and recreating the user in LDAP. This process would cause all non-WebSphere Commerce user attributes, such as the password, to be lost. If we are not using LDAP, changing the user's logon ID is not recommended, because the promotion subsystem stores the logon ID of the creator of the promotion in the XMLPARAM column of the PX_PROMOTION table.
Note: When the UserRegistrationUpdate command is used to change the logonID, the command will automatically update the USERS.DN database column. Do not assume that ADDRESS.NICKNAME will also change. Instead, the following finder should be used to get the single self address of a user: AddressAccessBean.findSelfAddressByMember(Long memberID).
- taxPayerId: string
A string used to identify the user for taxation, especially useful with tax software.
- demographicField6: string
Customizable field for demographic information; an integer field.
- demographicField7: string
Customizable field for demographic information; a field var char, length 6.
- demographicField4: string
Customizable field for demographic information; this is single-character field.
- demographicField5: string
Customizable field for demographic information; a field of 254 characters.
- userField3: string
Customizable field.
- userField2: string
Customizable field.
- userField1: string
Customizable field.
- demographicField1: string
Customizable field for demographic information; this is single-character field.
- receiveEmail: string
Determines whether the registrant wants to receive marketing e-mail activities for the current store (or all stores if no stores have been visited during the session): true - The user wants to receive marketing e-mail activities; false - The user does not want to receive e-mail activities (the default).
- preferredDelivery: string
The registrant's preferred mode of delivery.
- country: string
The name of the country or region where the registrant resides.
- orderBefore: string
Whether the registrant has previously placed an order. This value is supplied by the registrant.
- addressType: string
The purpose of the address. Valid values are: S - shipto, B - billto, SB - shipto and billto (The default value.).
- personTitle: string
The title of the user whose address is being entered (for example, Dr., Rev., Mr. or Ms.).
- household: string
The number of people in the registrant's household; the default is 1.
- customMemberAttributes: string[]
We can manage custom member attributes (MBRATTRVAL table) for this user using the following syntax: &attributeName_storeId_action_number=value.
string - hobbies: string
The registrant's hobbies.
- alternateId: string
A special ID assigned by the registrant's business organization or organizational unit to this particular registrant..
- employeeType: string
The registrant's status as an employee (for example, regular, permanent, contractor, or part time).
- challengeAnswer: string
Answer to the challenge question.
- userProfileField1: string
Customizable field.
- userProfileField2: string
Customizable field.
- income: string
The registrant's annual income.
- description: string
A description of the registrant.
- publishPhone2: string
1 - An indicator that the registrant's secondary phone number is listed; 0 - An indicator that the registrant's secondary phone number is unlisted.
- organizationUnitId: string
The identifier of the registrant's organizational unit.
- packageSuppression: string
1 - An indicator to include package inserts when the order is shipped; 0 - An indicator to not include package inserts when the order is shipped. There is no default for this field. If the field is left unused, it remains null in the database.
- bestCallingTime: string
D - An indicator that daytime is the best time to call the registrant; E - An indicator that evening is the best time to call the registrant.
- preferredCurrency: string
The registrant's preferred currency for transactions.
- organizationId: string
The identifier of the registrant's company.
- age: string
The registrant's age.
- demographicField2: string
Customizable field for demographic information; this is single-character field.
- demographicField3: string
Customizable field for demographic information; this is single-character field.
com.ibm.commerce.security.commands.ResetPasswordAdministratorCmd: object
com.ibm.commerce.user.beans.MemberRoleAssignDataBean_IBM_Roles_Of_User_In_Orgs_I_Can_Admin: object
- orgIdRoleDataBeans: com.ibm.commerce.user.beans.MemberRoleAssignDataBean_IBM_Roles_Of_User_In_Orgs_I_Can_Admin.orgIdRoleDataBeans
com.ibm.commerce.user.beans.MemberRoleAssignDataBean_IBM_Roles_Of_User_In_Orgs_I_Can_Admin.orgIdRoleDataBeans: object
com.ibm.commerce.user.beans.OrganizationHierarchyDataBean_IBM_Store_Summary: object
- organizationHierarchy: com.ibm.commerce.user.beans.OrganizationHierarchyDataBean_IBM_Store_Summary.organizationHierarchy
com.ibm.commerce.user.beans.OrganizationHierarchyDataBean_IBM_Store_Summary.organizationHierarchy: object
com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details: object
- parentRolesWithDetails: object[]
com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details.parentRolesWithDetails - displayName: string
- memberId: string
com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details.parentRolesWithDetails: object
- roleId: string
- displayName: string
- description: string
- name: string
Empty: object
Empty model. Used as default value when no model is specified.
java.util.Map$Entry: object
- value: string
- key: string
person-checkoutProfile: object
person-contact: object
person-person: object
person-singleContact: object
- addressType: string
- addressLine: string[]
string - addressId: string
- personTitle: string
- primary: string
- email2: string
- email1: string
- city: string
- middleName: string
- geographicalTaxCode: string
- state: string
- internalOfficeAddress: string
- fax2: string
- fax1: string
- organizationIdentifier: com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType
- phone1Type: string
- nickName: string
- phone2Type: string
- phone2: string
- businessTitle: string
- phone1: string
- zipCode: string
- bestCallingTime: string
- mobilePhone1Country: string
- phone2Publish: string
- mobilePhone1: string
- personIdentifier: com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType
- organizationUnitName: string
- organizationName: string
- language: string
- firstName: string
- lastName: string
- geographicalShippingCode: string
- phone1Publish: string
- attributes: object[]
java.util.Map$Entry - country: string
- userDataField: object[]
person-singleContact.userDataField
person-singleContact.userDataField: object
- value: string
- key: string