host: localhost
basePath: /wcs/resources
schemes:
  - https
swagger: '2.0'
info:
  version: 'WC.TOOLKIT Enterprise Version : 9 Fix Pack : 0'
  title: WebSphere Commerce V9 - User and Organization Management API
  description: >-
    These services provide classes related to user management in a B2C store.
    Use these classes to: Get person details; Add or update a member; Register a
    person as a member; Update a member; Get or update a checkout profile.
tags:
  - name: person_contact
    description: >-
      This class provides RESTful services to get contact details, register a
      person as a member, and update a member.
  - name: person
    description: >-
      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.
  - name: organization
    description: >-
      This class provides RESTful services to register an organization, to get
      or update organization information.
  - name: checkout_profile
    description: This class provides RESTful services to get and update a checkout profile.
  - name: useractivate
paths:
  '/store/{storeId}/organization':
    post:
      responses:
        '200':
          description: The requested completed successfully.
          examples:
            application/json:
              addressId: '15802'
              orgEntityId: '7000000000000004402'
              viewTaskName: RedirectView
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.OrganizationHandler_OrgEntityIdentity
        '201':
          description: The requested resource has been created.
        '400':
          description: >-
            Bad request. The request could not be understood by the server due
            to malformed syntax.
        '401':
          description: Not authenticated. The user session is not valid.
        '403':
          description: The user is not authorized to perform the specified request.
        '500':
          description: 'Internal server error. For details, see the server log files.'
      parameters:
        - required: true
          type: string
          description: The store identifier.
          name: storeId
          in: path
        - required: false
          in: body
          description: Request body.
          name: body
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.OrganizationHandler_OrgEntityAddRequest
      tags:
        - organization
      description: Allows an administrator to register an organization.
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Allows an administrator to register an organization.
      consumes:
        - application/json
        - application/xml
      operationId: registerOrganization
    get:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Details
        '400':
          description: >-
            Bad request. The request could not be understood by the server due
            to malformed syntax.
        '401':
          description: Not authenticated. The user session is not valid.
        '403':
          description: The user is not authorized to perform the specified request.
        '500':
          description: 'Internal server error. For details, see the server log files.'
      parameters:
        - required: true
          type: string
          description: The storeId.
          in: path
          name: storeId
        - enum:
            - IBM_Store_Summary
            - IBM_Organization_List_Summary
            - IBM_Organization_List_Short_Summary
            - IBM_Organization_List_Details
            - IBM_Roles_To_Assign_Details
          name: profileName
          required: false
          in: query
          type: string
          description: >-
            Profile name. Profiles determine the subset of data returned by a
            query.
        - enum:
            - organizationHierarchy
            - organizationsICanAdmin
            - rolesICanAssignInOrg
          name: q
          required: true
          in: query
          type: string
          description: >-
            The query name. <ul><li>organizationHierarchy: Retrieves the
            organization hierarchy.</li><li>organizationsICanAdmin: This allows
            an administrator to find organizations that he/she can
            administer.</li><li>rolesICanAssignInOrg: This allows an
            administrator to find roles that he/she can assign in
            organizations.</li></ul>
        - required: false
          type: string
          description: The trading account ID.
          in: query
          name: accountId
        - required: false
          type: string
          description: The organization identifier.
          in: query
          name: orgId
        - required: false
          type: string
          description: The organization name.
          in: query
          name: orgName
        - required: false
          type: string
          description: The parent organization name.
          in: query
          name: parentOrgName
        - required: false
          type: string
          description: The starting index of the result.
          in: query
          name: startIndex
        - required: false
          type: string
          description: The maximum number of results to be returned.
          in: query
          name: maxResults
      tags:
        - organization
      description: >-
        This allows an administrator to find organizations based on query name.
        See each query for details on input and output.
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        This allows an administrator to find organizations based on query name.
        See each query for details on input and output.
      operationId: findByQuery
  '/store/{storeId}/organization/{organizationId}':
    put:
      responses:
        '200':
          description: The requested completed successfully.
          examples:
            application/json:
              addressId: '12338'
              orgEntityId: '7000000000000000919'
              viewTaskName: RedirectView
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.OrganizationHandler_OrgEntityIdentity
        '400':
          description: >-
            Bad request. The request could not be understood by the server due
            to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
        '401':
          description: Not authenticated. The user session is not valid.
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
        '403':
          description: The user is not authorized to perform the specified request.
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
        '500':
          description: 'Internal server error. For details, see the server log files.'
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
      parameters:
        - required: true
          type: string
          description: The store identifier.
          name: storeId
          in: path
        - required: true
          type: string
          description: The organization identifier.
          in: path
          name: organizationId
        - required: false
          in: body
          description: Request body.
          name: body
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.OrganizationHandler_OrgEntityUpdateRequest
      tags:
        - organization
      description: This allows an administrator to update information of an organization.
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: This allows an administrator to update information of an organization.
      consumes:
        - application/json
        - application/xml
      operationId: updateOrganization
    post:
      responses:
        '200':
          description: The requested completed successfully.
          examples:
            application/json:
              viewTaskName: RedirectView
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.OrganizationHandler_UpdateApprovalGroupsResponse
        '400':
          description: >-
            Bad request. The request could not be understood by the server due
            to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
        '401':
          description: Not authenticated. The user session is not valid.
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
        '403':
          description: The user is not authorized to perform the specified request.
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
        '500':
          description: 'Internal server error. For details, see the server log files.'
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
      parameters:
        - required: true
          type: string
          description: The store identifier.
          name: storeId
          in: path
        - required: true
          type: string
          description: The organization identifier.
          in: path
          name: organizationId
        - required: false
          in: body
          description: Request body.
          name: body
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.OrganizationHandler_UpdateApprovalGroups
        - enum:
            - updateApprovalGroups
            - assignRole
            - unassignRole
          name: action
          required: true
          in: query
          type: string
          description: The action of the rest service.
      tags:
        - organization
      description: >-
        Performs an action on an organization. See each action for details on
        input and output. Actions include: updating an approval group, and
        assigning or unassigning one or more roles from an organization
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Performs an action on an organization.
      operationId: updateApprovalGroups
    get:
      responses:
        '200':
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details
          description: The requested completed successfully.
          examples:
            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
        '400':
          description: >-
            Bad request. The request could not be understood by the server due
            to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
        '401':
          description: Not authenticated. The user session is not valid.
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
        '403':
          description: The user is not authorized to perform the specified request.
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
        '500':
          description: 'Internal server error. For details, see the server log files.'
          schema:
            $ref: '#/definitions/ErrorMessageResponseContainer'
      parameters:
        - required: true
          type: string
          description: The store identifier.
          name: storeId
          in: path
        - required: true
          type: string
          description: The organization identifier.
          in: path
          name: organizationId
        - enum:
            - IBM_Organization_Short_Summary
            - IBM_Organization_Summary
            - IBM_Organization_Details
            - IBM_Org_Entity_Details
            - IBM_Assigned_Roles_Details
            - IBM_Parent_Assigned_Roles_Details
          name: profileName
          required: false
          in: query
          type: string
          description: >-
            Profile name. Profiles determine the subset of data returned by a
            query. Default profile name = IBM_Organization_Summary.
      tags:
        - organization
      description: >-
        Allows administrators to find organization information by organization
        identifier.
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        Allows administrators to find organization information by organization
        identifier.
      operationId: findByOrganizationIdWParentAssignedRolesDetailsProfileName
  '/store/{storeId}/organization/@self/entitled_orgs':
    get:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.member.beans.OrganizationListDataBean_IBM_Organization_Summary
        '400':
          description: >-
            Bad request. The request could not be understood by the server due
            to malformed syntax.
        '401':
          description: Not authenticated. The user session is not valid.
        '403':
          description: The user is not authorized to perform the specified request.
        '500':
          description: 'Internal server error. For details, see the server log files.'
      parameters:
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            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.
        - required: true
          type: string
          name: storeId
          description: The store identifier.
          in: path
        - required: false
          type: string
          name: accountCheck
          in: query
        - required: false
          type: string
          name: explicitEntitlement
          in: query
      tags:
        - organization
      description: Get user's entitled organizations.
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Get user's entitled organizations.
      operationId: getEntitledOrganizations
  '/store/{storeId}/organization/buyer':
    post:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.OrganizationHandler.OrgEntityBuyerIdentifier
        '201':
          description: The requested resource has been created.
        '400':
          description: >-
            Bad request. The request could not be understood by the server due
            to malformed syntax.
        '401':
          description: Not authenticated. The user session is not valid.
        '403':
          description: The user is not authorized to perform the specified request.
        '500':
          description: 'Internal server error. For details, see the server log files.'
      parameters:
        - required: true
          type: string
          description: The store identifier.
          name: storeId
          in: path
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            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.
        - required: true
          in: body
          description: Request body.
          name: body
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.OrganizationHandler.BuyerRegistrationAddRequest
      tags:
        - organization
      description: >-
        Registers a new Buyer Organization as well as the initial Buyer
        Administrator for the new organization.
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        Register a new Buyer Organization as well as the initial Buyer
        Administrator for the new organization.
      consumes:
        - application/json
        - application/xml
      operationId: registerBuyerOrganization
  '/store/{storeId}/person/@self/contact/byAddressId/{addressId}':
    get:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: '#/definitions/person-singleContact'
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '404':
          description: The specified resource couldn't be found.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - required: true
          type: string
          description: The address identifier.
          in: path
          name: addressId
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
      tags:
        - person_contact
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Gets a person contact by address ID.
      operationId: findPersonContactById
  '/store/{storeId}/person/updateMemberUser/{userId}':
    post:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonHandler$UpdateMemberUserResponse
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - required: true
          type: string
          description: The user identifier.
          in: path
          name: userId
        - required: false
          in: body
          description: Request body.
          name: body
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonHandler$UpdateMemberUser
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        Updates user to be included/excluded from a member group or to be
        unassgined.
      operationId: updateMemberUser
  '/store/{storeId}/person/{userId}':
    put:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonHandler$UserIdentifier
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - required: true
          type: string
          description: The user identifier.
          in: path
          name: userId
        - required: false
          in: body
          description: Request body.
          name: body
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminUpdateRequest
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        This allows an administrator to update account data for a registered
        user.
      consumes:
        - application/json
        - application/xml
      operationId: updatePersonByAdmin
    post:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: '#/definitions/Empty'
        '201':
          description: The requested resource has been created.
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - required: true
          type: string
          description: The user identifier.
          in: path
          name: userId
        - enum:
            - assignRole
            - unassignRole
          name: action
          required: true
          in: query
          type: string
          description: The action of the rest service.
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        Performs an action on a person by an administrator. See each action for
        details on input and output.
      consumes:
        - application/json
        - application/xml
      operationId: performActionByAdmin
    get:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.user.beans.MemberRoleAssignDataBean_IBM_Roles_Of_User_In_Orgs_I_Can_Admin
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - required: true
          type: string
          description: The user identifier.
          in: path
          name: userId
        - enum:
            - 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
          name: profileName
          required: false
          in: query
          type: string
          description: >-
            Profile name. Profiles determine the subset of data to be returned
            by a query.  Default profile name = IBM_User_Display_Details
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        This allows an administrator to find user information by user
        identifier.
      operationId: findByUserIdWRolesOfUserInOrgsICanAdminProfileName
    delete:
      responses:
        '200':
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonHandler.UserIdentifier
          description: The requested completed successfully.
          examples:
            application/json:
              userId: '4053'
        '400':
          description: >-
            Bad request. The request could not be understood by the server due
            to malformed syntax.
        '401':
          description: Not authenticated. The user session is not valid.
        '403':
          description: The user is not authorized to perform the specified request.
        '500':
          description: 'Internal server error. For details, see the server log files.'
      parameters:
        - required: true
          type: string
          description: The store identifier.
          name: storeId
          in: path
        - required: true
          type: string
          description: The user identifier.
          in: path
          name: userId
      tags:
        - person
      description: Allows administrators to delete user
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Delete user (by administrator)
      consumes:
        - application/json
        - application/xml
      operationId: deletePersonByAdmin
  '/store/{storeId}/person/updateMemberPassword':
    post:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.security.commands.ResetPasswordAdministratorCmd
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - required: false
          in: body
          description: Request body.
          name: body
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonHandler$ResetPasswordAdministratorRequest
        - enum:
            - resetPasswordAdmin
            - resetPasswordOnBehalf
          name: mode
          required: false
          in: query
          type: string
          description: >-
            The mode in which resetPassword will be executed. ResetPassword can
            be executed in administrator session or in on-behalf session for a
            user Default value is 'resetPasswordAdmin'.
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        This allows CSR / CSS to reset 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.
      consumes:
        - application/json
        - application/xml
      operationId: resetPasswordByAdmin
  '/store/{storeId}/person/@self/checkoutProfile':
    put:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonCheckoutProfileHandler$UserIdContainer
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '404':
          description: The specified resource couldn't be found.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
        - required: false
          in: body
          description: Update checkout profile body.
          name: body
          schema:
            $ref: '#/definitions/person-checkoutProfile'
      tags:
        - checkout_profile
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        Updates the CheckOutProfile for the logged in user using the Member
        service. The shopper must log in before invoking this method.
      operationId: updateCheckoutProfile
    get:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: '#/definitions/person-checkoutProfile'
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '404':
          description: The specified resource couldn't be found.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
      tags:
        - checkout_profile
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        Gets the Check Out Profile for the logged in user using the Member
        service. The shopper must log in before invoking this method.
      operationId: getCheckoutProfile
  '/store/{storeId}/person/@self/contact':
    post:
      responses:
        '200':
          description: No response was specified
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonContactHandler$UserIdentifier
        '201':
          description: The requested resource has been created.
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
        - required: false
          in: body
          description: Request body.
          name: body
          schema:
            $ref: '#/definitions/person-contact'
      tags:
        - person_contact
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Creates a new contact in a person's address book.
      consumes:
        - application/json
        - application/xml
      operationId: addPersonContact
    get:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: '#/definitions/person-contact'
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - required: false
          type: string
          description: The address type.
          in: query
          name: addressType
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
      tags:
        - person_contact
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        Gets the contacts in a person's address book. If the addressType
        optional query parameter is passed in, the returned contacts are
        filtered by addressType.
      operationId: getAllPersonContact
  '/store/{storeId}/person/@self':
    put:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonHandler$UserIdentifier
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
        - required: false
          in: body
          description: Request body.
          name: body
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationUpdateRequest
        - enum:
            - updateUserRegistration
          name: action
          required: false
          in: query
          type: string
          description: The action of the rest service.
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        Updates 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
      consumes:
        - application/json
        - application/xml
      operationId: updatePersonOnUserRegistrationUpdate
    get:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: '#/definitions/person-person'
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Gets the account data for a registered user.
      operationId: findPersonBySelf
  '/store/{storeId}/person/@self/languageCurrency':
    put:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.price.commands.SetCurrencyPreferenceCmd
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Change language and currency preference in profile and in context
      operationId: changeLanguageCurrency
  '/store/{storeId}/person/@self/contact/{nickName}':
    put:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonContactHandler$AddressIdentifier
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '404':
          description: The specified resource couldn't be found.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - required: true
          type: string
          description: The contact name saved in addressBook by registered shopper.
          in: path
          name: nickName
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
        - required: false
          in: body
          description: Request body.
          name: body
          schema:
            $ref: '#/definitions/person-contact'
      tags:
        - person_contact
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Updates the contact in the address book identified by nickName.
      consumes:
        - application/json
        - application/xml
      operationId: updatePersonContact
    get:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: '#/definitions/person-singleContact'
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '404':
          description: The specified resource couldn't be found.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - required: true
          type: string
          description: The contact name saved in addressBook by registered shopper.
          in: path
          name: nickName
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
      tags:
        - person_contact
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Gets a person contact by nick name.
      operationId: findPersonContactByNickName
    delete:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: '#/definitions/Empty'
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '404':
          description: The specified resource couldn't be found.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - required: true
          type: string
          description: The contact name saved in addressBook by registered shopper.
          in: path
          name: nickName
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
      tags:
        - person_contact
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Deletes the contact in the address book identified by nickName.
      operationId: deletePersonContact
  '/store/{storeId}/useractivate/emailactivate':
    put:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.member.facade.server.commands.UserRegistrationEmailActivateCmd
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '404':
          description: The specified resource couldn't be found.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
      tags:
        - useractivate
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Activate the user account.
      operationId: activeUser
  '/store/{storeId}/person':
    post:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminAddResponse
        '201':
          description: The requested resource has been created.
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
        - required: false
          in: body
          description: Request body.
          name: body
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminAddRequest
        - enum:
            - self
            - admin
          name: mode
          required: false
          in: query
          type: string
          description: The mode of the rest service.
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        Registers a new user.  When mode is set to admin, the register is done
        by an administrator.
      consumes:
        - application/json
        - application/xml
      operationId: registerPersonOnUserRegistrationAdminAdd
    get:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: '#/definitions/Empty'
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - usersICanAdmin
          name: q
          required: true
          in: query
          type: string
          description: The query name.
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        This allows an administrator to find users based on a query name. See
        each query for details on input and output.
      operationId: findByQuery
  '/store/{storeId}/useractivate/resendemail':
    post:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.member.facade.server.commands.UserRegistrationEmailActivateResendCmd
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '404':
          description: The specified resource couldn't be found.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
      tags:
        - useractivate
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Resend user account activation email.
      operationId: resendActiveUser
  '/store/{storeId}/person/@self/optOut':
    get:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.emarketing.beans.EmailUserReceiveDataBean_IBM_optOut_all
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - IBM_optOut_email
            - IBM_optOut_sms
            - IBM_optOut_all
          name: profileName
          required: false
          in: query
          type: string
          description: >-
            Profile name. Profiles determine the subset of data to be returned
            by a query.  Default profile name = IBM_optOut_email
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: >-
        Find personal opt-out.  When the store level personal opt-out does not
        exist, the site level personal opt-out is returned.
      operationId: findOptOutBySelfWOptOutAllProfileName
  '/store/{storeId}/person/@self/contextattributes/{attributeName}/{values}':
    delete:
      responses:
        '200':
          description: The requested completed successfully.
          schema:
            $ref: >-
              #/definitions/com.ibm.commerce.rest.member.handler.PersonHandler$DeleteContextAttribute
        '400':
          description: >-
            Bad request. Some of the inputs provided to the request aren't
            valid.
        '401':
          description: Not authenticated. The user session isn't valid.
        '403':
          description: The user isn't authorized to perform the specified request.
        '500':
          description: >-
            Internal server error. Additional details will be contained on the
            server logs.
      parameters:
        - required: true
          type: string
          description: Value of the context attribute you want to delete.
          in: path
          name: attributeName
        - required: true
          type: string
          description: Value of the person's job function.
          in: path
          name: values
        - enum:
            - '0'
            - '10001'
            - '10501'
            - '11001'
            - '1'
            - '11501'
            - '2'
          name: storeId
          required: true
          in: path
          type: string
          description: The store identifier.
        - enum:
            - xml
            - json
          name: responseFormat
          required: false
          in: query
          type: string
          description: >-
            The response format. If the request has an input body, that body
            must also use the format specified in "responseFormat". Valid values
            include "json" and "xml" without the quotes. If the responseFormat
            isn't specified, the "accept" HTTP header shall be used to determine
            the format of the response. If the "accept" HTTP header isn't
            specified as well, the default response format shall be in json.
      tags:
        - person
      produces:
        - application/json
        - application/xml
        - application/xhtml+xml
        - application/atom+xml
      summary: Deletes one or more values of a context attribute for a registered user.
      operationId: deleteContextAttributeForPerson
