--- host: "localhost" basePath: "/wcs/resources" schemes: - "https" swagger: "2.0" info: version: "WC.TOOLKIT Enterprise Version : 8 Fix Pack : 12" title: "WebSphere Commerce V8 - Other API" tags: - name: "ibmid_identity" description: "This class provides RESTful services to login and logout a registered user using an LTPA token. It performs the service by delegating to the Person BOD service." - name: "clientlocation_" description: "This class provides RESTful services to retrieve client location data. It uses ClientLocation noun." - name: "api" description: "Information about the resources and APIs available on the server." - name: "requisition_list" description: "A requisition list is a list of items that is used to create orders at a later date." - name: "store" description: "This class provides RESTful services to get available resource URLs for a store." - name: "term_condition" description: "A term or condition of an account or contract." - name: "pointofinterest_" description: "This class provides RESTful services to retrieve point of interest data. It uses PointOfInterest noun." - name: "pointofinterest" description: "This class provides RESTful services to retrieve point of interest data. It uses PointOfInterest noun." - name: "member_group" description: "A member group is a grouping of members - users, organizations, or other member groups - used for various business purposes." - name: "organization" description: "This class provides RESTful services to register an organization, to get or update organization information." - name: "switchContract" description: "This class provides RESTful services to switch contract." - name: "approval_status" description: "Accurate, secure transactions require that a second individual approve some electronic marketplace actions before they proceed. This individual, called an approver, can accept or reject requests to perform a specific action. This class provides RESTful services to retrieve order and buyer approval status record details and to approve or reject them. " - name: "ltpa_identity" description: "This class provides RESTful services to login and logout a registered user using an LTPA token. It performs the service by delegating to the Person BOD service." - name: "jwt_identity" description: "This class provides RESTful services to return a JWT Response using WCToken and WCTrustedToken." - name: "contract" description: "This class provides RESTful services to access retrieve contract details." - name: "activity" description: "This class provides RESTful services to retrieve activity details." - name: "wc_identity" description: "This class provides RESTful services that invoke tWAS OIDC interceptor for WC, and once WC authenticates with Blue ID and creates an LTPA token, redirect back to the CI referrer login servlet." - name: "file_upload_job" description: "This class provides RESTful services to display summary and detail for a file upload job. It uses the FileUploadJob noun." - name: "order_" - name: "switchOrganization" description: "This class provides RESTful services to switch organization." - name: "contentUrl" description: "This class provides RESTful services to resolve the content url." - name: "feature" description: "This class provides RESTful services to retrieve information about features supported on server, like feature name and version number. " - name: "aggregate" description: "An aggregate of responses from multiple REST API requests." - name: "access_control_for_view" description: "This class provides RESTful services to get check if a user has access to specified view." - name: "clientlocation" description: "This class provides RESTful services to create and retrieve client location data. It uses ClientLocation noun." - name: "saml_identity" description: "This class provides RESTful services to return a SAML Response using WCToken and WCTrustedToken." paths: /store/{storeId}/ibmididentity: post: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/com.ibm.commerce.rest.member.handler.LTPAIdentityHandler$UserIdentity" 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." 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" 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: "LTPA logon body." name: "body" schema: $ref: "#/definitions/com.ibm.commerce.rest.member.handler.LTPAIdentityHandler$LtpaLoginForm" tags: - "ibmid_identity" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Authenticates a user using an LTPA token." consumes: - "application/json" - "application/xml" operationId: "authenticate" /store/{storeId}/clientLocations/byZoneId/{zoneId}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "zoneId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by zone Id." operationId: "retrieveClientLocationsByZoneId" /api/aggregated: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$ResourceLinkList" 400: description: "Bad request. Some of the inputs provided to the request aren't valid." 403: description: "If API Discovery is disabled on the server." 500: description: "Internal server error. Additional details will be contained on the server logs." parameters: - 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: - "api" produces: - "application/json" - "application/xml" summary: "Get the aggregated list of available resources on multiple server." operationId: "getAggregatedResourceList" /store/{storeId}/requisition_list/{requisitionListId}: put: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListUpdateResponse" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The requisition list ID." in: "path" name: "requisitionListId" - required: false in: "body" description: "The body data." name: "body" schema: $ref: "#/definitions/com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListUpdateRequest" tags: - "requisition_list" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Updates a requisition list." operationId: "update" post: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListSubmitResponse" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The requisition list ID." in: "path" name: "requisitionListId" - enum: - "submit" name: "action" required: true in: "query" type: "string" description: "The action." - required: false in: "body" description: "The body data." name: "body" schema: $ref: "#/definitions/com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListSubmitRequest" tags: - "requisition_list" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Submits a requisition list." operationId: "submit" get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The requisition list ID." in: "path" name: "requisitionListId" tags: - "requisition_list" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Finds a requisition list by its ID." operationId: "findByRequisitionListId" delete: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListDeleteResponse" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The requisition list ID." in: "path" name: "requisitionListId" - required: false in: "body" description: "The body data." name: "body" schema: $ref: "#/definitions/com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListDeleteRequest" tags: - "requisition_list" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Deletes a requisition list." operationId: "delete" /store/{storeId}/storeAsset: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/store-store" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The path to the asset on the WCH. Asset path can be relative or full." in: "query" name: "assetPath" - enum: - "IBM_Store_All" name: "profileName" required: false in: "query" type: "string" description: "Profile name. Profiles determine the subset of data to be returned by a query." - 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: - "store" produces: - "*/*" summary: "This method returns the store asset at the specified path (relative or full) from the Watson Content Hub." operationId: "getStoreAsset" /store/{storeId}/term_condition: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.tools.contract.beans.DisplayCustomizationTCDataBean_IBM_Store_Details" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - enum: - "displayCustomizationTC" name: "q" required: true in: "query" type: "string" description: "The query name." tags: - "term_condition" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Finds the display customization TC of the account associated with the current user." operationId: "findDisplayCustomizationTC" /store/{storeId}/pointsOfInterest/byXPath: get: tags: - "pointofinterest_" operationId: "retrievePointsOfInterestByXPath" responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "xPath" in: "query" - required: false type: "string" name: "langId" in: "query" - required: false type: "string" name: "responseFormat" in: "query" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" /store/{storeId}/clientLocations/bySourceId/{sourceId}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "sourceId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by source Id." operationId: "retrieveClientLocationsBySourceId" /store/{storeId}/requisition_list: post: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListConfigurationAddResponse" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - enum: - "addConfiguration" name: "action" required: true in: "query" type: "string" description: "The action." - required: false in: "body" description: "The body data." name: "body" schema: $ref: "#/definitions/com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListConfigurationAddRequest" tags: - "requisition_list" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Add pre-configured dynamic kits or dynamic kit configurations to a requisition list." operationId: "addConfiguration" get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - enum: - "usable" name: "q" required: true in: "query" type: "string" description: "The query name." - required: false type: "string" description: "Order by." in: "query" name: "orderBy" - description: "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work." format: "int64" required: false in: "query" type: "integer" name: "pageNumber" - description: "Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The \"pageNumber\" must be specified for paging to work." format: "int64" required: false in: "query" type: "integer" name: "pageSize" tags: - "requisition_list" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Finds requisition lists that can be used by the current user." operationId: "findUsable" /store/{storeId}/pointOfInterest: post: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "pointofinterest" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" consumes: - "application/json" - "application/xml" operationId: "createPointOfInterest" /store/{storeId}/pointsOfInterest/byStatus/{status}: get: tags: - "pointofinterest_" operationId: "retrievePointsOfInterestByStatus" responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "status" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "langId" in: "query" - required: false type: "string" name: "responseFormat" in: "query" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" /store/{storeId}/member_group/{memberGroupId}: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.member.beans.MemberGroupListDataBean_IBM_Store_Summary" 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 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The member group ID." in: "path" name: "memberGroupId" tags: - "member_group" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Finds a member group by its ID." operationId: "findByMemberGroupId" /store/{storeId}/pointOfInterest/byProximity: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "langId" in: "query" - required: false type: "string" name: "latitude" in: "query" - required: false type: "string" name: "longitude" in: "query" - required: false type: "string" name: "poiType" in: "query" - required: false type: "string" name: "responseFormat" in: "query" tags: - "pointofinterest" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve the point of interest (POI) by proximity based on specified geolocation, POI type, and radius." operationId: "retrievePointOfInterestByProximity" /store/{storeId}/clientLocations/byRegionId/{regionId}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "regionId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by region Id." operationId: "retrieveClientLocationsByRegionId" /store/{storeId}/organization: post: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityIdentity" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" 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.OrganizationHandler$OrgEntityAddRequest" tags: - "organization" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "This 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.OrganizationHierarchyDataBean_IBM_Store_Summary" 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: "storeId" in: "path" name: "storeId" - enum: - "IBM_Store_Summary" name: "profileName" required: false in: "query" type: "string" description: "Profile name. Profiles determine the subset of data to be returned by a query." - enum: - "organizationHierarchy" name: "q" required: true in: "query" type: "string" description: "The query name." - required: true type: "string" description: "The Trading account Id." in: "query" name: "accountId" tags: - "organization" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Retrieves the Organization Hierarchy required by the Digital Analytics Integration." operationId: "getOrganizationHierarchy" /api/bundle/{resourceName}: 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." 403: description: "If API Discovery is disabled on the server." 500: description: "Internal server error. Additional details will be contained on the server logs." parameters: - required: true type: "string" description: "The name of the resource." in: "path" name: "resourceName" tags: - "api" produces: - "application/json" - "application/xml" summary: "Generate the default API resource bundle used for translation." operationId: "getResourceDescriptionBundle" description: "The output of this service call is the content of the english resource bundle." /store/{storeId}/switchContract/switchTo: put: 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" 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: - "switchContract" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Response the contract change action" operationId: "changeContract" /store/{storeId}/approval_status/{approvalStatusId}: post: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.rest.approvalstatus.handler.ApprovalStatusHandler$UpdateApprovalStatusResponse" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The approval status ID." in: "path" name: "approvalStatusId" - required: true in: "body" description: "The request body for updating an approval status record." name: "body" schema: $ref: "#/definitions/com.ibm.commerce.rest.approvalstatus.handler.ApprovalStatusHandler$UpdateApprovalStatusParameterDescription" tags: - "approval_status" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Updates the status to approve or reject and adds an optional comment to the approval status record." operationId: "updateApprovalStatus" get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.approval.beans.ApprovalStatusDataBean_IBM_Store_Summary" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The approval status ID." in: "path" name: "approvalStatusId" tags: - "approval_status" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Find an approval status record by its id." operationId: "findByApprovalStatusId" /store/{storeId}/ltpaidentity/@self: delete: tags: - "ltpa_identity" summary: "Logs out the user." 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" 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." operationId: "logout" /store/{storeId}/pointsOfInterest/byCellId/{cellId}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "cellId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "langId" in: "query" - required: false type: "string" name: "responseFormat" in: "query" tags: - "pointofinterest_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve points of interest (POI) by cell Id." operationId: "retrievePointsOfInterestByCellId" /store/{storeId}/clientLocations/byClientId/{clientId}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "clientId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by client Id." operationId: "retrieveClientLocationsByClientId" /api: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$ResourceLinkList" 400: description: "Bad request. Some of the inputs provided to the request aren't valid." 403: description: "If API Discovery is disabled on the server." 500: description: "Internal server error. Additional details will be contained on the server logs." parameters: - 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: - "api" produces: - "application/json" - "application/xml" summary: "Get the list of available resources on the server." operationId: "getResourceList" /store/{storeId}/clientLocations/byXPath: get: tags: - "clientlocation_" operationId: "retrieveClientLocationsByXPath" responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "xPath" in: "query" - required: false type: "string" name: "responseFormat" in: "query" produces: - "application/atom+xml" - "application/json" - "application/xml" /store/{storeId}/pointsOfInterest/byRegionId/{regionId}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "regionId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "langId" in: "query" - required: false type: "string" name: "responseFormat" in: "query" tags: - "pointofinterest_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve points of interest (POI) by region Id." operationId: "retrievePointsOfInterestByRegionId" /store/{storeId}/clientLocations/byPersonalizationId/{personalizationId}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "personalizationId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by personalization Id." operationId: "retrieveClientLocationsByPersonalizationId" /store/{storeId}/contract: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - enum: - "eligible" name: "q" required: true in: "query" type: "string" description: "The query name." tags: - "contract" produces: - "application/json" - "application/xml" - "application/atom+xml" - "application/xhtml+xml" summary: "Finds the contracts the current user is eligible to." operationId: "findEligible" /store/{storeId}/clientLocations/byTag/{tag}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "tag" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by tag." operationId: "retrieveClientLocationsByTag" /store/{storeId}/clientLocations/byCellId/{cellId}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "cellId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by cell Id." operationId: "retrieveClientLocationsByCellId" /store/{storeId}/ltpaidentity: post: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/com.ibm.commerce.rest.member.handler.LTPAIdentityHandler$UserIdentity" 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." 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" 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: "LTPA logon body." name: "body" schema: $ref: "#/definitions/com.ibm.commerce.rest.member.handler.LTPAIdentityHandler$LtpaLoginForm" tags: - "ltpa_identity" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Authenticates a user using an LTPA token." consumes: - "application/json" - "application/xml" operationId: "authenticate" /store/{storeId}/pointsOfInterest/byPOIType/{poiType}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "poiType" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "langId" in: "query" - required: false type: "string" name: "responseFormat" in: "query" tags: - "pointofinterest_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve points of interest (POI) by POI type." operationId: "retrievePointsOfInterestByPOIType" /store/{storeId}/contract/{contractId}: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The contract identifier." in: "path" name: "contractId" - enum: - "ARS" - "ATS" - "AUD" - "BEF" - "BRL" - "CAD" - "CHF" - "CNY" - "DEM" - "DKK" - "EGP" - "ESP" - "EUR" - "FIM" - "FRF" - "GBP" - "HKD" - "IEP" - "ITL" - "JPY" - "KRW" - "LUF" - "NLG" - "NOK" - "PLN" - "PTE" - "ROL" - "RON" - "RUB" - "SEK" - "SGD" - "TWD" - "USD" - "ZAR" name: "currency" required: false in: "query" type: "string" description: "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used." - enum: - "IBM_Contract_Detailed" name: "profileName" required: false in: "query" type: "string" description: "Profile name. Profiles determine the subset of data to be returned by a query." tags: - "contract" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Gets the contract details for a specific contract ID." operationId: "findByContractId" /store/{storeId}/member_group/member/{memberId}: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.member.beans.MemberGroupListDataBean_IBM_Store_Summary" 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 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The memberID." in: "path" name: "memberId" tags: - "member_group" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Finds a member group current shopper explicitly belongs." operationId: "findSelfMemberGroup" /store/{storeId}/approval_status: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.approval.beans.OrderApprovalStatusListDataBean_IBM_Store_Summary" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - enum: - "orderApprovals" name: "q" required: true in: "query" type: "string" description: "The query name." - required: false type: "string" description: "Query by approval request submitter's first name." in: "query" name: "submitterFirstName" - required: false type: "string" description: "Query by approval request submitter's middle name." in: "query" name: "submitterMiddleName" - required: false type: "string" description: "Query by approval request submitter's last name." in: "query" name: "submitterLastName" - description: "Query by approval request start time." format: "date" required: false in: "query" type: "string" name: "startSubmitTime" - description: "Query by approval request end time." format: "date" required: false in: "query" type: "string" name: "endSubmitTime" - description: "Query by approval request status." format: "int32" required: false in: "query" type: "integer" name: "status" - description: "Query by approval request approval status id." format: "int64" required: false in: "query" type: "integer" name: "approvalStatusId" - description: "Query by approval request entity id, such as order id." format: "int64" required: false in: "query" type: "integer" name: "entityId" - description: "Query by approver id. Only returns approval requests that can be approved by the current user." format: "int64" required: false in: "query" type: "integer" name: "approverId" - enum: - "A-approvalStatusId" - "A-entityId" - "A-submitTime" - "A-approveTime" - "A-status" - "A-flowTypeId" - "A-stateId" - "D-approvalStatusId" - "D-entityId" - "D-submitTime" - "D-approveTime" - "D-status" - "D-flowTypeId" - "D-stateId" name: "orderBy" required: false in: "query" type: "string" description: "Order by." - description: "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work." format: "int64" required: false in: "query" type: "integer" name: "pageNumber" - description: "Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The \"pageNumber\" must be specified for paging to work." format: "int64" required: false in: "query" type: "integer" name: "pageSize" tags: - "approval_status" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Finds order approval status records available to the current user." operationId: "findOrderApprovals" /store/{storeId}/clientLocations/byPointOfInterestId/{pointOfInterestId}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "pointOfInterestId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by point of interest Id." operationId: "retrieveClientLocationsByPointOfInterestId" /store/{storeId}/activity: 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." 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - enum: - "getEmailActivityDetailsByEmailPromotionId" name: "q" required: true in: "query" type: "string" description: "The query name." tags: - "activity" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Gets the activity list by query type and parameters." operationId: "findByQuery" /store/{storeId}/term_condition/{termConditionId}: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The term condition ID." in: "path" name: "termConditionId" tags: - "term_condition" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Finds a term condition by its ID." operationId: "findByTermConditionId" /store/{storeId}/activity/urls: 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." 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: false type: "string" name: "emailPromotionId" in: "query" - required: false type: "string" name: "urlHeader" in: "query" - required: false type: "string" name: "userId" in: "query" - required: false type: "string" name: "optOutForwardUrl" in: "query" - required: false type: "string" name: "clickedEventUrl" in: "query" tags: - "activity" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Resolve email activity urls" operationId: "resolveEmailActivityUrl" /store/{storeId}/clientLocations/bySourceType/{sourceType}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "sourceType" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by source type." operationId: "retrieveClientLocationsBySourceType" /store/{storeId}/wcidentity: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/java.lang.String" 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." 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" 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: - "wc_identity" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Invoke tWAS OIDC interceptor for WC, and once WC authenticates with Blue ID and creates an LTPA token, redirect back to the CI referrer login servlet." operationId: "response" /store/{storeId}/file_upload_job/{fileUploadJobId}: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/file_upload_job-IBM_Store_Summary" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The file upload job ID." in: "path" name: "fileUploadJobId" - enum: - "-1" - "-2" - "-3" - "-4" - "-5" - "-6" - "-7" - "-8" - "-9" - "-10" - "-20" - "-21" - "-22" - "-23" name: "langId" required: false in: "query" type: "string" description: "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" isn't specified, then the store default language shall be used." - enum: - "en_US" - "fr_FR" - "de_DE" - "it_IT" - "es_ES" - "pt_BR" - "zh_CN" - "zh_TW" - "ko_KR" - "ja_JP" - "ru_RU" - "ro_RO" - "pl_PL" - "ar_EG" name: "locale" required: false in: "query" type: "string" description: "The locale to use. Example usage : locale=en_US. If the \"langId\" parameter is specified, the \"locale\" parameter will be ignored. If no locale is specified, the store default locale will be used." - required: false type: "string" description: "Name of the workspace to use for the request." in: "query" name: "workspace.name" - required: false type: "string" description: "Identifier of the workspace task to use for the request." in: "query" name: "workspace.task" - required: false type: "string" description: "Identifier of the workspace task group to use for the request." in: "query" name: "workspace.taskGroup" - required: false type: "string" description: "User identifier to act on behalf of." in: "query" name: "forUserId" - required: false type: "string" description: "User name to act on behalf of." in: "query" name: "forUser" - 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: - "file_upload_job" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Finds a file upload job by its ID." operationId: "findByFileUploadJobId" /store/{storeId}/clientLocations: get: tags: - "clientlocation_" operationId: "retrieveClientLocations" responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" /store/{storeId}/pointOfInterest/{pointOfInterestId}: put: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "pointOfInterestId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "path" in: "query" - required: false type: "string" name: "operation" in: "query" - required: false type: "string" name: "responseFormat" in: "query" tags: - "pointofinterest" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" consumes: - "application/json" - "application/xml" operationId: "updatePointOfInterestById" get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "storeId" in: "path" - required: true type: "string" name: "pointOfInterestId" in: "path" - required: false type: "string" name: "langId" in: "query" - required: false type: "string" name: "responseFormat" in: "query" tags: - "pointofinterest" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve the point of interest (POI) by the point of interest Id." operationId: "retrievePointOfInterestById" delete: tags: - "pointofinterest" operationId: "deletePointOfInterestById" responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "pointOfInterestId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" /store/{storeId}/pointsOfInterest: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "langId" in: "query" - required: false type: "string" name: "responseFormat" in: "query" tags: - "pointofinterest_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve all points of interest." operationId: "retrievePointsOfInterest" /store/{storeId}/merchant/validate: post: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/java.lang.String" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" 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: "The request object for merchant validation." name: "body" schema: $ref: "#/definitions/com.ibm.commerce.rest.order.handler.MerchantHandler$MerchantValidationBodyDescription" tags: - "order_" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Performs the merchant validation" operationId: "performMerchantValidation" /store/{storeId}/merchant: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/java.lang.String" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The payment system which is used for ApplePay" in: "query" name: "paymentSystem" - required: true type: "string" description: "The payment configuration group" in: "query" name: "paymentConfigGroup" - 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: - "order_" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Gets the merchant info" operationId: "getMerchantInfo" /store/{storeId}/clientLocations/byStatus/{status}: get: tags: - "clientlocation_" operationId: "retrieveClientLocationsByStatus" responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "status" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" /store/{storeId}/switchOrganization/switchTo: put: 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" 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: - "switchOrganization" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Response the organization change action" operationId: "changeOrganization" /store/{storeId}/contentUrl: 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" 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: - "contentUrl" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Response the content url resolved values" operationId: "resolveContentUrl" /store/{storeId}/feature: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.rest.config.FeatureHandler$FeatureResponse" 500: description: "Internal server error. Additional details will be contained on the server logs." parameters: - enum: - "0" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." tags: - "feature" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Finds all features supported." operationId: "findAll" /store/{storeId}/aggregate: 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." 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: true type: "string" description: "The query name." in: "query" name: "q" tags: - "aggregate" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Finds an aggregate by a query." operationId: "findByQuery" /store/{storeId}/ibmididentity/@self: delete: tags: - "ibmid_identity" summary: "Logs out the user." 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" 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." operationId: "logout" /store/{storeId}/access_control/byUserIdAndViewId: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.acc.beans.AllowUserToAccessViewDataBean" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" 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 type: "string" description: "Profile name. Profiles determine the subset of data to be returned by a query." in: "query" name: "profileName" tags: - "access_control_for_view" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "By default, this API check if this user is allowed to access this view." operationId: "checkAccessByUserAndView" /store/{storeId}/clientLocations/byAction/{action}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "action" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by action." operationId: "retrieveClientLocationsByAction" /store/{storeId}/clientLocation: post: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Create a client location." consumes: - "application/json" - "application/xml" operationId: "createClientLocation" /store/{storeId}/clientLocations/byDeviceId/{deviceId}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "deviceId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by device Id." operationId: "retrieveClientLocationsByDeviceId" /store/{storeId}/pointsOfInterest/byProximity: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "langId" in: "query" - required: false type: "string" name: "latitude" in: "query" - required: false type: "string" name: "longitude" in: "query" - required: false type: "string" name: "radius" in: "query" - required: false type: "string" name: "poiType" in: "query" - required: false type: "string" name: "responseFormat" in: "query" tags: - "pointofinterest_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve points of interest (POI) by proximity based on specified geolocation, POI type, and radius." operationId: "retrievePointsOfInterestByProximity" /store/{storeId}/member_group: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.approval.beans.ApprovalGroupTypeListBean_IBM_Store_Summary" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - required: false type: "string" description: "Properties value based on which approval member groups will be filtered." in: "query" name: "propertiesFilter" - enum: - "approvalMemberGroupTypes" name: "q" required: true in: "query" type: "string" description: "The query name." tags: - "member_group" produces: - "application/json" - "application/xml" - "application/atom+xml" - "application/xhtml+xml" summary: "Finds approval member groups types for an organization based on properties filter." operationId: "findApprovalMemberGroupTypes" /api/resource/{resourceName}: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$ResourceDescription" 400: description: "Bad request. Some of the inputs provided to the request aren't valid." 403: description: "If API Discovery is disabled on the server." 500: description: "Internal server error. Additional details will be contained on the server logs." parameters: - required: true type: "string" description: "The name of the resource." in: "path" name: "resourceName" - 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: - "api" produces: - "application/json" - "application/xml" summary: "Describe the APIs available on a resource by name." operationId: "getResourceDescription" /store/{storeId}/clientLocations/byClientType/{clientType}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "clientType" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by client type." operationId: "retrieveClientLocationsByClientType" /store/{storeId}/clientLocation/{clientLocationId}: put: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "clientLocationId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "path" in: "query" - required: false type: "string" name: "operation" in: "query" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" consumes: - "application/json" - "application/xml" operationId: "updateClientLocationById" get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "clientLocationId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve a client locatoin by client location Id." operationId: "retrieveClientLocationById" delete: tags: - "clientlocation" operationId: "deleteLocationById" responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "clientLocationId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" /store/{storeId}/pointsOfInterest/byZoneId/{zoneId}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "zoneId" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "langId" in: "query" - required: false type: "string" name: "responseFormat" in: "query" tags: - "pointofinterest_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve points of interest (POI) by zone Id." operationId: "retrievePointsOfInterestByZoneId" /store/{storeId}/file_upload_job: get: responses: 200: description: "The requested completed successfully." schema: $ref: "#/definitions/file_upload_job-IBM_Store_Summary" 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" - "715837884" - "715837934" - "715837984" - "715838034" - "715838084" - "715838085" - "715838584" - "715839084" - "715839134" - "715839184" name: "storeId" required: true in: "path" type: "string" description: "The store identifier." - enum: - "byNumberOfDaysAndUploadType" name: "q" required: true in: "query" type: "string" description: "The query name." - required: true type: "string" description: "Returns the file upload jobs loaded later than the specified number days from current date" in: "query" name: "numberOfDays" - required: true type: "string" description: "Returns the file upload jobs of the specified upload type, for example, RequisitionListUpload" in: "query" name: "uploadType" - enum: - "-1" - "-2" - "-3" - "-4" - "-5" - "-6" - "-7" - "-8" - "-9" - "-10" - "-20" - "-21" - "-22" - "-23" name: "langId" required: false in: "query" type: "string" description: "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" isn't specified, then the store default language shall be used." - enum: - "en_US" - "fr_FR" - "de_DE" - "it_IT" - "es_ES" - "pt_BR" - "zh_CN" - "zh_TW" - "ko_KR" - "ja_JP" - "ru_RU" - "ro_RO" - "pl_PL" - "ar_EG" name: "locale" required: false in: "query" type: "string" description: "The locale to use. Example usage : locale=en_US. If the \"langId\" parameter is specified, the \"locale\" parameter will be ignored. If no locale is specified, the store default locale will be used." - required: false type: "string" description: "Name of the workspace to use for the request." in: "query" name: "workspace.name" - required: false type: "string" description: "Identifier of the workspace task to use for the request." in: "query" name: "workspace.task" - required: false type: "string" description: "Identifier of the workspace task group to use for the request." in: "query" name: "workspace.taskGroup" - required: false type: "string" description: "User identifier to act on behalf of." in: "query" name: "forUserId" - required: false type: "string" description: "User name to act on behalf of." in: "query" name: "forUser" - 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: - "file_upload_job" produces: - "application/json" - "application/xml" - "application/xhtml+xml" - "application/atom+xml" summary: "Finds the file upload jobs in recent specified days by upload type." operationId: "byNumberOfDaysAndUploadType" /store/{storeId}/clientLocations/byPOIType/{poiType}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "poiType" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "responseFormat" in: "query" tags: - "clientlocation_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve client locations by point of interest type." operationId: "retrieveClientLocationsByPOIType" /store/{storeId}/pointsOfInterest/byTag/{tag}: get: responses: 200: description: "No response was specified" schema: $ref: "#/definitions/Empty" parameters: - required: true type: "string" name: "tag" in: "path" - required: true type: "string" name: "storeId" in: "path" - required: false type: "string" name: "langId" in: "query" - required: false type: "string" name: "responseFormat" in: "query" tags: - "pointofinterest_" produces: - "application/atom+xml" - "application/json" - "application/xml" - "application/xhtml+xml" summary: "Retrieve points of interest (POI) by tags. It will return the POIs whose tag contains the specified string." operationId: "retrievePointsOfInterestByTag" definitions: store-OnlineStoreSupportedLanguagesType: properties: defaultLanguageId: type: "string" supportedLanguages: items: type: "string" type: "array" com.ibm.commerce.rest.api.handler.ApiHandler$ResourceLinkList: required: - "apiVersion" - "apis" - "swaggerVersion" description: "List of resource links and their description." properties: swaggerVersion: type: "string" description: "Version of the Swagger specification." apiVersion: type: "string" description: "Version of the API." apis: items: $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$ResouceLink" type: "array" description: "List of links to available resources." com.ibm.commerce.rest.api.handler.ApiHandler$ModelDescriptionContainer: description: "This object lists the models used by the operations. Each model is contained in a property where the property name matches the name of the model." properties: sample: description: "Sample model description." $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$ModelDescription" com.ibm.commerce.rest.api.handler.ApiHandler$ModelPropertyDescriptionContainer: required: - "sample" description: "This object lists the \"model property descriptions\" used by the model. Each \"model property description\" is contained in a property where the property name matches the name of the \"model property\"." properties: sample: description: "Sample model property description." $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$ModelPropertyDescription" com.ibm.commerce.rest.api.handler.ApiHandler$OperationDescription: required: - "method" description: "Description of an operation." properties: secureCallMandatory: type: "boolean" description: "This flag indicates if the use of Secure HTTP (HTTPS) is mandatory to call this API. This is an application specific extension to the swagger specification." errorResponses: items: $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$ErrorResponseDescription" type: "array" description: "List of potential errors returned by this API." parameters: items: $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$OperationParameterDescription" type: "array" description: "List parameters used by the operation." produces: items: type: "string" type: "array" description: "List the types of data that can be used in the \"accept\" HTTP header." type: type: "string" description: "Name of the model returned by this opeartion." notes: type: "string" description: "Detailed utilisation notes applicable to the operations." partialAuthenticationAllowed: type: "boolean" description: "This flag indicates if partially authenticated users are allowed to call this API. This is an application specific extension to the swagger specification." method: type: "string" description: "HTTP method used to perform the operation." summary: type: "string" description: "Summary description of the operation." nickname: type: "string" description: "Short nickname for the operation." consumes: items: type: "string" type: "array" description: "List the types of data that can be used in the \"content-type\" HTTP header." file_upload_job-IBM_Store_Summary: properties: recordSetCount: type: "integer" format: "int64" recordSetComplete: type: "boolean" recordSetStartNumber: type: "integer" format: "int64" resultList: items: $ref: "#/definitions/file_upload_job-IBM_Store_Summary_item" type: "array" recordSetTotal: type: "integer" format: "int64" com.ibm.commerce.rest.approvalstatus.handler.ApprovalStatusHandler$UpdateApprovalStatusParameterDescription: required: - "aprv_act" description: "Description of the post input body to update an approval status record." properties: comments: type: "string" description: "Comment text for status change." aprv_act: enum: - "1" - "2" type: "string" description: "Approval status. Valid values are 1 for approve and 2 for reject." com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListDeleteResponse: {} file_upload_job-IBM_Store_Summary_item.processFile: properties: status: enum: - "New" - "Processing" - "Complete" - "Failed" - "Cancelled" - "Partially Complete" type: "string" endTime: type: "string" startTime: type: "string" com.ibm.commerce.rest.approvalstatus.handler.ApprovalStatusHandler$UpdateApprovalStatusResponse: description: "Description of approval status record update response." properties: resultmsg: type: "string" description: "Update approval status message." com.ibm.commerce.rest.api.handler.ApiHandler$ApiDescription: required: - "path" description: "Description of an API and its operations." properties: operations: items: $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$OperationDescription" type: "array" description: "List of available operations." path: type: "string" description: "URL path fragment to readh the API. This is appended to the resource basepath." description: type: "string" description: "API description." store-OnlineStoreUserDataType.userDataField: required: - "key" properties: value: type: "string" key: type: "string" com.ibm.commerce.rest.api.handler.ApiHandler$OperationParameterDescription: required: - "name" - "paramType" - "type" description: "Description of an operation parameter." properties: required: type: "boolean" description: "Is the parameter required or not." description: type: "string" description: "Description of the parameter." format: type: "string" description: "Format of the data. This is a swagger specific extension that adds rules to the type. Sample values include \"int32\" and \"int64\" for the integer type." allowMultiple: type: "boolean" description: "For query parameters, this indicates if the parameter may be repeated multiple times. Defaults to false." enum: items: type: "string" type: "array" description: "List of acceptable values. Only defined if the acceptable values are limited." type: type: "string" description: "Type of the field. Must match one of the JSON-Schema supported types. Can be used to reference a model." paramType: enum: - "query" - "path" - "body" - "header" type: "string" description: "Type of parameter. Either a URL \"query\", a URL \"path\", request \"header\" or a request \"body\"." name: type: "string" description: "Name of the parameter" com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary: properties: recordSetCount: type: "integer" format: "int32" recordSetCompleteIndicator: type: "boolean" recordSetStartNumber: type: "integer" format: "int32" resultList: items: $ref: "#/definitions/com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary.resultList" type: "array" recordSetTotal: type: "integer" format: "int32" com.ibm.commerce.user.beans.OrganizationHierarchyDataBean_IBM_Store_Summary: properties: organizationHierarchy: $ref: "#/definitions/com.ibm.commerce.user.beans.OrganizationHierarchyDataBean_IBM_Store_Summary.organizationHierarchy" store-OnlineStoreUserDataType: properties: userDataField: items: $ref: "#/definitions/store-OnlineStoreUserDataType.userDataField" type: "array" store-OnlineStoreRelatedStoresType: properties: relationshipSequence: type: "string" relationshipType: type: "string" relatedStoreId: type: "string" state: type: "string" com.ibm.commerce.rest.api.handler.ApiHandler$ModelPropertyDescription: description: "Description of a property used in a model." properties: items: description: "If the \"type\" is set to \"array\", this field will describe the objects contained within the array." $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$ModelPropertyDescription" type: type: "string" description: "Type of property. Only defined when the property is a basic types. References to other models will use the \"$ref\" value." enum: items: type: "string" type: "array" description: "Defines the list of acceptable values for the field. Only present if specific values must be used." ref: type: "string" description: "Name of a \"model\" used by the property." required: type: "boolean" description: "Indicates if the property must always be present in the model." java.lang.String: {} com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details: properties: termConditionId: type: "string" XMLString: type: "string" timeCreated: type: "string" changeableFlag: type: "integer" format: "int32" tcSequence: type: "integer" format: "int32" mandatoryFlag: type: "integer" format: "int32" participants: items: $ref: "#/definitions/com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details.participants" type: "array" tcSubType: type: "string" policies: items: $ref: "#/definitions/com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details.policies" type: "array" timeUpdated: type: "string" tradingId: type: "string" Empty: description: "Empty model. Used as default value when no model is specified." com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details.participants: properties: termConditionId: type: "integer" format: "int64" participantId: type: "integer" format: "int64" timeCreated: type: "string" format: "date" information: type: "string" roleId: type: "integer" format: "int32" memberId: type: "integer" format: "int64" timeUpdated: type: "string" format: "date" tradingId: type: "integer" format: "int64" com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListUpdateRequest: properties: status: type: "string" description: "Distinguishes between a private requisition list and a shared requisition list. The default is Y for a private requisition list. Z indicates a shared requisition list." billtoAddressId: type: "string" description: "The billing address identification." name: type: "string" description: "The name of the requisition list." com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed.TCs: properties: tcSubType: type: "string" priceListIds: items: type: "integer" format: "int64" type: "array" XMLString: type: "string" timeCreated: type: "string" format: "date" referenceNumber: type: "integer" format: "int64" changeableFlag: type: "integer" format: "int32" percentagePriceListIds: items: type: "integer" format: "int64" type: "array" tcSequence: type: "integer" format: "int32" participants: items: $ref: "#/definitions/com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed.TCs.participants" type: "array" exclusionProductSets: items: type: "integer" format: "int32" type: "array" mandatoryFlag: type: "integer" format: "int32" entireCatalogSelected: type: "integer" format: "int32" policies: items: $ref: "#/definitions/com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed.TCs.policies" type: "array" timeUpdated: type: "string" format: "date" inclusionProductSets: items: type: "integer" format: "int32" type: "array" productSetId: type: "integer" format: "int32" tradingId: type: "integer" format: "int64" entireCatalogAdjustment: type: "number" format: "double" priceListId: type: "integer" format: "int64" store-OnlineStoreDescriptionType: properties: displayName: type: "string" description: type: "string" languageId: type: "string" com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed.TCs.participants: properties: information: type: "string" participantId: type: "integer" format: "int64" timeCreated: type: "string" format: "date" roleId: type: "integer" format: "int32" memberId: type: "integer" format: "int64" timeUpdated: type: "string" format: "date" tcId: type: "integer" format: "int64" tradingId: type: "integer" format: "int64" com.ibm.commerce.approval.beans.OrderApprovalStatusListDataBean_IBM_Store_Summary: properties: recordSetCount: type: "integer" format: "int32" recordSetCompleteIndicator: type: "boolean" recordSetStartNumber: type: "integer" format: "int32" resultList: items: $ref: "#/definitions/com.ibm.commerce.approval.beans.OrderApprovalStatusListDataBean_IBM_Store_Summary.resultList" type: "array" recordSetTotal: type: "integer" format: "int32" com.ibm.commerce.member.beans.MemberGroupListDataBean_IBM_Store_Summary.resultList: properties: ownerId: type: "string" description: type: "string" name: type: "string" memberGroupId: type: "integer" format: "int64" com.ibm.commerce.rest.api.handler.ApiHandler$ModelDescription: required: - "id" description: "Model description." properties: properties: description: "List of properties in the model." $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$ModelPropertyDescriptionContainer" description: type: "string" description: "Description of the model." id: type: "string" description: "Name of the model." com.ibm.commerce.rest.api.handler.ApiHandler$ResouceLink: required: - "path" description: "Link and description of a resource." properties: path: type: "string" description: "URL where the API meta-data may be reached." description: type: "string" description: "Description of the resource." com.ibm.commerce.user.beans.OrganizationHierarchyDataBean_IBM_Store_Summary.organizationHierarchy: {} com.ibm.commerce.rest.order.handler.MerchantHandler$MerchantValidationBodyDescription: required: - "paymentConfigGroup" - "paymentSystem" - "validationURL" description: "Description of the merchant validation input body." properties: paymentSystem: type: "string" description: "Payment system ." validationURL: type: "string" description: "Validation url." paymentConfigGroup: type: "string" description: "Payment configuraiton group." com.ibm.commerce.approval.beans.ApprovalGroupTypeListBean_IBM_Store_Summary.resultList: properties: memberGroupTypeId: type: "string" properties: type: "string" description: type: "string" name: type: "string" com.ibm.commerce.tools.contract.beans.DisplayCustomizationTCDataBean_IBM_Store_Details: properties: languageId: type: "integer" format: "int32" hasDisplayText: type: "boolean" storeId: type: "integer" format: "int32" userId: type: "integer" format: "int64" hasDisplayLogo: type: "boolean" displayText: items: type: "string" type: "array" accountId: type: "integer" format: "int64" attachmentURL: items: type: "string" type: "array" com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.userData: properties: userDataField: items: $ref: "#/definitions/com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.userData.userDataField" type: "array" file_upload_job-FileInfo: required: - "fileName" properties: fileEncoding: type: "string" filePath: type: "string" fileSize: type: "integer" format: "int64" fileName: type: "string" com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.storeIdentifier.externalIdentifier: properties: ownerID: type: "string" nameIdentifier: type: "string" com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListConfigurationAddRequest: required: - "quantity" properties: status: type: "string" description: "The status of the requisition list." name: type: "string" description: "The name of the requisition list." catEntryId: type: "string" description: "The catalog entry id of the dynamic kit or predefined dynamic kit." requisitionListId: type: "string" description: "The ID of the requisition list." configurationXML: type: "string" description: "Tthe BOM XML to describe the configuration of the dynamic kit or predefined dynamic kit." partNumber: type: "string" description: "The part number of the dynamic kit or predefined dynamic kit." type: type: "string" description: "The type of the requisition list." quantity: type: "string" description: "The quantity of the dynamic kit or predefined dynamic kit." com.ibm.commerce.rest.api.handler.ApiHandler$ResourceDescription: required: - "apiVersion" - "basePath" - "swaggerVersion" description: "Description of a resource and its APIs." properties: description: type: "string" description: "Resource description." swaggerVersion: type: "string" description: "Version of the Swagger specification." apis: items: $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$ApiDescription" type: "array" description: "List of available APIs." models: description: "List of models used by the APIs." $ref: "#/definitions/com.ibm.commerce.rest.api.handler.ApiHandler$ModelDescriptionContainer" basePath: type: "string" description: "URL at which the resource may be reached. Used as a base for contained APIs." resourcePath: type: "string" description: "Resource path." apiVersion: type: "string" description: "Version of the API." com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.catalogIdentifier: properties: uniqueID: type: "string" externalIdentifier: $ref: "#/definitions/com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.catalogIdentifier.externalIdentifier" file_upload_job-UploadFile: properties: userName: type: "string" uploadTime: type: "string" fileInfo: $ref: "#/definitions/file_upload_job-FileInfo" properties: items: $ref: "#/definitions/file_upload_job-FileProperty" type: "array" com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details.policies: properties: startDate: type: "string" format: "date" endDate: type: "string" format: "date" policyName: type: "string" storeId: type: "integer" format: "int32" policyId: type: "integer" format: "int64" ownerId: type: "integer" format: "int64" type: type: "string" properties: type: "string" store-store: properties: recordSetCount: type: "integer" format: "int64" recordSetComplete: type: "boolean" recordSetStartNumber: type: "integer" format: "int64" resultList: items: $ref: "#/definitions/store-store_item" type: "array" recordSetTotal: type: "integer" format: "int64" com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType: properties: storeIdentifier: $ref: "#/definitions/com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.storeIdentifier" catalogIdentifier: $ref: "#/definitions/com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.catalogIdentifier" uniqueID: type: "string" userData: $ref: "#/definitions/com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.userData" 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.order.beans.RequisitionListDataBean_IBM_Store_Summary.resultList.userRegistration: properties: middleName: type: "string" lastName: type: "string" firstName: type: "string" com.ibm.commerce.acc.beans.AllowUserToAccessViewDataBean: {} com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.catalogIdentifier.externalIdentifier.storeIdentifier: properties: uniqueID: type: "string" externalIdentifier: $ref: "#/definitions/com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" com.ibm.commerce.rest.config.FeatureHandler$FeatureResponse$ResultList: required: - "enabled" - "name" - "version" description: "Feature result list body." properties: version: type: "string" description: "The version of the feature" enabled: type: "string" description: "Whether or not the feature is enabled" name: type: "string" description: "The name of the feature" store-OnlineStoreSupportedCurrenciesType: properties: supportedCurrencies: items: type: "string" type: "array" defaultCurrency: type: "string" file_upload_job-FileProperty: properties: value: type: "string" store-AddressType: properties: city: type: "string" zipOrPostalCode: type: "string" addressLine: items: type: "string" type: "array" stateOrProvinceName: type: "string" country: type: "string" com.ibm.commerce.rest.api.handler.ApiHandler$ErrorResponseDescription: required: - "code" description: "Description of a potential error response." properties: reason: type: "string" description: "The reason why this code might be returned." code: type: "string" description: "The HTTP code returned from the request." store-ContactInfoIdentifierType: required: - "contactPersonNickName" properties: contactInfoId: type: "string" contactPersonId: type: "string" contactPersonNickName: type: "string" com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed: properties: origin: type: "integer" format: "int32" minorVersion: type: "integer" format: "int32" timeApproved: type: "string" format: "date" referenceNumber: type: "integer" format: "int64" markForDelete: type: "integer" format: "int32" timeActivated: type: "string" format: "date" owner: type: "integer" format: "int64" accountId: type: "integer" format: "int64" dataBeanKeyReferenceNumber: type: "string" referredTradingAgreementId: type: "integer" format: "int64" timeDeployed: type: "string" format: "date" comments: type: "string" TCs: items: $ref: "#/definitions/com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed.TCs" type: "array" state: type: "integer" format: "int32" usage: type: "integer" format: "int32" storeXMLDefinition: type: "string" majorVersion: type: "integer" format: "int32" ownerReferenceNumber: type: "integer" format: "int64" timeCreated: type: "string" format: "date" contractLevelParticipants: items: $ref: "#/definitions/com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed.contractLevelParticipants" type: "array" timeUpdated: type: "string" format: "date" storeXMLString: type: "string" name: type: "string" familyId: type: "integer" format: "int64" com.ibm.commerce.approval.beans.ApprovalStatusDataBean_IBM_Store_Summary: 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.contract.beans.ContractDataBean_IBM_Contract_Detailed.contractLevelParticipants: properties: information: type: "string" participantId: type: "integer" format: "int64" timeCreated: type: "string" format: "date" roleId: type: "integer" format: "int32" memberId: type: "integer" format: "int64" timeUpdated: type: "string" format: "date" tcId: type: "integer" format: "int64" tradingId: type: "integer" format: "int64" com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListSubmitResponse: properties: orderId: type: "string" description: "The ID of the order." store-OnlineStoreContactInfoType: required: - "emailAddress1" - "emailAddress2" - "fax1" - "fax2" - "telephone1" - "telephone2" properties: telephone2: type: "string" telephone1: type: "string" languageId: type: "string" address: $ref: "#/definitions/store-AddressType" contactPersonBusinessTitle: type: "string" emailAddress1: type: "string" fax2: type: "string" fax1: type: "string" emailAddress2: type: "string" contactInfoIdentifier: $ref: "#/definitions/store-ContactInfoIdentifierType" com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListSubmitRequest: properties: offerId: items: type: "string" type: "array" description: "A list of IDs of the offers associated with the order. This parameter can be repeated." contractId: items: type: "string" type: "array" description: "A list of IDs of contracts associated with the order. This parameter can be repeated." file_upload_job-IBM_Store_Summary_item.userDataField: required: - "key" properties: value: type: "string" key: type: "string" com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed.TCs.policies: properties: policyName: type: "string" endDate: type: "string" format: "date" startDate: type: "string" format: "date" storeEntityId: type: "integer" format: "int32" policyId: type: "integer" format: "int64" owner: type: "integer" format: "int64" type: type: "string" properties: type: "string" com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListConfigurationAddResponse: {} com.ibm.commerce.approval.beans.ApprovalGroupTypeListBean_IBM_Store_Summary: properties: resultList: items: $ref: "#/definitions/com.ibm.commerce.approval.beans.ApprovalGroupTypeListBean_IBM_Store_Summary.resultList" type: "array" com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListUpdateResponse: {} com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListDeleteRequest: {} com.ibm.commerce.rest.member.handler.LTPAIdentityHandler$UserIdentity: required: - "WCToken" - "WCTrustedToken" - "personalizationID" - "userId" description: "Information about a guest user identity." properties: userId: type: "string" description: "The user unique identifier." WCToken: type: "string" description: "The token used for authentication." WCTrustedToken: type: "string" description: "The trusted token used for authentication. This token should only be used on encrypted channels." personalizationID: type: "string" description: "The personalization identifier for the current session." com.ibm.commerce.member.beans.MemberGroupListDataBean_IBM_Store_Summary: properties: recordSetCount: type: "integer" format: "int32" recordSetCompleteIndicator: type: "boolean" recordSetStartNumber: type: "integer" format: "int32" resultList: items: $ref: "#/definitions/com.ibm.commerce.member.beans.MemberGroupListDataBean_IBM_Store_Summary.resultList" type: "array" recordSetTotal: type: "integer" format: "int32" 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.SAMLIdentityHandler$SAMLIdentity: required: - "SAMLResponse" description: "The SAML Response." properties: SAMLResponse: type: "string" description: "The SAML Response in Base64 format." com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: properties: ownerID: type: "string" nameIdentifier: type: "string" com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary.resultList: properties: comment: type: "string" lastUpdate: type: "string" format: "date" description: type: "string" organizationId: type: "string" userRegistration: $ref: "#/definitions/com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary.resultList.userRegistration" storeId: type: "string" memberId: type: "string" orderId: type: "string" status: type: "string" 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 will be 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 will be 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." preferredDelivery: type: "string" description: "The registrant's preferred mode of delivery." 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." administratorMiddleName: type: "string" description: "The middle name of the administrator." taxPayerId: type: "string" description: "The ID for the tax payer." 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." 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." organizationName: type: "string" description: "The name of the organization that the registrant represents." firstName: type: "string" description: "The first name of the registrant." businessCategory: type: "string" description: "Describes the kind of business performed by an organization or organizational unit." 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 will be 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." 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." 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.LTPAIdentityHandler$LtpaLoginForm: required: - "LTPAToken" description: "Information required to authenticate a user using LTPA." properties: LTPAToken: type: "string" description: "The LTPA token." com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.catalogIdentifier.externalIdentifier: required: - "identifier" properties: ownerID: type: "string" identifier: type: "string" storeIdentifier: $ref: "#/definitions/com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.catalogIdentifier.externalIdentifier.storeIdentifier" com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.userData.userDataField: required: - "key" properties: value: type: "string" key: type: "string" com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.storeIdentifier: properties: uniqueID: type: "string" externalIdentifier: $ref: "#/definitions/com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType.storeIdentifier.externalIdentifier" file_upload_job-IBM_Store_Summary_item: properties: uploadFile: $ref: "#/definitions/file_upload_job-UploadFile" uploadType: type: "string" fileUploadJobId: type: "string" storeId: type: "string" processFile: items: $ref: "#/definitions/file_upload_job-IBM_Store_Summary_item.processFile" type: "array" userDataField: items: $ref: "#/definitions/file_upload_job-IBM_Store_Summary_item.userDataField" type: "array" com.ibm.commerce.rest.config.FeatureHandler$FeatureResponse: description: "Body of a response to get all features." properties: resultList: items: $ref: "#/definitions/com.ibm.commerce.rest.config.FeatureHandler$FeatureResponse$ResultList" type: "array" description: "Features supported" store-store_item: properties: userData: $ref: "#/definitions/store-OnlineStoreUserDataType" contactInfo: items: $ref: "#/definitions/store-OnlineStoreContactInfoType" type: "array" description: items: $ref: "#/definitions/store-OnlineStoreDescriptionType" type: "array" relatedStores: items: $ref: "#/definitions/store-OnlineStoreRelatedStoresType" type: "array" storeId: type: "string" locationInfo: items: $ref: "#/definitions/store-OnlineStoreContactInfoType" type: "array" defaultCatalog: items: $ref: "#/definitions/com.ibm.commerce.infrastructure.facade.datatypes.DefaultCatalogType" type: "array" state: type: "string" supportedCurrencies: $ref: "#/definitions/store-OnlineStoreSupportedCurrenciesType" ownerId: type: "string" storeType: type: "string" identifier: type: "string" supportedLanguages: $ref: "#/definitions/store-OnlineStoreSupportedLanguagesType"