Understanding REST API Endpoints for PeopleSoft Supplier Comprehensive Portal Service (scp)

This topic lists the REST resources and methods for the Supplier Comprehensive Portal Service API (scp). Use this API to retrieve bid details, managed content details, user preference details, supplier transaction details, link details to access pages, purchase orders with overdue shipments, purchase orders with rejected receipts, purchase orders awaiting acknowledgement, and verify whether PeopleSoft Strategic Sourcing is enabled. The Supplier Comprehensive Portal Service REST API can be used for the Supplier Secure Collaboration, Supplier Secure General, Supplier Secure Invoice and Payment, Sourcing, and Supplier Public skills.

This table lists the delivered API resources used with the Supplier Comprehensive Portal Service API.

API Resource	Description
getlink	API resource to retrieve link details to access pages. This resource can be used for the Supplier Secure General and Supplier Public skills.
getbiddetails	API resource to retrieve bid details based on specific filter conditions and verify whether PeopleSoft Strategic Sourcing is enabled. This resource can be used for the Supplier Public and Sourcing skills.
getcontentdetails	API resource to retrieve managed content details, like Announcements and Events. This resource can be used for the Supplier Public and Supplier Secure General skills.
getoverduepodetails	API resource to retrieve details for purchase orders with overdue shipments. This resource can be used for the Supplier Secure Collaboration skill.
getrejectedreceipts	API resource to retrieve purchase orders with rejected receipts. This resource can be used for the Supplier Secure Collaboration skill.
getpoadetails	API resource to retrieve purchase orders awaiting acknowledgement. This resource can be used for the Supplier Secure Collaboration skill.
getuserpreference	API resource to retrieve user preference details. This resource can be used for the Sourcing and Supplier Secure Collaboration skills.
getassociatedsuppliers	API resource to retrieve suppliers associated with the transaction. This resource can be used for the Sourcing and Supplier Secure Collaboration skills.

API resource to retrieve link details to access pages. This resource can be used for the Supplier Secure General and Supplier Public skills.

Method: GET

Path: /getlink/{instrcontext}

Request Parameters	Description
instrcontext	Context String to differentiate the type of request. Possible values are: Contact: Contact details related link. Register: Registration related link.

Request Parameters

Description

instrcontext

Context String to differentiate the type of request.

Possible values are:

Contact: Contact details related link.
Register: Registration related link.

Response Parameters	Response Result Type	Description
strcontacturl	Success	Contact URL.
strdescr	Success	Description.
strfaqurl	Success	FAQ URL.
strregisterurl	Success	Registration URL.
strtitle	Success	Title

API resource to retrieve bid details based on specific filter conditions and verify whether PeopleSoft Strategic Sourcing is enabled. This resource can be used for the Supplier Public and Sourcing skills.

Method: GET

Path: /getpublicbiddetails/{instrstartdate}/{instrenddate}/{instrcategorytext}/{instrformatlist}

Request Parameters	Description
instrcategorytext	Category text filter.
instrenddate	End date filter.
instrformatlist	Bid Event format filter (sell/buy).
instrstartdate	Start date filter.

Response Parameters	Response Result Type	Description
strbiddescr	Success	Event description.
strbidformat	Success	Event format.
strbidid	Success	Event ID.
strbidtype	Success	Event type.
strenddate	Success	Event end date.
strfootertext	Success	Footer text.
strstartdate	Success	Event start date.
strurl1	Success	URL to access the event.

Method: GET

path: /getbidhealth

Request Parameters	Description
No Request Parameters.	N/A

Response Parameters	Response Result Type	Description
No response parameters.	N/A	N/A

Response Result Code	Description
200	Success Not Authorized
400	Error

Response Result Code

Description

200

Success

Not Authorized

400

Error

Method: GET

Path: /getuserbideventdetails/{instrduration}/{instrendduration}/{instrcategorytext}/{instrtimezone}/{instrformatlist}/{instrinvtypelist}/{instrstatuslist}/{instreventparticipation}/{instrsuppliersetid}/{instrsupplierid}

Request Parameters	Description
instrcategorytext	Category text filter.
instrduration	Duration filter.
instrendduration	End duration filter.
instreventparticipation	Bid Event participation status filter (RESP - Submitted bids, NRESP - Yet to submit bids).
instrformatlist	Bid Event format filter (sell, buy).
instrinvtypelist	Bid Event Invitation type filter (Invited, Public).
instrstatuslist	Bid Event status filter.
instrsupplierid	Supplier ID.
instrsuppliersetid	Supplier SetID.
instrtimezone	Duration Timezone (if timezone conversion is needed).