definitions:
  person-person.contact.userDataField:
    required:
      - key
    properties:
      value:
        type: string
      key:
        type: string
  com.ibm.commerce.rest.member.handler.PersonContactHandler$AddressIdentifier:
    required:
      - addressId
    description: Address identitifier.
    properties:
      addressId:
        type: string
        description: The address identifier.
  com.ibm.commerce.member.facade.server.commands.UserRegistrationEmailActivateResendCmd: {}
  com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminAddResponse:
    required:
      - addressId
      - logonId
      - userId
    description: Response of UserRegistrationAdminAddCmd.
    properties:
      userId:
        type: string
        description: The user unique identifier.
      logonId:
        type: string
        description: The logon ID of the user.
      addressId:
        type: string
        description: The address identifier of the user.
  person-contact.contact:
    required:
      - email1
      - email2
      - fax1
      - fax2
      - mobilePhone1
      - mobilePhone1Country
      - nickName
      - phone1
      - phone2
    properties:
      addressType:
        type: string
      addressLine:
        items:
          type: string
        type: array
      addressId:
        type: string
      personTitle:
        type: string
      primary:
        type: string
      email2:
        type: string
      email1:
        type: string
      city:
        type: string
      middleName:
        type: string
      geographicalTaxCode:
        type: string
      state:
        type: string
      internalOfficeAddress:
        type: string
      fax2:
        type: string
      fax1:
        type: string
      organizationIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType
      phone1Type:
        type: string
      nickName:
        type: string
      phone2Type:
        type: string
      phone2:
        type: string
      businessTitle:
        type: string
      phone1:
        type: string
      zipCode:
        type: string
      bestCallingTime:
        type: string
      phone1Publish:
        type: string
      mobilePhone1Country:
        type: string
      phone2Publish:
        type: string
      mobilePhone1:
        type: string
      personIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType
      organizationUnitName:
        type: string
      organizationName:
        type: string
      language:
        type: string
      firstName:
        type: string
      lastName:
        type: string
      geographicalShippingCode:
        type: string
      country:
        type: string
      attributes:
        items:
          $ref: '#/definitions/java.util.Map$Entry'
        type: array
      userDataField:
        items:
          $ref: '#/definitions/person-contact.contact.userDataField'
        type: array
  person-person.userDataField:
    required:
      - key
    properties:
      value:
        type: string
      key:
        type: string
  com.ibm.commerce.foundation.common.datatypes.PaymentMethodType:
    properties:
      paymentMethodName:
        type: string
      description:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.description
      userData:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.userData
  com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType:
    properties:
      distinguishedName:
        type: string
      uniqueID:
        type: string
      externalIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier
  com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationUpdateRequest:
    description: Request of UserRegistrationUpdateCmd.
    properties:
      maritalStatus:
        type: string
        description: The registrant's marital statu.
      photo:
        type: string
        description: URL or path to a photo of the registrant.
      manager:
        type: string
        description: The name of the registrant's manager.
      email2:
        type: string
        description: The registrant's secondary e-mail or Web address.
      children:
        type: string
        description: The number of children the registrant has.
      email1:
        type: string
        description: The registrant's primary e-mail or Web address.
      middleName:
        type: string
        description: The middle name of the registrant.
      logonPassword:
        type: string
        description: >-
          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:
        type: string
        description: 'The internal address (for example, mail stop).'
      preferredMeasure:
        type: string
        description: The registrant's preferred unit of measure.
      URL:
        type: string
        description: The URL to be called when the command completes successfully.
      address1:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      address2:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      address3:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      zipCode:
        type: string
        description: The ZIP or postal code of the registrant's address.
      logonPasswordVerify:
        type: string
        description: >-
          Required if the logonPassword is used: The registrant's password,
          entered a second time.
      mobilePhone1:
        type: string
        description: >-
          The registrant's mobile phone number used for SMS, for example,
          4161235555.
      organizationName:
        type: string
        description: The name of the organization that the registrant represents.
      firstName:
        type: string
        description: The first name of the registrant.
      gender:
        type: string
        description: The registrant's gender.
      receiveSMSNotification:
        type: string
        description: >-
          Indicates whether the user wants to receive order notification SMS
          text messages. Valid values are true or false (default).
      billingCode:
        type: string
        description: >-
          The registrant's organization's code to identify the shipping or
          billing addresses and cost center.
      secretary:
        type: string
        description: The name of the registrant's secretary.
      billingCodeType:
        type: string
        description: >-
          Code designating the method of code structure used for the billing
          code. The default value is D, assigned by buyer.
      receiveSMS:
        type: string
        description: >-
          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:
        type: string
        description: >-
          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:
        type: string
        description: The registrant's ID with his or her employer.
      preferredLanguage:
        type: string
        description: The registrant's preferred language.
      challengeQuestion:
        type: string
        description: Challenge question for verbal confirmation of the customer's identity.
      dateOfBirth:
        type: string
        description: 'Date of birth. The format is yyyy-mm-dd, for example: 1980-01-01.'
      state:
        type: string
        description: >-
          The name of the state, province, or equivalent where the registrant
          resides.
      phone1Type:
        type: string
        description: >-
          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:
        type: string
        description: >-
          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:
        type: string
        description: >-
          The company name of the organization that the registrant represents,
          obtained when filling in demographic information.
      phone2:
        type: string
        description: The registrant's secondary phone number.
      phone1:
        type: string
        description: The registrant's primary phone number.
      taxGeoCode:
        type: string
        description: >-
          A tax code based on geographical region, especially useful with tax
          software.
      organizationUnitName:
        type: string
        description: >-
          The name of the unit within the organization that the registrant
          represents.
      country:
        type: string
        description: The name of the country or region where the registrant resides.
      timeZone:
        type: string
        description: >-
          The time zone in which the registrant does business (report as GMT +/-
          hours).
      mobilePhone1Country:
        type: string
        description: >-
          The country code used for the registrant's mobile phone number, for
          example, CA for Canada.
      incomeCurrency:
        type: string
        description: The currency in which the registrant's income is paid.
      shippingGeoCode:
        type: string
        description: >-
          A shipping code based on geographical region, especially useful with
          tax software.
      preferredCommunication:
        items:
          type: string
        type: array
        description: >-
          The preferred phone for the registrant (stored in the ADDRESS table),
          for example: P1=phone 1 P2=phone 2.
      city:
        type: string
        description: The name of the city where the registrant resides.
      addressField1:
        type: string
        description: Customizable field.
      addressField3:
        type: string
        description: Customizable field.
      addressField2:
        type: string
        description: Customizable field.
      fax2:
        type: string
        description: The registrant's secondary facsimile number.
      fax1:
        type: string
        description: The registrant's primary facsimile number.
      departmentNumber:
        type: string
        description: The department identifier for the registrant.
      logonId:
        type: string
        description: >-
          The registrant's logon ID. If you 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 you 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:
        type: string
        description: >-
          A string used to identify the user for taxation, especially useful
          with tax software.
      demographicField6:
        type: string
        description: Customizable field for demographic information; an integer field.
      demographicField7:
        type: string
        description: >-
          Customizable field for demographic information; a field varchar,
          length 6.
      demographicField4:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
      demographicField5:
        type: string
        description: >-
          Customizable field for demographic information; a field of 254
          characters.
      userField3:
        type: string
        description: Customizable field.
      userField2:
        type: string
        description: Customizable field.
      userField1:
        type: string
        description: Customizable field.
      demographicField1:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
      receiveEmail:
        type: string
        description: >-
          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:
        type: string
        description: The registrant's preferred mode of delivery.
      lastName:
        type: string
        description: >-
          Required if the authentication mode is LDAP: The last name of the
          registrant. If the authentication mode is LDAP, this parameter is
          mandatory.
      orderBefore:
        type: string
        description: >-
          Whether the registrant has previously placed an order. This value is
          supplied by the registrant.
      addressType:
        type: string
        description: >-
          The purpose of the address. Valid values are: S - shipto, B - billto,
          SB - shipto and billto (The default value.).
      personTitle:
        type: string
        description: >-
          The title of the user whose address is being entered (for example,
          Dr., Rev., Mr. or Ms.).
      household:
        type: string
        description: The number of people in the registrant's household; the default is 1.
      customMemberAttributes:
        items:
          type: string
        type: array
        description: >-
          You can manage custom member attributes (MBRATTRVAL table) for this
          user using the following syntax:
          &attributeName_storeId_action_number=value.
      hobbies:
        type: string
        description: The registrant's hobbies.
      alternateId:
        type: string
        description: >-
          A special ID assigned by the registrant's business organization or
          organizational unit to this particular registrant..
      employeeType:
        type: string
        description: >-
          The registrant's status as an employee (for example, regular,
          permanent, contractor, or part time).
      challengeAnswer:
        type: string
        description: Answer to the challenge question.
      userProfileField1:
        type: string
        description: Customizable field.
      userProfileField2:
        type: string
        description: Customizable field.
      income:
        type: string
        description: The registrant's annual incom.
      description:
        type: string
        description: A description of the registrant.
      publishPhone2:
        type: string
        description: >-
          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:
        type: string
        description: The identifier of the registrant's organizational unit.
      packageSuppression:
        type: string
        description: >-
          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:
        type: string
        description: >-
          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:
        type: string
        description: The registrant's preferred currency for transactions.
      organizationId:
        type: string
        description: The identifier of the registrant's company.
      age:
        type: string
        description: The registrant's age.
      demographicField2:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
      demographicField3:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
  com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminAddRequest:
    required:
      - logonId
      - logonPassword
      - logonPasswordVerify
    description: Request of UserRegistrationAdminAdd.
    properties:
      maritalStatus:
        type: string
        description: The registrant's marital statu.
      photo:
        type: string
        description: URL or path to a photo of the registrant.
      manager:
        type: string
        description: The name of the registrant's manager.
      email2:
        type: string
        description: The registrant's secondary e-mail or Web address.
      children:
        type: string
        description: The number of children the registrant has.
      email1:
        type: string
        description: The registrant's primary e-mail or Web address.
      middleName:
        type: string
        description: The middle name of the registrant.
      logonPassword:
        type: string
        description: >-
          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:
        type: string
        description: The profile type of the user.
      officeAddress:
        type: string
        description: 'The internal address (for example, mail stop).'
      preferredMeasure:
        type: string
        description: The registrant's preferred unit of measure.
      URL:
        type: string
        description: The URL to be called when the command completes successfully.
      address1:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      address2:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      address3:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      zipCode:
        type: string
        description: The ZIP or postal code of the registrant's address.
      logonPasswordVerify:
        type: string
        description: >-
          Required if the logonPassword is used: The registrant's password,
          entered a second time.
      mobilePhone1:
        type: string
        description: >-
          The registrant's mobile phone number used for SMS, for example,
          4161235555.
      organizationName:
        type: string
        description: The name of the organization that the registrant represents.
      firstName:
        type: string
        description: The first name of the registrant.
      gender:
        type: string
        description: The registrant's gender.
      receiveSMSNotification:
        type: string
        description: >-
          Indicates whether the user wants to receive order notification SMS
          text messages. Valid values are true or false (default).
      billingCode:
        type: string
        description: >-
          The registrant's organization's code to identify the shipping or
          billing addresses and cost center.
      secretary:
        type: string
        description: The name of the registrant's secretary.
      billingCodeType:
        type: string
        description: >-
          Code designating the method of code structure used for the billing
          code. The default value is D, assigned by buyer.
      receiveSMS:
        type: string
        description: >-
          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:
        type: string
        description: >-
          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:
        type: string
        description: The registrant's ID with his or her employer.
      preferredLanguage:
        type: string
        description: The registrant's preferred language.
      challengeQuestion:
        type: string
        description: Challenge question for verbal confirmation of the customer's identity.
      dateOfBirth:
        type: string
        description: 'Date of birth. The format is yyyy-mm-dd, for example: 1980-01-01.'
      state:
        type: string
        description: >-
          The name of the state, province, or equivalent where the registrant
          resides.
      phone1Type:
        type: string
        description: >-
          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:
        type: string
        description: >-
          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:
        type: string
        description: >-
          The company name of the organization that the registrant represents,
          obtained when filling in demographic information.
      phone2:
        type: string
        description: The registrant's secondary phone number.
      phone1:
        type: string
        description: The registrant's primary phone number.
      taxGeoCode:
        type: string
        description: >-
          A tax code based on geographical region, especially useful with tax
          software.
      organizationUnitName:
        type: string
        description: >-
          The name of the unit within the organization that the registrant
          represents.
      country:
        type: string
        description: The name of the country or region where the registrant resides.
      timeZone:
        type: string
        description: >-
          The time zone in which the registrant does business (report as GMT +/-
          hours).
      mobilePhone1Country:
        type: string
        description: >-
          The country code used for the registrant's mobile phone number, for
          example, CA for Canada.
      incomeCurrency:
        type: string
        description: The currency in which the registrant's income is paid.
      shippingGeoCode:
        type: string
        description: >-
          A shipping code based on geographical region, especially useful with
          tax software.
      preferredCommunication:
        items:
          type: string
        type: array
        description: >-
          The preferred phone for the registrant (stored in the ADDRESS table),
          for example: P1=phone 1 P2=phone 2.
      city:
        type: string
        description: The name of the city where the registrant resides.
      addressField1:
        type: string
        description: Customizable field.
      addressField3:
        type: string
        description: Customizable field.
      addressField2:
        type: string
        description: Customizable field.
      fax2:
        type: string
        description: The registrant's secondary facsimile number.
      fax1:
        type: string
        description: The registrant's primary facsimile number.
      departmentNumber:
        type: string
        description: The department identifier for the registrant.
      logonId:
        type: string
        description: >-
          The registrant's logon ID. If you 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 you 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:
        type: string
        description: >-
          A string used to identify the user for taxation, especially useful
          with tax software.
      parentMemberId:
        type: string
        description: The parent member identifier of the user.
      demographicField6:
        type: string
        description: Customizable field for demographic information; an integer field.
      demographicField7:
        type: string
        description: >-
          Customizable field for demographic information; a field varchar,
          length 6.
      demographicField4:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
      demographicField5:
        type: string
        description: >-
          Customizable field for demographic information; a field of 254
          characters.
      userField3:
        type: string
        description: Customizable field.
      userField2:
        type: string
        description: Customizable field.
      userField1:
        type: string
        description: Customizable field.
      demographicField1:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
      receiveEmail:
        type: string
        description: >-
          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:
        type: string
        description: The registrant's preferred mode of delivery.
      lastName:
        type: string
        description: >-
          Required if the authentication mode is LDAP: The last name of the
          registrant. If the authentication mode is LDAP, this parameter is
          mandatory.
      orderBefore:
        type: string
        description: >-
          Whether the registrant has previously placed an order. This value is
          supplied by the registrant.
      addressType:
        type: string
        description: >-
          The purpose of the address. Valid values are: S - shipto, B - billto,
          SB - shipto and billto (The default value.).
      personTitle:
        type: string
        description: >-
          The title of the user whose address is being entered (for example,
          Dr., Rev., Mr. or Ms.).
      household:
        type: string
        description: The number of people in the registrant's household; the default is 1.
      customMemberAttributes:
        items:
          type: string
        type: array
        description: >-
          You can manage custom member attributes (MBRATTRVAL table) for this
          user using the following syntax:
          &attributeName_storeId_action_number=value.
      hobbies:
        type: string
        description: The registrant's hobbies.
      alternateId:
        type: string
        description: >-
          A special ID assigned by the registrant's business organization or
          organizational unit to this particular registrant..
      employeeType:
        type: string
        description: >-
          The registrant's status as an employee (for example, regular,
          permanent, contractor, or part time).
      challengeAnswer:
        type: string
        description: Answer to the challenge question.
      userProfileField1:
        type: string
        description: Customizable field.
      userProfileField2:
        type: string
        description: Customizable field.
      income:
        type: string
        description: The registrant's annual incom.
      description:
        type: string
        description: A description of the registrant.
      publishPhone2:
        type: string
        description: >-
          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:
        type: string
        description: The identifier of the registrant's organizational unit.
      packageSuppression:
        type: string
        description: >-
          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:
        type: string
        description: >-
          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:
        type: string
        description: The registrant's preferred currency for transactions.
      organizationId:
        type: string
        description: The identifier of the registrant's company.
      age:
        type: string
        description: The registrant's age.
      demographicField2:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
      demographicField3:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
  com.ibm.commerce.rest.member.handler.PersonHandler$UserIdentifier:
    required:
      - userId
    description: User identitifier.
    properties:
      userId:
        type: string
        description: The user identifier.
  java.util.Map$Entry:
    required:
      - key
    properties:
      value:
        type: string
      key:
        type: string
  person-checkoutProfile:
    properties:
      userId:
        type: string
      CheckoutProfile:
        items:
          $ref: '#/definitions/person-checkoutProfile.CheckoutProfile'
        type: array
  Empty:
    description: Empty model. Used as default value when no model is specified.
  com.ibm.commerce.member.facade.datatypes.IncomeAmountType:
    properties:
      currency:
        type: string
      value:
        type: integer
        format: int32
  person-checkoutProfile.CheckoutProfile:
    required:
      - billing_email1
      - billing_email2
      - billing_fax1
      - billing_fax2
      - billing_mobilePhone1
      - billing_mobilePhone1Country
      - billing_nickName
      - billing_phone1
      - billing_phone2
      - shipping_email1
      - shipping_email2
      - shipping_fax1
      - shipping_fax2
      - shipping_mobilePhone1
      - shipping_mobilePhone1Country
      - shipping_nickName
      - shipping_phone1
      - shipping_phone2
    properties:
      billing_taxGeoCode:
        type: string
      shipping_bestCallingTime:
        type: string
      shipping_taxGeoCode:
        type: string
      shipping_nickName:
        type: string
      shipping_city:
        type: string
      shipping_addressType:
        type: string
      billing_phone2:
        type: string
      billing_phone1:
        type: string
      billing_internalOfficeAddress:
        type: string
      shipping_addressLine:
        items:
          type: string
        type: array
      shipping_fax2:
        type: string
      billing_addressType:
        type: string
      shipping_organizationUnitName:
        type: string
      billing_language:
        type: string
      shipping_publishPhone2:
        type: string
      billing_country:
        type: string
      billing_lastName:
        type: string
      shipping_primary:
        type: string
      shipping_personTitle:
        type: string
      billing_phone2Publish:
        type: string
      billing_phone1Publish:
        type: string
      shipping_phone1:
        type: string
      shipping_fax1:
        type: string
      shipping_phone2:
        type: string
      billing_personTitle:
        type: string
      billing_mobilePhone1:
        type: string
      shipping_internalOfficeAddress:
        type: string
      shipping_externalIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.ExternalShipModeIdentifier
      shipping_lastName:
        type: string
      billing_nickName:
        type: string
      shipping_zipCode:
        type: string
      billing_addressId:
        type: string
      billing_shippingGeoCode:
        type: string
      billing_personIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType
      billing_zipCode:
        type: string
      billing_email2:
        type: string
      shipping_publishPhone1:
        type: string
      shipping_firstName:
        type: string
      paymentMethod:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.PaymentMethodType
      billing_organizationUnitName:
        type: string
      shipping_mobilePhone1:
        type: string
      shipping_addressId:
        type: string
      billing_businessTitle:
        type: string
      billing_organizationIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType
      protocolData:
        items:
          $ref: '#/definitions/person-checkoutProfile.CheckoutProfile.protocolData'
        type: array
      billing_fax2:
        type: string
      billing_fax1:
        type: string
      shipping_modeId:
        type: string
      shipping_personIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType
      billing_bestCallingTime:
        type: string
      billing_organizationName:
        type: string
      shipping_email2:
        type: string
      billing_email1:
        type: string
      billing_attributes:
        items:
          $ref: '#/definitions/java.util.Map$Entry'
        type: array
      shipping_state:
        type: string
      shipping_phone2Type:
        type: string
      billing_primary:
        type: string
      billing_middleName:
        type: string
      shipping_attribute:
        items:
          $ref: '#/definitions/java.util.Map$Entry'
        type: array
      billing_phone2Type:
        type: string
      billing_addressLine:
        items:
          type: string
        type: array
      shipping_email1:
        type: string
      billing_city:
        type: string
      shipping_organizationIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType
      shipping_middleName:
        type: string
      shipping_businessTitle:
        type: string
      billing_firstName:
        type: string
      shipping_language:
        type: string
      shipping_description:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.DescriptionType
      shipping_organizationName:
        type: string
      shipping_mobilePhone1Country:
        type: string
      shipping_shippingGeoCode:
        type: string
      billing_mobilePhone1Country:
        type: string
      billing_phone1Type:
        type: string
      userDataField:
        items:
          $ref: '#/definitions/person-checkoutProfile.CheckoutProfile.userDataField'
        type: array
      shipping_country:
        type: string
      billing_state:
        type: string
      shipping_phone1Type:
        type: string
  com.ibm.commerce.member.facade.server.commands.UserRegistrationEmailActivateCmd: {}
  person-person.contextAttribute.attributeValue:
    required:
      - value
    properties:
      storeId:
        type: string
      value:
        items:
          type: string
        type: array
  com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier:
    properties:
      identifier:
        type: string
  com.ibm.commerce.rest.member.handler.PersonContactHandler$UserIdentifier:
    required:
      - userId
    description: User identitifier.
    properties:
      userId:
        type: string
        description: The user identifier.
  com.ibm.commerce.rest.member.handler.PersonHandler$UpdateMemberUser:
    description: Body of MemberGroupMemberUpdateCmd.
    properties:
      addAsExplicitInclusionToMemberGroupId:
        type: string
        description: MemberGroup Identifiers to explicitly add the user too .
      addAsExplicitExclusionToMemberGroupId:
        type: string
        description: 'MemberGroup Identifiers to explicitly exclude the user from '
      removeFromMemberGroupId:
        type: string
        description: MemberGroup Identifiers to remove the user from
  com.ibm.commerce.security.commands.ResetPasswordAdministratorCmd: {}
  com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.description:
    properties:
      value:
        type: string
      language:
        type: string
  person-contact.contact.userDataField:
    required:
      - key
    properties:
      value:
        type: string
      key:
        type: string
  com.ibm.commerce.rest.member.handler.PersonHandler$UpdateMemberUserResponse:
    description: response of MemberGroupMemberUpdateCmd.
    properties:
      storeId:
        type: string
        description: The current store identifier
      addAsExplicitExclusionToMemberGroupId:
        type: string
        description: 'MemberGroup Identifiers to explicitly exclude the user from '
      URL:
        type: string
        description: The URL to be called when the command completes successfully.
      addAsExplicitInclusionToMemberGroupId:
        type: string
        description: MemberGroup Identifiers to explicitly add the user too .
      userId:
        type: string
        description: The user identifier
      catalogId:
        type: string
        description: The catalog identifier
      requesttype:
        type: string
        description: The request type ie (ajax)
      removeFromMemberGroupId:
        type: string
        description: MemberGroup Identifiers to remove the user from
  com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType:
    properties:
      distinguishedName:
        type: string
      uniqueID:
        type: string
  person-person.receiveSMSPreference:
    required:
      - value
    properties:
      storeID:
        type: string
      value:
        type: string
  com.ibm.commerce.foundation.common.datatypes.ExternalShipModeIdentifier:
    properties:
      storeUniqueID:
        type: string
      carrier:
        type: string
      shipModeCode:
        type: string
  person-checkoutProfile.CheckoutProfile.userDataField:
    required:
      - key
    properties:
      value:
        type: string
      key:
        type: string
  person-person.contact:
    required:
      - email1
      - email2
      - fax1
      - fax2
      - mobilePhone1
      - mobilePhone1Country
      - nickName
      - phone1
      - phone2
    properties:
      addressType:
        type: string
      addressLine:
        items:
          type: string
        type: array
      addressId:
        type: string
      personTitle:
        type: string
      primary:
        type: string
      email2:
        type: string
      email1:
        type: string
      city:
        type: string
      middleName:
        type: string
      geographicalTaxCode:
        type: string
      state:
        type: string
      internalOfficeAddress:
        type: string
      fax2:
        type: string
      fax1:
        type: string
      organizationIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType
      phone1Type:
        type: string
      nickName:
        type: string
      phone2Type:
        type: string
      phone2:
        type: string
      businessTitle:
        type: string
      phone1:
        type: string
      zipCode:
        type: string
      bestCallingTime:
        type: string
      phone1Publish:
        type: string
      mobilePhone1Country:
        type: string
      phone2Publish:
        type: string
      mobilePhone1:
        type: string
      personIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType
      organizationUnitName:
        type: string
      organizationName:
        type: string
      language:
        type: string
      firstName:
        type: string
      lastName:
        type: string
      geographicalShippingCode:
        type: string
      country:
        type: string
      attributes:
        items:
          $ref: '#/definitions/java.util.Map$Entry'
        type: array
      userDataField:
        items:
          $ref: '#/definitions/person-person.contact.userDataField'
        type: array
  person-contact:
    properties:
      contact:
        items:
          $ref: '#/definitions/person-contact.contact'
        type: array
      userId:
        type: string
      addressId:
        type: string
  com.ibm.commerce.rest.member.handler.PersonHandler$ResetPasswordAdministratorRequest:
    required:
      - logonId
    description: Request of ResetPasswordAdministratorCmd.
    properties:
      URL:
        type: string
        description: The URL to be called when the command completes successfully.
      administratorPassword:
        type: string
        description: The administrator password
      logonId:
        type: string
        description: The logonId of shopper whose password needs to be reset.
  person-person.attributes:
    required:
      - bProfileAttrKey
      - contactInfoAttrKey
      - pProfileAttrKey
    properties:
      contactInfoAttrValue:
        type: string
      pProfileAttrValue:
        type: string
      contactInfoAttrKey:
        type: string
      bProfileAttrValue:
        type: string
      pProfileAttrKey:
        type: string
      bProfileAttrKey:
        type: string
  com.ibm.commerce.user.beans.MemberRoleAssignDataBean_IBM_Roles_Of_User_In_Orgs_I_Can_Admin:
    properties:
      orgIdRoleDataBeans:
        $ref: >-
          #/definitions/com.ibm.commerce.user.beans.MemberRoleAssignDataBean_IBM_Roles_Of_User_In_Orgs_I_Can_Admin.orgIdRoleDataBeans
  person-checkoutProfile.CheckoutProfile.protocolData:
    required:
      - name
    properties:
      name:
        type: string
      value:
        type: string
  com.ibm.commerce.rest.member.handler.PersonCheckoutProfileHandler$UserIdContainer:
    required:
      - userId
    description: User identification container.
    properties:
      userId:
        type: string
        description: User identification.
  person-person:
    required:
      - challengeQuestion
      - email1
      - email2
      - fax1
      - fax2
      - logonId
      - mobilePhone1
      - mobilePhone1Country
      - nickName
      - phone1
      - phone2
    properties:
      receiveEmailPreference:
        items:
          $ref: '#/definitions/person-person.receiveEmailPreference'
        type: array
      addressType:
        type: string
      addressLine:
        items:
          type: string
        type: array
      addressId:
        type: string
      lastUpdate:
        type: string
      personTitle:
        type: string
      preferredCommunication:
        type: string
      userId:
        type: string
      primary:
        type: string
      receiveSMSNotification:
        type: string
      manager:
        type: string
      maritalStatus:
        type: string
      hobbies:
        type: string
      preferredCurrency:
        type: string
      email2:
        type: string
      employeeID:
        type: string
      distinguishedName:
        type: string
      city:
        type: string
      employeeType:
        type: string
      numberOfChildren:
        type: string
        format: int32
      middleName:
        type: string
      geographicalTaxCode:
        type: string
      challengeQuestion:
        type: string
      organizationDistinguishedName:
        type: string
      householdSize:
        type: string
        format: int32
      nickName:
        type: string
      dateOfBirth:
        type: string
      state:
        type: string
      registrationStatus:
        enum:
          - Guest
          - RegisteredPerson
        type: string
      profileType:
        enum:
          - Consumer
          - Business
        type: string
      fax2:
        type: string
      fax1:
        type: string
      income:
        $ref: >-
          #/definitions/com.ibm.commerce.member.facade.datatypes.IncomeAmountType
      orgizationId:
        type: string
      organizationIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType
      email1:
        type: string
      internalOfficeAddress:
        type: string
      lastName:
        type: string
      departmentNumber:
        type: string
      photoURI:
        type: string
      phone2Type:
        type: string
      description:
        type: string
      registrationApprovalStatus:
        type: string
      companyName:
        type: string
      phone2:
        type: string
      businessTitle:
        type: string
      phone1:
        type: string
      zipCode:
        type: string
      logonId:
        type: string
      registrationDateTime:
        type: string
      bestCallingTime:
        type: string
      contextAttribute:
        items:
          $ref: '#/definitions/person-person.contextAttribute'
        type: array
      mobilePhone1Country:
        type: string
      phone2Publish:
        type: string
      mobilePhone1:
        type: string
      phone1Type:
        type: string
      organizationName:
        type: string
      phone1Publish:
        type: string
      receiveSMSPreference:
        items:
          $ref: '#/definitions/person-person.receiveSMSPreference'
        type: array
      personIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType
      organizationUnitName:
        type: string
      displayName:
        type: string
      language:
        type: string
      firstName:
        type: string
      country:
        type: string
      geographicalShippingCode:
        type: string
      passwordExpired:
        type: string
      accountStatus:
        enum:
          - Enabled
          - Disabled
        type: string
      preferredLanguage:
        type: string
      contact:
        items:
          $ref: '#/definitions/person-person.contact'
        type: array
      preferredDelivery:
        type: string
      gender:
        enum:
          - Male
          - Female
          - Unspecified
        type: string
      attributes:
        items:
          $ref: '#/definitions/person-person.attributes'
        type: array
      userDataField:
        items:
          $ref: '#/definitions/person-person.userDataField'
        type: array
      secretary:
        type: string
  person-singleContact:
    required:
      - email1
      - email2
      - fax1
      - fax2
      - mobilePhone1
      - mobilePhone1Country
      - nickName
      - phone1
      - phone2
    properties:
      addressType:
        type: string
      addressLine:
        items:
          type: string
        type: array
      addressId:
        type: string
      personTitle:
        type: string
      primary:
        type: string
      email2:
        type: string
      email1:
        type: string
      city:
        type: string
      middleName:
        type: string
      geographicalTaxCode:
        type: string
      state:
        type: string
      internalOfficeAddress:
        type: string
      fax2:
        type: string
      fax1:
        type: string
      organizationIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType
      phone1Type:
        type: string
      nickName:
        type: string
      phone2Type:
        type: string
      phone2:
        type: string
      businessTitle:
        type: string
      phone1:
        type: string
      zipCode:
        type: string
      bestCallingTime:
        type: string
      phone1Publish:
        type: string
      mobilePhone1Country:
        type: string
      phone2Publish:
        type: string
      mobilePhone1:
        type: string
      personIdentifier:
        $ref: >-
          #/definitions/com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType
      organizationUnitName:
        type: string
      organizationName:
        type: string
      language:
        type: string
      firstName:
        type: string
      lastName:
        type: string
      geographicalShippingCode:
        type: string
      country:
        type: string
      attributes:
        items:
          $ref: '#/definitions/java.util.Map$Entry'
        type: array
      userDataField:
        items:
          $ref: '#/definitions/person-singleContact.userDataField'
        type: array
  person-person.receiveEmailPreference:
    required:
      - value
    properties:
      storeID:
        type: string
      value:
        type: string
  com.ibm.commerce.foundation.common.datatypes.DescriptionType:
    properties:
      value:
        type: string
      language:
        type: string
  com.ibm.commerce.price.commands.SetCurrencyPreferenceCmd: {}
  com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.userData:
    properties:
      userDataField:
        items:
          $ref: >-
            #/definitions/com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.userData.userDataField
        type: array
  com.ibm.commerce.rest.member.handler.PersonHandler$UserRegistrationAdminUpdateRequest:
    description: Request of UserRegistrationAdminUpdateCmd.
    properties:
      maritalStatus:
        type: string
        description: The registrant's marital statu.
      photo:
        type: string
        description: URL or path to a photo of the registrant.
      userId:
        type: string
        description: The user the administrator will update.
      manager:
        type: string
        description: The name of the registrant's manager.
      email2:
        type: string
        description: The registrant's secondary e-mail or Web address.
      children:
        type: string
        description: The number of children the registrant has.
      email1:
        type: string
        description: The registrant's primary e-mail or Web address.
      middleName:
        type: string
        description: The middle name of the registrant.
      logonPassword:
        type: string
        description: >-
          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:
        type: string
        description: 'The internal address (for example, mail stop).'
      preferredMeasure:
        type: string
        description: The registrant's preferred unit of measure.
      URL:
        type: string
        description: The URL to be called when the command completes successfully.
      address1:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      address2:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      address3:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      zipCode:
        type: string
        description: The ZIP or postal code of the registrant's address.
      logonPasswordVerify:
        type: string
        description: >-
          Required if the logonPassword is used: The registrant's password,
          entered a second time.
      mobilePhone1:
        type: string
        description: >-
          The registrant's mobile phone number used for SMS, for example,
          4161235555.
      organizationName:
        type: string
        description: The name of the organization that the registrant represents.
      firstName:
        type: string
        description: The first name of the registrant.
      gender:
        type: string
        description: The registrant's gender.
      receiveSMSNotification:
        type: string
        description: >-
          Indicates whether the user wants to receive order notification SMS
          text messages. Valid values are true or false (default).
      billingCode:
        type: string
        description: >-
          The registrant's organization's code to identify the shipping or
          billing addresses and cost center.
      secretary:
        type: string
        description: The name of the registrant's secretary.
      billingCodeType:
        type: string
        description: >-
          Code designating the method of code structure used for the billing
          code. The default value is D, assigned by buyer.
      receiveSMS:
        type: string
        description: >-
          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:
        type: string
        description: >-
          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:
        type: string
        description: The registrant's ID with his or her employer.
      preferredLanguage:
        type: string
        description: The registrant's preferred language.
      challengeQuestion:
        type: string
        description: Challenge question for verbal confirmation of the customer's identity.
      dateOfBirth:
        type: string
        description: 'Date of birth. The format is yyyy-mm-dd, for example: 1980-01-01.'
      state:
        type: string
        description: >-
          The name of the state, province, or equivalent where the registrant
          resides.
      phone1Type:
        type: string
        description: >-
          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:
        type: string
        description: >-
          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:
        type: string
        description: >-
          The company name of the organization that the registrant represents,
          obtained when filling in demographic information.
      phone2:
        type: string
        description: The registrant's secondary phone number.
      phone1:
        type: string
        description: The registrant's primary phone number.
      taxGeoCode:
        type: string
        description: >-
          A tax code based on geographical region, especially useful with tax
          software.
      organizationUnitName:
        type: string
        description: >-
          The name of the unit within the organization that the registrant
          represents.
      country:
        type: string
        description: The name of the country or region where the registrant resides.
      timeZone:
        type: string
        description: >-
          The time zone in which the registrant does business (report as GMT +/-
          hours).
      mobilePhone1Country:
        type: string
        description: >-
          The country code used for the registrant's mobile phone number, for
          example, CA for Canada.
      incomeCurrency:
        type: string
        description: The currency in which the registrant's income is paid.
      shippingGeoCode:
        type: string
        description: >-
          A shipping code based on geographical region, especially useful with
          tax software.
      preferredCommunication:
        items:
          type: string
        type: array
        description: >-
          The preferred phone for the registrant (stored in the ADDRESS table),
          for example: P1=phone 1 P2=phone 2.
      city:
        type: string
        description: The name of the city where the registrant resides.
      addressField1:
        type: string
        description: Customizable field.
      addressField3:
        type: string
        description: Customizable field.
      addressField2:
        type: string
        description: Customizable field.
      fax2:
        type: string
        description: The registrant's secondary facsimile number.
      fax1:
        type: string
        description: The registrant's primary facsimile number.
      departmentNumber:
        type: string
        description: The department identifier for the registrant.
      logonId:
        type: string
        description: >-
          The registrant's logon ID. If you 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 you 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:
        type: string
        description: >-
          A string used to identify the user for taxation, especially useful
          with tax software.
      demographicField6:
        type: string
        description: Customizable field for demographic information; an integer field.
      demographicField7:
        type: string
        description: >-
          Customizable field for demographic information; a field varchar,
          length 6.
      demographicField4:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
      demographicField5:
        type: string
        description: >-
          Customizable field for demographic information; a field of 254
          characters.
      userField3:
        type: string
        description: Customizable field.
      userField2:
        type: string
        description: Customizable field.
      userField1:
        type: string
        description: Customizable field.
      demographicField1:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
      receiveEmail:
        type: string
        description: >-
          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:
        type: string
        description: The registrant's preferred mode of delivery.
      lastName:
        type: string
        description: >-
          Required if the authentication mode is LDAP: The last name of the
          registrant. If the authentication mode is LDAP, this parameter is
          mandatory.
      orderBefore:
        type: string
        description: >-
          Whether the registrant has previously placed an order. This value is
          supplied by the registrant.
      addressType:
        type: string
        description: >-
          The purpose of the address. Valid values are: S - shipto, B - billto,
          SB - shipto and billto (The default value.).
      personTitle:
        type: string
        description: >-
          The title of the user whose address is being entered (for example,
          Dr., Rev., Mr. or Ms.).
      household:
        type: string
        description: The number of people in the registrant's household; the default is 1.
      customMemberAttributes:
        items:
          type: string
        type: array
        description: >-
          You can manage custom member attributes (MBRATTRVAL table) for this
          user using the following syntax:
          &attributeName_storeId_action_number=value.
      hobbies:
        type: string
        description: The registrant's hobbies.
      alternateId:
        type: string
        description: >-
          A special ID assigned by the registrant's business organization or
          organizational unit to this particular registrant..
      employeeType:
        type: string
        description: >-
          The registrant's status as an employee (for example, regular,
          permanent, contractor, or part time).
      challengeAnswer:
        type: string
        description: Answer to the challenge question.
      userProfileField1:
        type: string
        description: Customizable field.
      userProfileField2:
        type: string
        description: Customizable field.
      income:
        type: string
        description: The registrant's annual incom.
      description:
        type: string
        description: A description of the registrant.
      publishPhone2:
        type: string
        description: >-
          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:
        type: string
        description: The identifier of the registrant's organizational unit.
      packageSuppression:
        type: string
        description: >-
          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:
        type: string
        description: >-
          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:
        type: string
        description: The registrant's preferred currency for transactions.
      organizationId:
        type: string
        description: The identifier of the registrant's company.
      age:
        type: string
        description: The registrant's age.
      demographicField2:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
      demographicField3:
        type: string
        description: >-
          Customizable field for demographic information; this is
          single-character field.
  com.ibm.commerce.user.beans.MemberRoleAssignDataBean_IBM_Roles_Of_User_In_Orgs_I_Can_Admin.orgIdRoleDataBeans: {}
  com.ibm.commerce.rest.member.handler.PersonHandler$DeleteContextAttribute:
    required:
      - addressId
      - userId
    description: Delete context attribute response.
    properties:
      userId:
        items:
          type: string
        type: array
        description: The user identifier list.
      addressId:
        items:
          type: string
        type: array
        description: The address identifier list.
  com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.userData.userDataField:
    required:
      - key
    properties:
      value:
        type: string
      key:
        type: string
  person-singleContact.userDataField:
    required:
      - key
    properties:
      value:
        type: string
      key:
        type: string
  person-person.contextAttribute:
    required:
      - attributeName
      - attributeValue
    properties:
      attributeName:
        type: string
      attributeValue:
        items:
          $ref: '#/definitions/person-person.contextAttribute.attributeValue'
        type: array
  com.ibm.commerce.emarketing.beans.EmailUserReceiveDataBean_IBM_optOut_all:
    properties:
      userReceiveSMS:
        type: boolean
      userReceive:
        type: boolean
  com.ibm.commerce.rest.member.handler.OrganizationHandler.OrgEntityBuyerIdentifier:
    required:
      - orgEntityId
      - userId
    description: Response of registering an organization entity and a buyer.
    properties:
      orgEntityId:
        type: string
        description: The organization entity identifier.
      userId:
        type: string
        description: The buyer identifier.
  com.ibm.commerce.rest.member.handler.OrganizationHandler.BuyerRegistrationAddRequest:
    required:
      - org_orgEntityName
      - usr_logonId
      - usr_logonPassword
      - usr_logonPasswordVerify
    description: Request of BuyerRegistrationAddCmd.
    properties:
      org_orgEntityName:
        items:
          type: string
        type: array
        description: The name of the new buyer organization to register.
      usr_logonId:
        items:
          type: string
        type: array
        description: The logonId for the buyer organization's initial administrator.
      usr_logonPassword:
        items:
          type: string
        type: array
        description: >-
          The logonId for the password of buyer organization's initial
          administrator's.
      usr_logonPasswordVerify:
        items:
          type: string
        type: array
        description: >-
          The logonId for the password of buyer organization's initial
          administrator's entered a second time.
  com.ibm.commerce.approval.beans.OrderApprovalStatusListDataBean_IBM_Store_Summary.resultList:
    properties:
      approvalStatusId:
        type: string
      approverGroupId:
        type: string
      submitTime:
        type: string
        format: date
      flowTypeId:
        type: string
      stateId:
        type: string
      comment:
        type: string
      submitterId:
        type: string
      flowId:
        type: string
      approveTime:
        type: string
        format: date
      status:
        type: string
      approverId:
        type: string
      entityId:
        type: string
  com.ibm.commerce.rest.member.handler.OrganizationHandler_OrgEntityIdentity:
    required:
      - addressId
      - orgEntityId
    description: Information about an organization entity identity.
    properties:
      orgEntityId:
        type: string
        description: The organization entity identifier.
      addressId:
        type: string
        description: The address identifier of the organization entity.
  com.ibm.commerce.rest.member.handler.OrganizationHandler_OrgEntityAddRequest:
    required:
      - distinguishedName
      - orgEntityName
      - orgEntityType
      - parentMemberId
    description: Request of OrgEntityAddCmd.
    properties:
      addressType:
        type: string
        description: >-
          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:
        type: string
        description: >-
          The title of the user whose address is being entered (for example,
          Dr., Rev., Mr. or Ms.).
      orgEntityName:
        type: string
        description: >-
          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:
        type: string
        description: >-
          Code designating the method of code structure used for the billing
          code. The default value is D, assigned by buyer.
      customMemberAttributes:
        items:
          type: string
        type: array
        description: >-
          You can manage custom member attributes (MBRATTRVAL table) for this
          organization using the following syntax:
          &attributeName_storeId_action_number=value.
      email2:
        type: string
        description: The registrant's secondary e-mail or Web address.
      email1:
        type: string
        description: The registrant's primary e-mail or Web address.
      distinguishedName:
        type: string
        description: 'DN of the organization or organizational unit, for LDAP use.'
      city:
        type: string
        description: The name of the city where the registrant resides.
      administratorMiddleName:
        type: string
        description: The middle name of the administrator.
      middleName:
        type: string
        description: The middle name of the registrant.
      administratorLastName:
        type: string
        description: The last name of the administrator.
      state:
        type: string
        description: >-
          The name of the state, province, or equivalent where the registrant
          resides.
      addressField1:
        type: string
        description: Customizable field.
      phone2:
        type: string
        description: The registrant's secondary phone number.
      addressField3:
        type: string
        description: Customizable field.
      addressField2:
        type: string
        description: Customizable field.
      fax2:
        type: string
        description: The registrant's secondary facsimile number.
      fax1:
        type: string
        description: The registrant's primary facsimile number.
      phone1Type:
        type: string
        description: >-
          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:
        type: string
        description: Customizable field.
      orgEntityField2:
        type: string
        description: Customizable field.
      orgEntityField3:
        type: string
        description: Customizable field.
      phone2Type:
        type: string
        description: >-
          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:
        type: string
        description: A description of the registrant.
      publishPhone2:
        type: string
        description: >-
          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:
        type: string
        description: A string used to identify the user for taxation purposes.
      URL:
        type: string
        description: The URL to call when the command completes successfully.
      address1:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      address2:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      address3:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      zipCode:
        type: string
        description: The ZIP or postal code of the registrant's address.
      packageSuppression:
        type: string
        description: >-
          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:
        type: string
        description: >-
          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:
        type: string
        description: The registrant's primary phone number.
      taxGeoCode:
        type: string
        description: >-
          A tax code based on geographical region, especially useful with tax
          software.
      publishPhone1:
        type: string
        description: >-
          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:
        type: string
        description: >-
          The name of the unit within the organization that the registrant
          represents.
      firstName:
        type: string
        description: The first name of the registrant.
      organizationName:
        type: string
        description: The name of the organization that the registrant represents.
      businessCategory:
        type: string
        description: >-
          Describes the kind of business performed by an organization or
          organizational unit.
      preferredDelivery:
        type: string
        description: The registrant's preferred mode of delivery.
      shippingGeoCode:
        type: string
        description: >-
          A shipping code based on geographical region, especially useful with
          tax software.
      country:
        type: string
        description: The name of the country or region where the registrant resides.
      parentMemberId:
        type: string
        description: >-
          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:
        type: string
        description: The first name of the administrator.
      billingCode:
        type: string
        description: >-
          The registrant's organization's code to identify the shipping or
          billing addresses and cost center.
      lastName:
        type: string
        description: >-
          Required if the authentication mode is LDAP: The last name of the
          registrant. If the authentication mode is LDAP, this parameter is
          mandatory.
      orgEntityType:
        type: string
        description: >-
          The type of the organizational entity being added. O - Organization;
          OU - Organizational Unit.
      legalId:
        type: string
        description: >-
          Registered organization identifier; may be null for an organizational
          unit.
  com.ibm.commerce.rest.member.handler.OrganizationHandler_OrgEntityUpdateRequest:
    required:
      - orgEntityId
    description: Request of OrgEntityUpdateCmd.
    properties:
      addressType:
        type: string
        description: >-
          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:
        type: string
        description: >-
          The title of the user whose address is being entered (for example,
          Dr., Rev., Mr. or Ms.).
      orgEntityName:
        type: string
        description: The name of the organization or organizational unit.
      billingCodeType:
        type: string
        description: >-
          Code designating the method of code structure used for the billing
          code. The default value is D, assigned by buyer.
      orgEntityId:
        type: string
        description: The ID for this organization or organizational unit.
      customMemberAttributes:
        items:
          type: string
        type: array
        description: >-
          You can manage custom member attributes (MBRATTRVAL table) for this
          organization using the following syntax:
          &attributeName_storeId_action_number=value.
      email2:
        type: string
        description: The registrant's secondary e-mail or Web address.
      email1:
        type: string
        description: The registrant's primary e-mail or Web address.
      city:
        type: string
        description: The name of the city where the registrant resides.
      administratorMiddleName:
        type: string
        description: The middle name of the administrator.
      middleName:
        type: string
        description: The middle name of the registrant.
      administratorLastName:
        type: string
        description: The last name of the administrator.
      addressField3:
        type: string
        description: Customizable field.
      addressField1:
        type: string
        description: Customizable field.
      phone2:
        type: string
        description: The registrant's secondary phone number.
      state:
        type: string
        description: >-
          The name of the state, province, or equivalent where the registrant
          resides.
      addressField2:
        type: string
        description: Customizable field.
      fax2:
        type: string
        description: The registrant's secondary facsimile number.
      fax1:
        type: string
        description: The registrant's primary facsimile number.
      phone1Type:
        type: string
        description: >-
          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:
        type: string
        description: Customizable field.
      orgEntityField2:
        type: string
        description: Customizable field.
      orgEntityField3:
        type: string
        description: Customizable field.
      phone2Type:
        type: string
        description: >-
          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:
        type: string
        description: A description of the registrant.
      publishPhone2:
        type: string
        description: >-
          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:
        type: string
        description: A string used to identify the user for taxation purposes.
      URL:
        type: string
        description: The URL to call when the command completes successfully.
      address1:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      address2:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      address3:
        type: string
        description: >-
          The registrant's street address, to a maximum of three lines of
          information.
      zipCode:
        type: string
        description: The ZIP or postal code of the registrant's address.
      packageSuppression:
        type: string
        description: >-
          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:
        type: string
        description: >-
          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:
        type: string
        description: The registrant's primary phone number.
      taxGeoCode:
        type: string
        description: >-
          A tax code based on geographical region, especially useful with tax
          software.
      publishPhone1:
        type: string
        description: >-
          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:
        type: string
        description: >-
          The name of the unit within the organization that the registrant
          represents.
      firstName:
        type: string
        description: The first name of the registrant.
      organizationName:
        type: string
        description: The name of the organization that the registrant represents.
      businessCategory:
        type: string
        description: >-
          Describes the kind of business performed by an organization or
          organizational unit.
      preferredDelivery:
        type: string
        description: The registrant's preferred mode of delivery.
      shippingGeoCode:
        type: string
        description: >-
          A shipping code based on geographical region, especially useful with
          tax software.
      country:
        type: string
        description: The name of the country or region where the registrant resides.
      administratorFirstName:
        type: string
        description: The first name of the administrator.
      billingCode:
        type: string
        description: >-
          The registrant's organization's code to identify the shipping or
          billing addresses and cost center.
      lastName:
        type: string
        description: >-
          Required if the authentication mode is LDAP: The last name of the
          registrant. If the authentication mode is LDAP, this parameter is
          mandatory.
      legalId:
        type: string
        description: >-
          Registered organization identifier; may be null for an organizational
          unit.
  com.ibm.commerce.rest.member.handler.OrganizationHandler_UpdateApprovalGroups:
    required:
      - URL
      - orgEntityId
      - segmentId
    description: Information about an organization entity identity.
    properties:
      URL:
        type: string
        description: The URL to call when the command completes successfully.
      orgEntityId:
        type: string
        description: The organization entity identifier.
      segmentId:
        type: string
        description: The ApprovalGroup identifier for a specific organization.
  com.ibm.commerce.rest.member.handler.OrganizationHandler_UpdateApprovalGroupsResponse:
    required:
      - URL
      - orgEntityId
      - segmentId
    description: Information about an organization entity identity.
    properties:
      orgEntityId:
        type: string
        description: The organization entity identifier.
      segmentId:
        type: string
        description: The ApprovalGroup identifier for a specific organization.
      URL:
        type: string
        description: The URL to call when the command completes successfully.
      storeId:
        type: string
        description: The current store identifier.
      catalogId:
        type: string
        description: The catalog identifier.
      requesttype:
        type: string
        description: 'The request type for example, ajax.'
  com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Details:
    description: ''
    properties:
      pageNumber:
        type: integer
        format: int32
      pageSize:
        type: integer
        format: int32
      recordSetCount:
        type: integer
        format: int32
      recordSetTotal:
        type: integer
        format: int32
      recordSetCompleteIndicator:
        type: boolean
      organizationDataBeans:
        $ref: >-
          #/definitions/com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Details.organizationDataBeans
  com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Details.organizationDataBeans:
    description: ''
    properties:
      administratorFirstName:
        type: string
      administratorLastName:
        type: string
      administratorMiddleName:
        type: string
      businessCategory:
        type: string
      description:
        type: string
      displayName:
        type: string
      distinguishedName:
        type: string
      legalId:
        type: string
      memberId:
        type: string
      orgEntityField1:
        type: string
      orgEntityField2:
        type: string
      orgEntityField3:
        type: string
      orgEntityType:
        type: string
      organizationId:
        type: string
      organizationName:
        type: string
      owner:
        type: integer
        format: int64
      ownerMemberId:
        type: string
      parentMemberId:
        type: string
      preferredDelivery:
        type: string
      roles:
        type: array
        items:
          type: integer
          format: int32
      state:
        type: string
      status:
        type: string
      taxPayerId:
        type: string
        description: A string used to identify the user for taxation purposes.
      type:
        type: string
  com.ibm.commerce.rest.member.handler.UserActivateHandler.ActiveUserRequestBody:
    description: Request body to activate the user account.
    required:
      - logonId
      - validationCode
    properties:
      logonId:
        description: The user's logon ID.
        type: string
      validationCode:
        description: The account validation code.
        type: string
  com.ibm.commerce.rest.member.handler.UserActivateHandler.ActiveUserResponse:
    description: Response body to activate the user account.
    required:
      - redirecturl
      - logonId
      - viewTaskName
    properties:
      redirecturl:
        description: The redirect URL.
        type: string
      logonId:
        description: The user's logon ID.
        type: string
      viewTaskName:
        description: The view task name.
        type: string
      storeId:
        description: The store identifier.
        type: string
      langId:
        description: The language ID.
        type: string
  com.ibm.commerce.rest.member.handler.UserActivateHandler.ResendActiveUserRequestBody:
    description: Request body for resend user account activation email.
    required:
      - logonId
      - logonPassword
    properties:
      email1:
        description: >-
          An alternative email that the user account activation email can be
          sent to.
        type: string
      logonId:
        description: The user's logon ID.
        type: string
      logonPassword:
        description: The user's logon password.
        type: string
  com.ibm.commerce.user.beans.UserDisplayDataBean_IBM_User_Registration_Options_Summary:
    description: Response body containing user registration options.
    properties:
      bestCallingTimeList:
        type: array
        items:
          $ref: >-
            #/definitions/com.ibm.commerce.user.beans.UserDisplayDataBean_IBM_User_Registration_Options_Summary.bestCallingTimeList
      policyAccountIdList:
        type: array
        items:
          $ref: >-
            #/definitions/com.ibm.commerce.user.beans.UserDisplayDataBean_IBM_User_Registration_Options_Summary.policyAccountIdList
      preferredLanguagesList:
        type: array
        items:
          $ref: >-
            #/definitions/com.ibm.commerce.user.beans.UserDisplayDataBean_IBM_User_Registration_Options_Summary.preferredLanguagesList
      userStatusList:
        type: array
        items:
          $ref: >-
            #/definitions/com.ibm.commerce.user.beans.UserDisplayDataBean_IBM_User_Registration_Options_Summary.userStatusList
      userId:
        type: string
        description: The user ID.
  com.ibm.commerce.user.beans.UserDisplayDataBean_IBM_User_Registration_Options_Summary.bestCallingTimeList:
    type: array
    description: Best calling time options for user registration.
    items:
      $ref: '#/definitions/registrationOptionsNVP'
  com.ibm.commerce.user.beans.UserDisplayDataBean_IBM_User_Registration_Options_Summary.policyAccountIdList:
    type: array
    description: Account policy options for user registration.
    items:
      $ref: '#/definitions/registrationOptionsNVP'
  com.ibm.commerce.user.beans.UserDisplayDataBean_IBM_User_Registration_Options_Summary.preferredLanguagesList:
    type: array
    description: Preferred language options for user registration.
    items:
      $ref: '#/definitions/registrationOptionsNVP'
  com.ibm.commerce.user.beans.UserDisplayDataBean_IBM_User_Registration_Options_Summary.userStatusList:
    type: array
    description: User status options for user registration.
    items:
      $ref: '#/definitions/registrationOptionsNVP'
  registrationOptionsNVP:
    type: object
    properties:
      text:
        type: string
      value:
        type: string
  ErrorMessageResponseContainer:
    type: object
    properties:
      errors:
        type: array
        items:
          $ref: '#/definitions/ErrorMessageResponse'
  ErrorMessageResponse:
    type: object
    properties:
      errorKey:
        type: string
        description: The error message key.
      errorParameters:
        type: array
        items:
          type: string
      errorMessage:
        type: string
        description: A descriptive error message.
      errorCode:
        type: string
        description: The error message code.
  com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details.parentRolesWithDetails:
    properties:
      roleId:
        type: string
      displayName:
        type: string
      description:
        type: string
      name:
        type: string
  com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details:
    properties:
      parentRolesWithDetails:
        items:
          $ref: >-
            #/definitions/com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details.parentRolesWithDetails
        type: array
      displayName:
        type: string
      memberId:
        type: string
  com.ibm.commerce.member.beans.OrganizationListDataBean_IBM_Organization_Summary.entitledOrganizations:
    properties:
      distinguishedName:
        type: string
      organizationId:
        type: integer
        format: int64
      displayName:
        type: string
      memberId:
        type: integer
        format: int64
      organizationName:
        type: string
  com.ibm.commerce.member.beans.OrganizationListDataBean_IBM_Organization_Summary:
    properties:
      entitledOrganizations:
        items:
          $ref: >-
            #/definitions/com.ibm.commerce.member.beans.OrganizationListDataBean_IBM_Organization_Summary.entitledOrganizations
        type: array
      accountCheck:
        type: boolean
