A requisition list is a list of items that is used to create orders at a later date.
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler
| HTTP Method | Path | Description |
|---|---|---|
| GET | /store/{storeId}/requisition_list?q={q} | Finds requisition lists by a query. See each query for details on input and output. |
| GET | /store/{storeId}/requisition_list?q=self | Finds requisition lists that are created by the current user. |
| GET | /store/{storeId}/requisition_list?q=usable | Finds requisition lists that can be used by the current user. |
| GET | /store/{storeId}/requisition_list/{requisitionListId} | Finds a requisition list by its ID. |
| POST | /store/{storeId}/requisition_list | Creates a requsition list. |
| POST | /store/{storeId}/requisition_list?action={action} | Performs an action. See each action for details on input and output. |
| POST | /store/{storeId}/requisition_list?action=addConfiguration | Add pre-configured dynamic kits or dynamic kit configurations to a requisition list. |
| POST | /store/{storeId}/requisition_list?action=copy | Copies a requsition list. |
| POST | /store/{storeId}/requisition_list?action=updateConfiguration | Updates pre-configured dynamic kits or dynamic kit configurations in a requisition list. |
| POST | /store/{storeId}/requisition_list?action=updateItem | Adds, updates and/or delete requisition list items. |
| POST | /store/{storeId}/requisition_list/{requisitionListId}?action={action} | Performs an action on a requsition list. See each action for details on input and output. |
| POST | /store/{storeId}/requisition_list/{requisitionListId}?action=addConfiguration | Add pre-configured dynamic kits or dynamic kit configurations to a requisition list. |
| POST | /store/{storeId}/requisition_list/{requisitionListId}?action=submit | Submits a requisition list. |
| POST | /store/{storeId}/requisition_list/{requisitionListId}?action=updateItem | Adds, updates and/or delete requisition list items. |
| PUT | /store/{storeId}/requisition_list/{requisitionListId} | Updates a requisition list. |
| DELETE | /store/{storeId}/requisition_list/{requisitionListId} | Deletes a requisition list. |
Finds requisition lists 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. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
Finds requisition lists that are created by the current user.
findSelf
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 |
| orderBy | Order by. | query | string | false | false |
| pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
| pageSize | 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. | 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.order.beans.RequisitionListDataBean_IBM_Store_Summary
GET /wcs/resources/store/10801/requisition_list?q=self&pageNumber=2&pageSize=-2
200
{
"recordSetCompleteIndicator": true,
"recordSetCount": 5,
"recordSetStartNumber": 0,
"recordSetTotal": 5,
"resultList": [
{
"comment": null,
"description": "reqList",
"lastUpdate": "2014-11-24T16:24:30.174000000Z",
"memberId": "-1004",
"orderId": "25198",
"organizationId": "7000000000000000801",
"status": "Y",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy1",
"lastUpdate": "2014-11-24T16:24:30.210000000Z",
"memberId": "-1004",
"orderId": "25199",
"organizationId": "7000000000000000801",
"status": "Y",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy2",
"lastUpdate": "2014-11-24T16:24:30.260000000Z",
"memberId": "-1004",
"orderId": "25200",
"organizationId": "7000000000000000801",
"status": "Z",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy3",
"lastUpdate": "2014-11-24T16:24:30.276000000Z",
"memberId": "-1004",
"orderId": "25201",
"organizationId": "7000000000000000801",
"status": "Y",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy4",
"lastUpdate": "2014-11-24T16:24:30.497000000Z",
"memberId": "-1004",
"orderId": "25202",
"organizationId": "7000000000000000801",
"status": "Z",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
}
]
}
Finds requisition lists that can be used by the current user.
findUsable
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 |
| orderBy | Order by. | query | string | false | false |
| pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
| pageSize | 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. | 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.order.beans.RequisitionListDataBean_IBM_Store_Summary
GET /wcs/resources/store/10801/requisition_list?q=usable&pageNumber=2&pageSize=-2
200
{
"recordSetCompleteIndicator": true,
"recordSetCount": 5,
"recordSetStartNumber": 0,
"recordSetTotal": 5,
"resultList": [
{
"comment": null,
"description": "reqList",
"lastUpdate": "2014-11-24T16:24:21.541000000Z",
"memberId": "-1004",
"orderId": "25163",
"organizationId": "7000000000000000801",
"status": "Y",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy1",
"lastUpdate": "2014-11-24T16:24:21.575000000Z",
"memberId": "-1004",
"orderId": "25164",
"organizationId": "7000000000000000801",
"status": "Y",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy2",
"lastUpdate": "2014-11-24T16:24:21.593000000Z",
"memberId": "-1004",
"orderId": "25165",
"organizationId": "7000000000000000801",
"status": "Z",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy3",
"lastUpdate": "2014-11-24T16:24:21.610000000Z",
"memberId": "-1004",
"orderId": "25166",
"organizationId": "7000000000000000801",
"status": "Y",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy4",
"lastUpdate": "2014-11-24T16:24:21.629000000Z",
"memberId": "-1004",
"orderId": "25167",
"organizationId": "7000000000000000801",
"status": "Z",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
}
]
}
Finds a requisition list by its ID.
findByRequisitionListId
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| requisitionListId | The requisition list 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.order.beans.RequisitionListDataBean_IBM_Store_Summary
GET /wcs/resources/store/10801/requisition_list/25203?forUser=buyerAshopper
200
{
"resultList": [
{
"comment": null,
"description": "reqList",
"lastUpdate": "2014-11-24T16:24:31.526000000Z",
"memberId": "4025",
"orderId": "25203",
"organizationId": "7000000000000000801",
"status": "Y",
"storeId": "10801",
"userRegistration": {
"firstName": "John",
"lastName": "Smith",
"middleName": ""
}
}
]
}
Creates a requsition list.
create
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| action | The action. | query | string | true | false |
| body | The body data. | body | com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListCreateRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 201 | The requested resource has been created. |
| 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.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListCreateResponse
POST /wcs/resources/store/10801/requisition_list
{
"name": "reqList",
"status": "Y"
}
201
{
"requisitionListId": 25203,
"viewTaskName": "RedirectView"
}
Performs an action. See each action for details on input and output.
performAction
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| action | The action. | query | string | false | false |
| body | The body data. | body | string | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 201 | 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. |
Add pre-configured dynamic kits or dynamic kit configurations to a requisition list.
addConfiguration
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| action | The action. | query | string | true | false |
| body | The body data. | body | com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListConfigurationAddRequest | false | 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. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
Copies a requsition list.
copy
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| action | The action. | query | string | true | false |
| body | The body data. | body | com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListCopyRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 201 | The requested resource has been created. |
| 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.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListCopyResponse
POST /wcs/resources/store/10801/requisition_list?action=copy
{
"name": "reqListCopy4",
"orderId": "25198",
"status": "Z"
}
201
{
"requisitionListId": 25202,
"viewTaskName": "RedirectView"
}
Updates pre-configured dynamic kits or dynamic kit configurations in a requisition list.
updateConfiguration
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| action | The action. | query | string | true | false |
| body | The body data. | body | com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListConfigurationUpdateRequest | false | 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. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
Adds, updates and/or delete requisition list items.
updateItem
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| action | The action. | query | string | true | false |
| body | The body data. | body | com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListItemUpdateRequest | false | 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. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
Performs an action on a requsition list. See each action for details on input and output.
performAction
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| requisitionListId | The requisition list ID. | path | string | true | N/A |
| action | The action. | query | string | true | false |
| body | The body data. | body | string | false | 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. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
Add pre-configured dynamic kits or dynamic kit configurations to a requisition list.
addConfiguration
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| requisitionListId | The requisition list ID. | path | string | true | N/A |
| action | The action. | query | string | true | false |
| body | The body data. | body | com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListConfigurationAddRequest | false | 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. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
Submits a requisition list.
submit
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| requisitionListId | The requisition list ID. | path | string | true | N/A |
| action | The action. | query | string | true | false |
| body | The body data. | body | com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListSubmitRequest | false | 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. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListSubmitResponse
Adds, updates and/or delete requisition list items.
updateItem
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| requisitionListId | The requisition list ID. | path | string | true | N/A |
| action | The action. | query | string | true | false |
| body | The body data. | body | com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListItemUpdateRequest | false | 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. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
POST /wcs/resources/store/10801/requisition_list/25203?action=updateItem&forUser=buyerAshopper
{
"partNumber": "FB041_410101",
"quantity": 2
}
200
{
"orderId": [
"25203"
],
"orderItemId": [
"85197"
],
"requisitionListId": [
"25203"
],
"viewTaskName": "RedirectView"
}
Updates a requisition list.
update
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| requisitionListId | The requisition list ID. | path | string | true | N/A |
| body | The body data. | body | com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListUpdateRequest | false | 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. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListUpdateResponse
PUT /wcs/resources/store/10801/requisition_list/25111
{
"name": ""
}
200
{
"viewTaskName": "RedirectView"
}
Deletes a requisition list.
delete
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| requisitionListId | The requisition list ID. | path | string | true | N/A |
| body | The body data. | body | com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListDeleteRequest | false | 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. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListDeleteResponse
DELETE /wcs/resources/store/10801/requisition_list/25113
200
{
"requisitionListId": "",
"viewTaskName": "RedirectView"
}
| 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 |
| Name | Data Type | Required |
|---|---|---|
| configurationXML | string | false |
| status | string | false |
| requisitionListId | string | false |
| catEntryId | string | false |
| type | string | false |
| quantity | string | true |
| name | string | false |
| partNumber | string | false |
| Name | Data Type | Required |
|---|---|---|
| configurationXML | string | false |
| orderItemId | string | false |
| Name | Data Type | Required |
|---|---|---|
| status | string | false |
| orderId | string | true |
| name | string | false |
| Name | Data Type | Required |
|---|---|---|
| requisitionListId | string | false |
| Name | Data Type | Required |
|---|---|---|
| status | string | false |
| name | string | false |
| Name | Data Type | Required |
|---|---|---|
| requisitionListId | string | false |
| Name | Data Type | Required |
|---|---|---|
| catEntryId_i | string | false |
| field1_i | string | false |
| field2_i | string | false |
| shipModeId_i | string | false |
| orderItemId_i | string | false |
| partNumber_i | string | false |
| attrName_i | string array | false |
| comment_i | string | false |
| attrValue_i | string array | false |
| outOrderName | string array | false |
| status | string | true |
| requisitionListId | string array | false |
| quantity_i | string | true |
| listId | string | false |
| addressId_i | string | false |
| UOM_i | string | false |
| outOrderItemName | string array | false |
| orderDesc | string | false |
| memberId_i | string | false |
| Name | Data Type | Required |
|---|---|---|
| orderId | string array | false |
| orderItemId | string array | false |
| Name | Data Type | Required |
|---|---|---|
| offerId | string array | false |
| contractId | string array | false |
| Name | Data Type | Required |
|---|---|---|
| orderId | string | false |
| Name | Data Type | Required |
|---|---|---|
| status | string | false |
| name | string | false |
| billtoAddressId | string | false |