Manage Public Shopping List Lines
Goods and services purchased by customers may be recalled, have new packaging, or
have a new unit of measure. So a mechanism is needed to replace the goods or
services without manually updating each public shopping list. The replacements could
be in a number of shopping lists. Maintaining this manually could be difficult,
costly, and prone to errors. You can use the Public Shopping List Lines REST API
resource to perform these operations on shopping list lines for a shopping list
using these methods:
- Fetch public shopping list lines (GET)
- Add new lines to the public shopping list (POST)
- Replace existing lines in the public shopping list (PATCH)
- Delete lines from the public shopping list (DELETE)
To access this REST resource, you need to have the Procurement Catalog Administrator or ORA_PO_PROCUREMENT_REST_SERVICE_DUTY role.
Let's consider that John Rivenbark is a Catalog Administrator and is working in a healthcare organization. He often gets requests to update or delete a few items across different shopping lists. The reasons could be that agreements have expired, an item has been revoked, or some changes have been made in item attributes. He can use this REST API resource to bulk update or add the public shopping list lines according to his requirements.
Get Public Shopping List Lines
Suppose an agreement has expired and it's available across different shopping lists.
- Identify the agreement number and pass it as a finder to the resource URL.
- Perform a GET operation on the URL.
You can see agreement items across different shopping lists in the output response.
cURL Command
curl -u username:password -X GET -H "Content-Type: application/vnd.oracle.adf.action+json" -d 'request payload'
"https://servername/fscmRestApi/resources/version/publicShoppingListLines?finder=findByAgreement;Agreement="1000537";
Example Response
Here's an example of the response body in JSON format:
{
"items": [
{
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingListHeaderId": 300100003481973,
"PublicShoppingList": "PORFUS_PuL1",
"PublicShoppingListDescription": "PORFUS_PuL1",
"PublicShoppingListEndDate": null,
"PublicShoppingListStartDate": "2011-12-01",
"PublicShoppingListLineId": 300100003481988,
"Sequence": null,
"LineType": "Goods",
"ItemId": 100000013574113,
"Item": "zPOR-SCH005_Dell_Inspiron_1525",
"ItemRevision": null,
"ItemDescription": "PORSCH00501 BPA2 Inspiron 1525 Laptop",
"CategoryName": "Electrical Equipment_32",
"CategoryId": "32",
"SuggestedQuantity": 1,
"UOM": "Each",
"Price": 1000,
"CurrencyCode": "USD",
"Amount": 1000,
"Supplier": "CV_SuppA00",
"SupplierItem": "PORSCH00501 BPA2 SI",
"AgreementLineId": 300100003264772,
"Agreement": "1000537",
"AgreementLine": 3,
"Buyer": "Mancia,Mathew",
"NegotiatedFlag": true,
"NegotiationRequiredFlag": null,
"CreatedBy": "CVRQST05",
"CreationDate": "2011-12-01T18:15:47.251+00:00",
"LastUpdateDate": "2011-12-01T18:17:41.882+00:00",
"LastUpdatedBy": "CVRQST05",
"InventoryOrganizationId": 204,
"InventoryOrganization": "Vision Operations",
"IndexSyncPendingFlag": false,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481988",
"name": "publicShoppingListLines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481988",
"name": "publicShoppingListLines",
"kind": "item"
}
]
},
{
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingListHeaderId": 300100003481974,
"PublicShoppingList": "PORFUS_PuL2",
"PublicShoppingListDescription": "PORFUS_PuL2",
"PublicShoppingListEndDate": null,
"PublicShoppingListStartDate": "2011-12-01",
"PublicShoppingListLineId": 300100003481987,
"Sequence": null,
"LineType": "Goods",
"ItemId": -2,
"Item": null,
"ItemRevision": null,
"ItemDescription": "PORSCH00501 BPA2 USB Drive One Time Item",
"CategoryName": "Electrical Equipment_32",
"CategoryId": "32",
"SuggestedQuantity": 2,
"UOM": "Each",
"Price": 25,
"CurrencyCode": "USD",
"Amount": 50,
"Supplier": "CV_SuppA00",
"SupplierItem": "PORSCH005 BPA2 Item #3 SP",
"AgreementLineId": 300100003264897,
"Agreement": "1000537",
"AgreementLine": 3,
"Buyer": "Mancia,Mathew",
"NegotiatedFlag": true,
"NegotiationRequiredFlag": null,
"CreatedBy": "CVRQST05",
"CreationDate": "2011-12-01T18:15:47+00:00",
"LastUpdateDate": "2011-12-01T18:17:41.872+00:00",
"LastUpdatedBy": "CVRQST05",
"InventoryOrganizationId": 204,
"InventoryOrganization": "Vision Operations",
"IndexSyncPendingFlag": false,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481987",
"name": "publicShoppingListLines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481987",
"name": "publicShoppingListLines",
"kind": "item"
}
]
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines",
"name": "publicShoppingListLines",
"kind": "collection"
}
]
}Patch the Public Shopping List Lines
If you want to update the expired agreement line with othercagreement items, then you can pass the new agreement details in the payload and perform a PATCH operation. In this scenario, the shopping list lines across different shopping lists are updated.
This is a batch operation for updating multiple lines so you need select the POST operation for patching.
cURL Command
curl -u username:password -X POST -H "Content-Type: application/vnd.oracle.adf.action+json" -d 'request payload'
"https://servername/fscmRestApi/resources/version/
Example Request
Here's an example of the request body in JSON format:
{
"parts": [
{
"id": "part0",
"path": "/publicShoppingListLines/300100003481988",
"operation": "update",
"payload": {
"Sequence": 20,
"Item": "CoolingPad 9",
"SuggestedQuantity": 14,
"Agreement": "1002641",
"AgreementLine": 5120
}
},
{
"id": "part1",
"path": "/publicShoppingListLines/300100003481987",
"operation": "update",
"payload": {
"Sequence": 21,
"Item": "CM11222",
"SuggestedQuantity": 17,
"AgreementLineId": 300100007051483
}
}
]
}
Example Response
Here's an example of the response body in JSON format:
{
"parts": [
{
"id": "part0",
"path": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100545714235",
"operation": "update",
"payload": {
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingListHeaderId": 300100003481973,
"PublicShoppingList": "PORFUS_PuL1",
"PublicShoppingListDescription": "PORFUS_PuL1",
"PublicShoppingListEndDate": null,
"PublicShoppingListStartDate": "2021-08-12",
"PublicShoppingListLineId": 300100003481988,,
"Sequence": 20,
"LineType": "Goods",
"ItemId": 100100106982346,
"Item": "CoolingPad 9",
"ItemRevision": null,
"ItemDescription": "PORSHO Agreement Item 19",
"CategoryName": "Miscellaneous_1",
"CategoryId": "1",
"SuggestedQuantity": 14,
"UOM": "Each",
"Price": 5119,
"CurrencyCode": "USD",
"Amount": 71666,
"Supplier": "CV_SuppA01",
"SupplierItem": "SItem2",
"AgreementLineId": 519018,
"Agreement": "1002641",
"AgreementLine": 5120,
"Buyer": "PON00020, PRC",
"NegotiatedFlag": true,
"NegotiationRequiredFlag": null,
"CreatedBy": "PRC_INTEGRATION_USER",
"CreationDate": "2021-08-12T09:40:05+00:00",
"LastUpdateDate": "2021-08-12T09:48:07+00:00",
"LastUpdatedBy": "CVRQST04",
"InventoryOrganizationId": 204,
"InventoryOrganization": "Vision Operations",
"IndexSyncPendingFlag": true,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100545714235",
"name": "publicShoppingListLines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100545714235",
"name": "publicShoppingListLines",
"kind": "item"
}
]
}
},
{
"id": "part1",
"path": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100545714233",
"operation": "update",
"payload": {
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingListHeaderId": 300100003481974,,
"PublicShoppingList": "PORFUS_PuL2",
"PublicShoppingListDescription": "PORFUS_PuL2",
"PublicShoppingListEndDate": null,
"PublicShoppingListStartDate": "2021-08-12",
"PublicShoppingListLineId": 300100003481987,
"Sequence": 21,
"LineType": "Goods",
"ItemId": 606,
"Item": "CM11222",
"ItemRevision": null,
"ItemDescription": "Battery - Extended Life",
"CategoryName": "Miscellaneous_1",
"CategoryId": "1",
"SuggestedQuantity": 17,
"UOM": "Each",
"Price": 100,
"CurrencyCode": "USD",
"Amount": 1700,
"Supplier": "CV_SuppA00",
"SupplierItem": null,
"AgreementLineId": 300100007051483,
"Agreement": "1000579",
"AgreementLine": 1,
"Buyer": "Furey,Clare",
"NegotiatedFlag": true,
"NegotiationRequiredFlag": null,
"CreatedBy": "PRC_INTEGRATION_USER",
"CreationDate": "2021-08-12T09:39:56+00:00",
"LastUpdateDate": "2021-08-12T09:48:07.003+00:00",
"LastUpdatedBy": "CVRQST04",
"InventoryOrganizationId": 204,
"InventoryOrganization": "Vision Operations",
"IndexSyncPendingFlag": true,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100545714233",
"name": "publicShoppingListLines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100545714233",
"name": "publicShoppingListLines",
"kind": "item"
}
]
}
}
]
}
Delete the Public Shopping List Lines
When any goods or services are revoked or recalled and there is no alternative available, then you need to delete that data from the shopping list. This can be achieved by using the DELETE operation on the resource.
cURL Command
curl -u username:password -X DELETE -H "Content-Type: application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/publicShoppingListLines/publicshoppinglistlineId"
Example Response
Here's an example of the response body in JSON format:
Response Code 204
Post the Public Shopping List Lines
If you want to add multiple lines to different public shipping lists, use the POST operation on the resource.
cURL Command
curl -u username:password -X POST -H "Content-Type: application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/"
Example Request
Here's an example of the request body in JSON format:
{
"parts": [
{
"id": "part0",
"path": "/publicShoppingListLines",
"operation": "create",
"payload": {
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingList": "POR_PSL01",
"Sequence": null,
"Item": "CoolingPad 9",
"SuggestedQuantity": 1,
"Agreement": "1002641",
"AgreementLine": 5
}
},
{
"id": "part1",
"path": "/publicShoppingListLines",
"operation": "create",
"payload": {
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingList": "POR_PSL01",
"Sequence": 1,
"ItemId": 100100106982337,
"SuggestedQuantity": 4
}
},
{
"id": "part2",
"path": "/publicShoppingListLines",
"operation": "create",
"payload": {
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingList": "POR_PSL02",
"Agreement": "1002258",
"AgreementLine": 2
}
},
{
"id": "part3",
"path": "/publicShoppingListLines",
"operation": "create",
"payload": {
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingList": "POR_PSL03",
"Sequence": 4,
"AgreementLineId": 100000020118480,
"Agreement": "1000529",
"AgreementLine": 2
}
}
]
}
Example Response
Here's an example of the response body in JSON format:
{
"parts": [
{
"id": "part0",
"path": "https://servername/fscmRestApi/resources/version/publicShoppingListLines",
"operation": "create",
"payload": {
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingListHeaderId": 300100188021751,
"PublicShoppingList": "POR_PSL01",
"PublicShoppingListDescription": "Test PSL",
"PublicShoppingListEndDate": null,
"PublicShoppingListStartDate": "2020-08-11",
"PublicShoppingListLineId": 300100197614437,
"Sequence": null,
"LineType": "Goods",
"ItemId": 100100106982346,
"Item": "CoolingPad 9",
"ItemRevision": null,
"ItemDescription": "PORSHO Agreement Item 19",
"CategoryName": "Miscellaneous_1",
"CategoryId": "1",
"SuggestedQuantity": 1,
"UOM": "Each",
"Price": 5119,
"CurrencyCode": "USD",
"Amount": 5119,
"Supplier": "CV_SuppA01",
"SupplierItem": "SItem2",
"AgreementLineId": 519018,
"Agreement": "1002641",
"AgreementLine": 5120,
"Buyer": "PON00020, PRC",
"NegotiatedFlag": true,
"NegotiationRequiredFlag": null,
"CreatedBy": "CVRQST01",
"CreationDate": "2020-08-20T03:22:56+00:00",
"LastUpdateDate": "2020-08-20T03:22:57.161+00:00",
"LastUpdatedBy": "CVRQST01",
"InventoryOrganizationId": 204,
"InventoryOrganization": "Vision Operations",
"IndexSyncPendingFlag": true,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614437",
"name": "publicShoppingListLines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614437",
"name": "publicShoppingListLines",
"kind": "item"
}
]
}
},
{
"id": "part1",
"path": "https://servername/fscmRestApi/resources/version/publicShoppingListLines",
"operation": "create",
"payload": {
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingListHeaderId": 300100188021751,
"PublicShoppingList": "POR_PSL01",
"PublicShoppingListDescription": "Test PSL",
"PublicShoppingListEndDate": null,
"PublicShoppingListStartDate": "2020-08-11",
"PublicShoppingListLineId": 300100197614438,
"Sequence": 1,
"LineType": null,
"ItemId": 100100106982337,
"Item": "CoolingPad 19",
"ItemRevision": null,
"ItemDescription": "PORSHO MasterItem 19",
"CategoryName": "Miscellaneous_1",
"CategoryId": "1",
"SuggestedQuantity": 4,
"UOM": "Each",
"Price": 5018,
"CurrencyCode": "USD",
"Amount": 20072,
"Supplier": null,
"SupplierItem": null,
"AgreementLineId": -2,
"Agreement": null,
"AgreementLine": null,
"Buyer": null,
"NegotiatedFlag": null,
"NegotiationRequiredFlag": null,
"CreatedBy": "CVRQST01",
"CreationDate": "2020-08-20T03:22:56.253+00:00",
"LastUpdateDate": "2020-08-20T03:22:57.178+00:00",
"LastUpdatedBy": "CVRQST01",
"InventoryOrganizationId": 204,
"InventoryOrganization": "Vision Operations",
"IndexSyncPendingFlag": true,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614438",
"name": "publicShoppingListLines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614438",
"name": "publicShoppingListLines",
"kind": "item"
}
]
}
},
{
"id": "part2",
"path": "https://servername/fscmRestApi/resources/version/publicShoppingListLines",
"operation": "create",
"payload": {
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingListHeaderId": 300100188021751,
"PublicShoppingList": "POR_PSL02",
"PublicShoppingListDescription": "Test PSL",
"PublicShoppingListEndDate": null,
"PublicShoppingListStartDate": "2020-08-11",
"PublicShoppingListLineId": 300100197614439,
"Sequence": null,
"LineType": "Goods",
"ItemId": 663908,
"Item": "RCV-101",
"ItemRevision": null,
"ItemDescription": "Lot Item",
"CategoryName": "Miscellaneous_1",
"CategoryId": "1",
"SuggestedQuantity": 1,
"UOM": "Each",
"Price": 10,
"CurrencyCode": "USD",
"Amount": 10,
"Supplier": "CV_SuppA01",
"SupplierItem": null,
"AgreementLineId": 385370,
"Agreement": "1002258",
"AgreementLine": 2,
"Buyer": "Furey,Clare",
"NegotiatedFlag": true,
"NegotiationRequiredFlag": null,
"CreatedBy": "CVRQST01",
"CreationDate": "2020-08-20T03:22:56.772+00:00",
"LastUpdateDate": "2020-08-20T03:22:57.179+00:00",
"LastUpdatedBy": "CVRQST01",
"InventoryOrganizationId": 204,
"InventoryOrganization": "Vision Operations",
"IndexSyncPendingFlag": true,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614439",
"name": "publicShoppingListLines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614439",
"name": "publicShoppingListLines",
"kind": "item"
}
]
}
},
{
"id": "part3",
"path": "https://servername/fscmRestApi/resources/version/publicShoppingListLines",
"operation": "create",
"payload": {
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingListHeaderId": 300100188021751,
"PublicShoppingList": "POR_PSL03",
"PublicShoppingListDescription": "Test PSL",
"PublicShoppingListEndDate": null,
"PublicShoppingListStartDate": "2020-08-11",
"PublicShoppingListLineId": 300100197614440,
"Sequence": 4,
"LineType": "Fixed Price Services",
"ItemId": -2,
"Item": null,
"ItemRevision": null,
"ItemDescription": "Item 02",
"CategoryName": "Miscellaneous_1",
"CategoryId": "1",
"SuggestedQuantity": null,
"UOM": null,
"Price": null,
"CurrencyCode": "USD",
"Amount": 100,
"Supplier": "General Electric",
"SupplierItem": null,
"AgreementLineId": 100000020118480,
"Agreement": "1000529",
"AgreementLine": 2,
"Buyer": "Furey,Clare",
"NegotiatedFlag": true,
"NegotiationRequiredFlag": null,
"CreatedBy": "CVRQST01",
"CreationDate": "2020-08-20T03:22:56.972+00:00",
"LastUpdateDate": "2020-08-20T03:22:57.182+00:00",
"LastUpdatedBy": "CVRQST01",
"InventoryOrganizationId": 204,
"InventoryOrganization": "Vision Operations",
"IndexSyncPendingFlag": true,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614440",
"name": "publicShoppingListLines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614440",
"name": "publicShoppingListLines",
"kind": "item"
}
]
}
}
]
}