Response Parameters	Response Result Type	Description
strawarddt	Success	Award date.
strawardtype	Success	Award type.
strbidnum	Success	Bid number.
strenddate	Success	End date.
strended	Success	Event ending flag (Y - Ended, N- Ongoing).
strendsin	Success	Ends in.
streventformat	Success	Event format
streventid	Success	Event ID.
streventname	Success	Event name.
streventstatus	Success	Event status.
streventtype	Success	Event type.
strinvitationtype	Success	Invitation Type (Invited, Public).
strround	Success	Event round.
strstartdate	Success	Start date.
strsupplierid	Success	Supplier ID.
strsuppliername	Success	Supplier name.
strtransid	Success	Transaction ID (Purchase order, Contract ID).
strurl1	Success	URL to access the event.
strversion	Success	Event version

API resource to retrieve managed content details, like Announcements and Events. This resource can be used for the Supplier Public and Supplier Secure General skills.

Method: GET

Path: /getcontentdetails/{instrcontext}/{instrstartdate}/{instrenddate}/{instrsearchtext}

Request Parameters	Description
instrcontext	Context String to differentiate the type of request. Possible values are: Announcement - For Announcement details. Event - For Calender event details, uses Start date and End date filter. Search - To peform search using the instrsearchtext parameter in the configurable content using the search engine.
instrenddate	End date filter.
instrsearchtext	Search text value that is used if context value set to Search.
instrstartdate	Start date filter.

Response Parameters	Response Result Type	Description
strcontentid	Success	Content ID.
strdescr	Success	Content description.
strenddate	Success	End date.
strfootertext	Success	Footer text.
strstartdate	Success	Start date.
strtitle	Success	Title of content.
strurl1	Success	URL to access managed content.

API resource to retrieve details for purchase orders with overdue shipments. This resource can be used for the Supplier Secure Collaboration skill.

Method: GET

Path: /getoverduepodetails/{instrsuppliersetid}/{instrsupplierid}

Request Parameters	Description
instrsupplierid	Supplier ID.
instrsuppliersetid	Supplier setID.

Response Parameters	Response Result Type	Description
nbroverdueschedulecount	Success	Count of purchase orders with overdue schedules.
strbuyingorg	Success	Buying organization.
strpodate	Success	Purchase order date.
strpoid	Success	Purchase order ID.
strsupplierlocation	Success	Supplier location.
strsuppliername	Success	Supplier name.
strurl1	Success	URL to access purchase order overdue details.

API resource to retrieve purchase orders with rejected receipts. This resource can be used for the Supplier Secure Collaboration skill.

Method: GET

path: /getrejectedreceipts/{instrsuppliersetid}/{instrsupplierid}/{instrreceiptfromdt}/{instrreceipttodt}

Request Parameters	Description
instrreceiptfromdt	Receipt from date filter.
instrreceipttodt	Receipt to date filter.
instrsupplierid	Supplier ID.
instrsuppliersetid	Supplier setID.

Response Parameters	Response Result Type	Description
nbrpoline	Success	Purchase order line number.
nbrreceptline	Success	Receipt line number.
strbuyingorg	Success	Buying organization.
stritemid	Success	Item ID.
stritemname	Success	Item name.
strpoid	Success	Purchase order ID.
strreceiptdate	Success	Receipt date.
strreceiptid	Success	Receipt ID.
strrejectedquantity	Success	Rejected quantity.
strsuppliername	Success	Supplier name.
struom	Success	Unit of measure.
strurl1	Success	URL to access receipt details.

API resource to retrieve purchase orders awaiting acknowledgement. This resource can be used for the Supplier Secure Collaboration skill.

Method: GET

Path: /getpoadetails/{instrsuppliersetid}/{instrsupplierid}/{instrpoastatusfilter}

Request Parameters	Description
instrpoastatusfilter	Purchase order status Filer. To filter overdue transactions, the currently accepted value is ODUE.
instrsupplierid	Supplier ID.
instrsuppliersetid	Supplier setID.

Request Parameters

Description

instrpoastatusfilter

Purchase order status Filer.

To filter overdue transactions, the currently accepted value is ODUE.

instrsupplierid

Supplier ID.

instrsuppliersetid

Supplier setID.

