English Reverse Auction Resource

The English Reverse Auction resource inherits some of the attributes from RFx. It has few attributes that are specific to an English reverse auction.

Table 1. English Reverse Auction attribute details
Attribute Type Description
allowBidderEventAttachment Boolean Allow supplier to add attachment at event level.
isProduction Boolean Specifies whether RFx is in production mode or in the testing mode
useBvd Boolean Enable the Business Volume Discount feature.
name String Name of the English Reverse auction.
Note: Maximum of 255 characters are supported.
supplierParticipants Array English Reverse Auction supplier participants
countValidResponse Integer Valid bid response number
countValidBid Integer Valid bid count
descriptionTranslation Object Resource link for description.
approvalStatus Integer The status of the approval form feature.
unreadMessageCount Integer Number of messages that are not read.
extensionType String  
timeRemain Integer Remaining time before an event is closed.
subType String English Reverse Auction subtype.
You can enter one of the following subtypes:
  • UNLOCKED
  • THEATER
  • LOCKED
  • ONE_ENVELOPE
  • TWO_ENVELOPE
Id Integer English Reverse Auction ID.
totalHistoricalCost Number Total historical cost.
supplierBidViewScope String  
businessUnitId Integer ID of the business unit associated with an event.
roundCount Integer RFx round count.
displayFeedbackAtEventLevel Boolean  
allowProxy Boolean Allow proxy bidding for an event.
rfxLeaders String RFx leads for all the invited team members.
allowPriceTransformation Boolean Enable price transformation feature.
endDate Any RFx end date. DATE_TIME (ISO-8601)
pendingAwards Boolean Indicates whether there is any pending awards in an RFx.
watched Boolean Indicates whether an RFx is watched or not.
organizationId Integer ID of the organization that initiated the RFx.
startDate Any RFx start date. DATE_TIME (ISO-8601)
questionnaires Array RFx questionnaires.
style String ENGLISH
minBidChangeType String Either PRICE or PERCENT.
categoryId Integer REVERSE_AUCTION
disableDisplay String  
type String RFx type.
You can enter one of the following RFx types:
  • RFI
  • RFP
  • RFQ
  • BUYER_SURVEY
  • FORWARD_AUCTION
  • REVERSE_AUCTION
supplierAcceptedCount Integer Indicates how many suppliers accepted the RFx.
supportedCurrencies String Supported currencies for the RFx. You can have multiple currencies that are supported for the RFx.
core3_1_0_aggregate_original_auction String  
primaryContact String Primary contact for the RFx.
primaryCurrencyCode String Currency code for the designated primary currency of the RFx.
items Array Indicates the items that are associated to an event.
supplierInvitedCount Integer Indicates how many suppliers are invited to the RFx.
lots Array Lots that are associated with the auction.
auction Boolean Specifies whether event type is auction or non-auction.
projectName String Project name that is linked to the RFx.
supplierInvitationsSent Boolean Indicates if the supplier invitations are sent.
useItemSet Boolean Enable item set for an event.
messages Array Messages that are associated with RFx.
displayFeedbackAtLotLevel Boolean  
enableEventNotifications Boolean To enable notifications for an event.
tieBreakerStatus String  
enableEventNotifications Boolean To enable notifications for an event.
useBundleBid Boolean Enable bundle bid for an event.
totalSavings Number Total savings for the event. Savings = Historical cost – awarded value.
postedAwards Boolean Indicates whether there are any posted awards in an RFx.
minBidChangeValue Number Min price change value for bid.
displayFeedbackAtItemLevel Boolean  
staggerLevel String Specify the level where you want the auction to be staggered. You can enter one of the following options:
  • NONE
  • LOT
  • ITEM
currencyInfoId Integer Currency information ID.
supplierSubscriptionStatus Integer Supplier response for the invitation.
invitationMode Integer RFx invitation mode.
webpage String Webpage of the RFx URL.
businessUnit Object Business unit that is associated with the English Reverse Auction.
allowPartialBid Boolean Allow partial bidding for an event.
biddingHallStatus Integer Status of bidding hall feature.
creatorId Integer ID of the English Reverse Auction creator.
supplierWithBid Integer Supplier with bid count. One supplier can have multiple bids for multiple items.
code String RFx internal code.
finalCloseDate Any DATE_TIME (ISO-8601)
allowDiscountBidding Boolean Allow discount bidding for an event.
status String English Reverse auction status
You can enter one of the following status:
  • PENDING
  • OPEN
  • CLOSED
  • AWARDED
  • CANCELED
buyerParticipants Array Invited team members.
rfxCurrentRoundId Integer RFx current round ID.
primaryContactId Integer ID of the primary contact of the RFx.
totalSpend Number Total awarded value for awarded items.
template Boolean The event is a template or normal RFx.
gracePeriodSecs Integer  
description String Description of the RFx.
bidCushionUpperLimit Number Upper limit value for bid cushion.
decimalPlaces Integer Number of decimal places for currency for the event.
bidCushionLowerLimit Number Lower limit value for bid cushion.
bidCushionType String Either PRICE or PERCENT.
category Object Main category at RFx level.
bestBidInformationBasedOn String  

Related links

Table 2. English Reverse Auction resource-related links
Object Resource link Description
descriptionTranslation /sourcing-api/rest/translation/{id} Resource link for description.
category /sourcing-api/rest/category/{id} Main category at the auction level.
businessUnit /sourcing-api/rest/organization/buyer/{id} Business unit that is associated with the English reverse auction.
supplierParticipants /sourcing-api/rest/rfx/reverse-auction/english-auction/{id}/supplier-participant RFx supplier participants.
buyerParticipants /sourcing-api/rest/rfx/reverse-auction/english-auction/{id}/buyer-participant Invited team members.
lots /sourcing-api/rest/rfx/{id}/lot/{id} Lots that are associated with the auction.
items /sourcing-api/rest/rfx/{id}/item/{id} Items that are associated with the English Reverse Auction.
questionnaires /sourcing-api/rest/rfx/reverse-auction/english-auction/{id}/questionnaire Questionnaires that are associated with the auction.
messages /sourcing-api/rest/message/{id} Messages that are associated with RFx.

Supported English Reverse auction web services

You can use the following URIs to do one or more of the following actions:
Action Method URI
Get bidding rules GET http://<domain>/sourcing-api/rest/rfx/reverse-auction/english-auction/{id}
Update bidding rules PUT http://<domain>/sourcing-api/rest/rfx/reverse-auction/english-auction/{id}