This class provides RESTful services to access retrieve contract details.
com.ibm.commerce.rest.contract.handler.ContractHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/contract?q={q} | Finds contracts by query. See each query for details on input and output. |
GET | /store/{storeId}/contract?q=byPaymentTermConditionId | Find contract by payment term and condition identifier. |
GET | /store/{storeId}/contract?q=eligible | Finds the contracts the current user is eligible to. |
GET | /store/{storeId}/contract/{contractId} | Gets the contract details for a specific contract ID. |
Finds contracts by 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. |
500 | Internal server error. Additional details will be contained on the server logs. |
Find contract by payment term and condition identifier.
byPaymentTermConditionId
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
q | The query name. | query | string | true | false |
paymentTCId | Payment terms & conditions id. The payment Term & Condition identifier for this payment instruction. | query | string | true | false |
changeableFlag | query | integer | false | false | |
displayName | query | string | false | false | |
mandatoryFlag | query | integer | false | false | |
memberId | query | integer | false | false | |
nickName | query | string | false | false | |
tcSequence | query | integer | false | false | |
tradingId | query | integer | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.contract.beans.PaymentTCDataBean_IBM_PaymentTC_Detailed
Finds the contracts the current user is eligible to.
findEligible
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.order.beans.RequisitionListDataBean_IBM_Store_Summary
GET /wcs/resources/store/10801/contract?q=eligible
200
{ "contracts": { "10021": "Contract 1234" } }
Gets the contract details for a specific contract ID.
findByContractId
false
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
contractId | The contract identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed
GET /wcs/resources/store/10801/contract/10021?profileName=IBM_Contract_Usage&responseFormat=json
200
{ "resultList": [ { "name": "AuroraB2B Contract number 1234", "referenceNumber": "10021", "usage": 0 } ] }
Name | Data Type | Required |
---|---|---|
usage | string | false |
ownerReferenceNumber | string | false |
minorVersion | string | false |
timeApproved | string | false |
timeActivated | string | false |
TCs | com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed.TCs array | false |
origin | string | false |
storeXMLString | string | false |
markForDelete | string | false |
accountId | string | false |
storeXMLDefinition | string | false |
name | string | false |
timeUpdated | string | false |
dataBeanKeyReferenceNumber | string | false |
state | string | false |
contractLevelParticipants | com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed.contractLevelParticipants array | false |
timeDeployed | string | false |
owner | string | false |
referenceNumber | string | false |
comments | string | false |
referredTradingAgreementId | string | false |
timeCreated | string | false |
familyId | string | false |
majorVersion | string | false |
Name | Data Type | Required |
---|---|---|
roleId | string | false |
memberId | string | false |
tcId | string | false |
timeCreated | string | false |
tradingId | string | false |
information | string | false |
timeUpdated | string | false |
participantId | string | false |
Name | Data Type | Required |
---|---|---|
participants | com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed.TCs.participants array | false |
priceListId | string | false |
entireCatalogSelected | string | false |
inclusionProductSets | integer array | false |
mandatoryFlag | string | false |
XMLString | string | false |
tcSubType | string | false |
percentagePriceListIds | integer array | false |
timeUpdated | string | false |
productSetId | string | false |
tcSequence | string | false |
policies | com.ibm.commerce.contract.beans.ContractDataBean_IBM_Contract_Detailed.TCs.policies array | false |
priceListIds | integer array | false |
exclusionProductSets | integer array | false |
referenceNumber | string | false |
entireCatalogAdjustment | string | false |
changeableFlag | string | false |
timeCreated | string | false |
tradingId | string | false |
Name | Data Type | Required |
---|---|---|
roleId | string | false |
memberId | string | false |
tcId | 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 |
owner | string | false |
endDate | string | false |
type | string | false |
policyName | string | false |
policyId | string | false |
storeEntityId | string | false |
Name | Data Type | Required |
---|---|---|
PAttrValues | com.ibm.commerce.contract.beans.PaymentTCDataBean_IBM_PaymentTC_Detailed.PAttrValues array | false |
tradingId | string | false |
Name | Data Type | Required |
---|---|---|
sequence | string | false |
changeable | string | false |
tcId | string | false |
rfqResponseProductId | string | false |
rfqProductId | string | false |
PAttrValue | string | false |
encryptFlag | string | false |
referenceNumber | string | false |
attributeId | string | false |
mandatory | string | false |
type | string | false |
orderItemId | string | false |
correlationGroup | string | false |
unitId | string | false |
operatorId | string | false |
Name | Data Type | Required |
---|---|---|
recordSetTotal | string | false |
recordSetCompleteIndicator | string | false |
recordSetStartNumber | string | false |
resultList | com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary.resultList array | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
status | string | false |
userRegistration | com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary.resultList.userRegistration | false |
memberId | string | false |
orderId | string | false |
storeId | string | false |
description | string | false |
organizationId | string | false |
lastUpdate | string | false |
comment | string | false |
Name | Data Type | Required |
---|---|---|
middleName | string | false |
lastName | string | false |
firstName | string | false |