A term or condition of an account or contract.
com.ibm.commerce.rest.contract.handler.TermConditionHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/term_condition?q={q} | Finds terms and conditions by a query. See each query for details on input and output. |
GET | /store/{storeId}/term_condition?q=displayCustomizationTC | Finds the display customization TC of the account associated with the current user. |
GET | /store/{storeId}/term_condition/{termConditionId} | Finds a term condition by its ID. |
Finds terms and conditions by a query. See each query for details on input and output.
findByQuery
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Finds the display customization TC of the account associated with the current user.
findDisplayCustomizationTC
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.tools.contract.beans.DisplayCustomizationTCDataBean_IBM_Store_Details
GET /wcs/resources/store/10801/term_condition?q=displayCustomizationTC
200
{ "resultList": [ { "accountId": 10022, "attachmentURL": [ "", "images\/logoAccount1.gif" ], "displayText": [ "" ], "hasDisplayLogo": true, "hasDisplayText": false, "languageId": -1, "storeId": 10801, "userId": -1004 } ] }
Finds a term condition by its ID.
findByTermConditionId
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
termConditionId | The term condition ID. | path | string | true | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details
GET /wcs/resources/store/10001/term_condition/10003
200
{ "resultList": [ { "XMLString": " <TermCondition type = \"CatalogFilterTC\" mandatory = \"false\" changeable = \"false\" >\r\n <Property name = \"catalogFilterId\" value = \"10001\" \/>\r\n <\/TermCondition>\r\n", "changeableFlag": 0, "mandatoryFlag": 0, "participants": [ ], "policies": [ ], "tcSequence": 3, "tcSubType": "CatalogFilterTC", "termConditionId": "10003", "timeCreated": "2014-10-29 19:06:18.884", "timeUpdated": "2014-10-29 19:06:18.884", "tradingId": "10001" } ] }
Name | Data Type | Required |
---|---|---|
tcSequence | string | false |
policies | com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details.policies array | false |
participants | com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details.participants array | false |
mandatoryFlag | string | false |
changeableFlag | string | false |
XMLString | string | false |
termConditionId | string | false |
timeCreated | string | false |
tcSubType | string | false |
tradingId | string | false |
timeUpdated | string | false |
Name | Data Type | Required |
---|---|---|
roleId | string | false |
memberId | string | false |
termConditionId | string | false |
timeCreated | string | false |
tradingId | string | false |
information | string | false |
timeUpdated | string | false |
participantId | string | false |
Name | Data Type | Required |
---|---|---|
startDate | string | false |
properties | string | false |
endDate | string | false |
type | string | false |
storeId | string | false |
policyName | string | false |
policyId | string | false |
ownerId | string | false |
Name | Data Type | Required |
---|---|---|
languageId | string | false |
hasDisplayLogo | string | false |
hasDisplayText | string | false |
userId | string | false |
accountId | string | false |
storeId | string | false |
attachmentURL | string array | false |
displayText | string array | false |