Retrieving Supplier Bids for a Specific Supplier in an Event with the Event Management API

This procedure describes how to use the Event Management API to retrieve supplier bid details for a specific supplier in an event.

Prerequisites

Context

The GET /events/{eventId}/supplierBids/{invitationId} endpoint of the Event Management API enables you to retrieve supplier bid details for a specific supplier in an event. Using the GET /events/{eventId}/supplierBids/{invitationId}/pages/{pageNumber} endpoint, you can retrieve supplier bid details for a specific supplier in an event based on the pagination details specified.

Procedure

  1. Use one of the following methods to obtain the ID of the event for which you want to retrieve supplier bid details.
    • If the event was created using the POST /events endpoint, use the internalId in the response as the event ID.

    • If the event was created from a sourcing request received from an external system, use the GET /events endpoint and specify the RFQ ID sent by the external system (the RequestID sent in the cXML QuoteRequest) as the externalSystemCorrelationId query parameter value. Use the internalId in the response as the event ID.

    • View the event ID in the user interface:

      • The classic SAP Ariba Sourcing user interface shows the event ID below the Overview tab, in the ID field.

      • The guided sourcing user interface shows the event ID in the upper left corner of the event page, below the event name.

  2. Use the GET /events/{eventId}/supplierBids/{invitationId} endpoint to retrieves all bids submitted by the specified supplier in an event.
    Specify the following path parameters:
    • invitationId: Specify the invitation ID of the supplier whose bid details have to be retrieved.

    You can specify the locale in which you want the response to return. For more information, refer to About Setting Locale for Event Management API Responses.

    You can paginate responses to manage the display of information returned. For more information, refer to About Paginating Event Management API Responses.

    Example:

    GET {{runtime_URL}}/events/DOC4567/supplierBids/sup_aaa?user=myUser&passwordAdapter=PasswordAdapter1&realm=mySite

    You can include the following optional query parameter:

    • dataFetchMode: Manages the level of details for the data in the response.

      Valid values: BASIC and DETAIL

      Default: BASIC

    The Event Management API returns the details of supplier bid details for the specified supplier in the event.

    For example:

    {
        [
            {
                "eventId": "DOC4567",
                "itemsWithBid": [
                    "3106709"
                ],
                "item": {
                    "itemId": "1431573",
                    "title": "Totals",
                    "terms": [
                        {
                            "title": "Extended Price",
                            "fieldId": "EXTENDEDPRICE",
                            "valueTypeName": "Money",
                            "isMultiValue": false,
                            "acceptableValues": "AnyValue",
                            "isRequirement": false,
                            "rollup": true,
                            "value": {
                                "moneyValue": {
                                    "amount": 137.5000000000,
                                    "currency": "CZK"
                                },
                                "supplierValue": {
                                    "amount": 0.5500000000,
                                    "currency": "USD"
                                }
                            },
                            "rankOrder": 1,
                            "isRankable": true,
                            "prerequisiteReviewStatus": 3
                        }
                    ]
                },
                "itemId": "1431573",
                "submissionDate": "2023-04-11T10:08:03.963+0000",
                "invitationId": "ACM_44136",
                "bidStatus": "Accepted",
                "alternativeId": "ID4183874"
            },
           ...
        ]
    }
    					
  3. Use the GET /events/{eventId}/supplierBids/{invitationId}/pages/{pageNumber} endpoint to retrieve supplier bids for a specific supplier in an event based on the pagination details specified.
    Specify the following path parameters:
    • invitationId: Specify the invitation ID of the supplier whose bid details have to be retrieved.

    • pageNumber: Specify the page number from which supplier bid information has to be retrieved.

    You can paginate responses to manage the display of information returned. For more information, refer to About Paginating Event Management API Responses.

    Example:

    GET {{runtime_URL}}/events/DOC4567/supplierBids/sup_aaa/pages/1?user=myUser&passwordAdapter=PasswordAdapter1&realm=mySite

    You can include the following optional query parameters:

    • dataFetchMode: Manages the level of details for the data in the response.

      Valid values: BASIC and DETAIL

      Default: BASIC

    • $filter: Retrieves the supplier bids for a specific item. For example, $filter=(itemId eq ID12345).

    • roundNumber: Specifies the number of the bidding round for which you want to retrieve details.

    The Event Management API returns the details of supplier bid details for the specified supplier in the event.

    For example:

    {
        [
            {
                "eventId": "DOC4567",
                "itemsWithBid": [
                    "3106709"
                ],
                "item": {
                    "itemId": "1431573",
                    "title": "Totals",
                    "terms": [
                        {
                            "title": "Extended Price",
                            "fieldId": "EXTENDEDPRICE",
                            "valueTypeName": "Money",
                            "isMultiValue": false,
                            "acceptableValues": "AnyValue",
                            "isRequirement": false,
                            "rollup": true,
                            "value": {
                                "moneyValue": {
                                    "amount": 137.5000000000,
                                    "currency": "CZK"
                                },
                                "supplierValue": {
                                    "amount": 0.5500000000,
                                    "currency": "USD"
                                }
                            },
                            "rankOrder": 1,
                            "isRankable": true,
                            "prerequisiteReviewStatus": 3
                        }
                    ]
                },
                "itemId": "1431573",
                "submissionDate": "2023-04-11T10:08:03.963+00:00",
                "invitationId": "ACM_44136",
                "bidStatus": "Accepted",
                "alternativeId": "ID4183874"
            },
            ...
        ]
    }
    					

    To troubleshoot your queries to the Event Management API, refer to Error Messages Returned by the Event Management API.