Response Parameters	Response Result Type	Description
isoverdue	Success	Acknowledgement is overdue.
strackstatus	Success	Acknowledgement status.
strbuyer	Success	Buyer.
strbuyingorg	Success	Buying organization.
strduein	Success	Due in.
strpoid	Success	Purchase order ID.
strsupplierlocation	Success	Supplier location.
strsuppliername	Success	Supplier name.
strurl1	Success	URL to access the purchase order acknowledgement details.

API resource to retrieve user preference details. This resource can be used for the Sourcing and Supplier Secure Collaboration skills.

Method: GET

Path: /getuserpreference/{instrcontext}

Request Parameters	Description
instrcontext	Context String to differentiate the type of request. Possible values are: OS - Overdue Shipments RR - Rejected Receipts POA - PO Acknowledgements BO - Bidding Events & AE - Awarded Events

Request Parameters

Description

instrcontext

Context String to differentiate the type of request.

Possible values are:

OS - Overdue Shipments
RR - Rejected Receipts
POA - PO Acknowledgements
BO - Bidding Events &
AE - Awarded Events

Response Parameters	Response Result Type	Description
nbrlastndayscount	Success	User preference value.
strbaseurl	Success	URL to access the page based on the context.
strdatepreference	Success	Date preference.
strmultisupplier	Success	Suppliers associated with the logged in user (Y - multiple supplier, N - single Supplier).

API resource to retrieve suppliers associated with the transaction. This resource can be used for the Sourcing and Supplier Secure Collaboration skills.

Method: GET

Path: /getoverdueposuppliers

Request Parameters	Description
No request parameters.	N/A

Response Parameters	Response Result Type	Description
nbrcount	Success	Number of overdue shipments.
sno	Success	Serial number generated in the response.
strsetid	Success	Supplier setID.
strsupplierid	Success	Supplier ID.
strsuppliername	Success	Supplier name.
strurl1	Success	URL to access supplier details.

Method: GET

Path: /getpoasuppliers/{instrpoastatusfilter}

Request Parameter	Description
instrpoastatusfilter	Purchase order acknowledgement status Filer. To filter overdue transactions, the currently accepted value is ODUE.

Response Parameters	Response Result Type	Description
nbrcount	Success	Number of purchase orders awaiting acknowledgement.
sno	Success	Serial number generated in the response.
strsetid	Success	Supplier setID.
strsupplierid	Success	Supplier ID.
strsuppliername	Success	Supplier name.
strurl1	Success	URL to access purchase order details.

Method: GET

Path: /getarejectedreceiptsuppliers/{instrreceiptfromdt}/{instrreceipttodt}

Request Parameters	Description
instrreceiptfromdt	Receipt from date filter.
instrreceipttodt	Receipt to date filter.

Response Parameters	Response Result Type	Description
nbrcount	Success	Number of purchase orders associated with rejected receipt lines.
sno	Success	Serial number generated in the response.
strsetid	Success	Supplier setID.
strsupplierid	Success	Supplier ID.
strsuppliername	Success	Supplier name.
strurl1	Success	URL to access supplier details.

Method: GET

Path: /getbidassociatedsuppliers/{instrduration}/{instrendduration}/{instrtimezone}/{instrcategorytext}/{instrformatlist}/{instrinvtypelist}/{instrstatuslist}/{instreventparticipation}

Request Parameters	Description
instrcategorytext	Category text filter.
instrduration	Duration filter.
instrendduration	End duration filter.
instreventparticipation	Bid event participation status filter (RESP - submitted bids, NRESP - yet to submit bids)
instrformatlist	Bid event format filter (sell, buy).
instrinvtypelist	Bid event invitation type filter (invited, public)
instrstatuslist	Bid event status filter.
instrtimezone	Duration timezone (if timezone conversion is needed).

Response Parameters	Response Result Type	Description
nbrcount	Success	Number of bid events.
sno	Success	Serial number generated in the response.
strsetid	Success	Supplier setID.
strsupplierid	Success	Supplier ID.
strsuppliername	Success	Supplier name.

Understanding REST API Endpoints for PeopleSoft Supplier Comprehensive Portal Service (scp)

API Resources Used With the Supplier Comprehensive Portal Service API

getlink

Method: GET

getbiddetails

Method: GET

Method: GET

Method: GET

getcontentdetails

Method: GET

getoverduepodetails

Method: GET

getrejectedreceipts

Method: GET

getpoadetails

Method: GET

getuserpreference

Method: GET

getassociatedsuppliers

Method: GET

Method: GET

Method: GET

Method: GET