{"info":{"_postman_id":"673d48c1-66dd-4310-a4df-0712ba3ae728","name":"Pegadrome- eAuction API documentation","description":"

Summary

Pegadrome eAuction APIs are used to create and manage auctions. eAuction is a plugin in Pegadrome that can be integrated seamlessly to any pega applications.

Overview

Pegadrome eAuction APIs are a set of services that you can call to manage all your auction needs. It is a single signon implementation and hence an end user doesn't have to login specifically to use the services.

Third parties need to authenticate itself using OAuth 2.0 in order to consume the APIs.

Base hostnames

eAuction APIs: Url will be provided when onboarding is done.

OAuth2 Server: Url will be provided when onboarding is done.

Authentication

OAuth 2.0 authentication using client credential grant types.

Error Codes

4XX- Invalid request parameters

5XX- If there is an issue with the apis internally

Rate limit

Client specific.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Summary","slug":"summary"},{"content":"Overview","slug":"overview"},{"content":"Base hostnames","slug":"base-hostnames"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"21418254","collectionId":"673d48c1-66dd-4310-a4df-0712ba3ae728","publishedId":"Uz5Nisn2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-01-05T17:55:29.000Z"},"item":[{"name":"OAuth 2.0","item":[{"name":"Pegadrome - Client Credentials flow","event":[{"listen":"prerequest","script":{"id":"cbeefc91-b953-4241-b39d-1f7ec522bdc2","exec":[""],"type":"text/javascript"}}],"id":"bf28adbf-829c-40df-a9c3-1f72d77fc269","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{pegadrome_client_id}}"},{"key":"password","value":"{{pegadrome_client_secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","description":"

Required. Set it to client_credentials.

\n","type":"text"}]},"url":"{{pegadrome-auth-api}}/oauth2/token","description":"

Follow one of the following flows to obtain app authorization.

Refreshable app authorization: Client Credentials

The Client Credentials flow is used in server-to-server authentication. Only endpoints that do not access user information can be accessed.

You do: Login with your Client ID and Secret Key

You get: Access token

Example using postman

Under the Authorization tab, select Basic Auth. You'll need to input your client_id as the username and client_secret as the password. You can update these credentials under the Authorization tab, or better yet, update the environment variables.

Once you do this, Postman adds an Authorization header with your credentials encoded to Base64 under the Headers tab.

For body, set the content type to x-www-form-urlencoded. Add the key as grant_typeand value as client_credentials.

\n","urlObject":{"path":["oauth2","token"],"host":["{{pegadrome-auth-api}}"],"query":[],"variable":[]}},"response":[{"id":"8407d046-030a-4097-b840-b07432c177d3","name":"Client Credentials flow","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","description":"Required. Set it to `client_credentials`.","type":"text"}]},"url":"{{pegadrome-auth-api}}/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"x-content-type-options","value":"nosniff"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}"}],"_postman_id":"bf28adbf-829c-40df-a9c3-1f72d77fc269"}],"id":"803f53c2-9b87-4495-811f-cff9e977f907","_postman_id":"803f53c2-9b87-4495-811f-cff9e977f907","description":""},{"name":"create-auction","event":[{"listen":"test","script":{"id":"211eb53a-08fe-41ab-922c-a9cf1c6312ef","exec":[""],"type":"text/javascript"}}],"id":"e739d5fa-8f14-42cb-87d4-4a78babe9eab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"projectId\":\"PR-10929912\",\n \"projectTitle\": \"Title of auction\",\n \"projectDescription\": \"Description of auction\",\n \"eventStart\": \"2023-04-21T11:22:00Z\",\n \"eventEnd\": \"2023-04-21T12:22:00Z\",\n \"startAmount\": \"400000\",\n \"currency\": \"USD\",\n \"bidType\": \"DECREMENT\",\n \"auctionType\": \"ENGLISH_REVERSE\",\n \"bidAdjustmentAmount\": \"\",\n \"overtime\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 10\n },\n \"overtimeCondition\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 5\n },\n \"participants\": [\n {\n \"id\": \"EXT9QZEPWY9RU\"\n },\n {\n \"id\": \"EXT7U34RIFJKD\"\n }\n ],\n \"createdBy\":\"63ed116b2588e709d90aef93\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auction-core-api}}/auctions","description":"

Create Auction API is protected by OAuth 2.0. You need to pass the access token from OAuth 2.0 in the header. The details of the fields in the request payload can be found below.

Authorization: Bearer {{access_token}}

","urlObject":{"path":["auctions"],"host":["{{auction-core-api}}"],"query":[],"variable":[]}},"response":[{"id":"4a2ed363-0ceb-4ab7-97b4-5cced5dfe034","name":"create-auction","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"projectId\":\"PR-10929912\",\n \"projectTitle\": \"Automation of contract 100\",\n \"projectDescription\": \"This is a sample descripton of the project and what activities are required a part of it\",\n \"eventStart\": \"2023-05-17T11:22:00Z\",\n \"eventEnd\": \"2023-05-21T12:22:00Z\",\n \"startAmount\": 400000,\n \"currency\": \"USD\",\n \"bidType\": \"DECREMENT\",\n \"auctionType\": \"ENGLISH_REVERSE\",\n \"bidAdjustmentAmount\": 3000,\n \"overtime\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 10\n },\n \"overtimeCondition\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 5\n },\n \"participants\": [\n {\n \"id\": \"Participant01\"\n },\n {\n \"id\": \"Participant02\"\n },\n {\n \"id\": \"Participant03\"\n }\n ],\n \"createdBy\":\"eAuctionAdmin\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auction-core-api}}/auctions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jul 2022 15:28:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"access-control-allow-origin","value":"*"},{"key":"content-security-policy","value":"default-src 'self'"},{"key":"x-content-security-policy","value":"default-src 'self'"},{"key":"x-webkit-csp","value":"default-src 'self'"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"DENY"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"surrogate-control","value":"no-store"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"1b5-PtLluSos046uP9W9g25KRmIwYq4\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"bids\": [],\n \"participants\": [\n {\n \"id\": \"Participant01\"\n },\n {\n \"id\": \"Participant02\"\n },\n {\n \"id\": \"Participant03\"\n }\n ],\n \"expiryProcessAttempt\": 0,\n \"_id\": \"6463fd36c490ed0acf60fe51\",\n \"projectId\": \"PR-10929912\",\n \"projectTitle\": \"Automation of contract 100\",\n \"projectDescription\": \"This is a sample descripton of the project and what activities are required a part of it\",\n \"eventStart\": \"2023-05-17T11:22:00.000Z\",\n \"eventEnd\": \"2023-05-21T12:22:00.000Z\",\n \"startAmount\": 400000,\n \"currency\": \"USD\",\n \"bidType\": \"DECREMENT\",\n \"auctionType\": \"ENGLISH_REVERSE\",\n \"bidAdjustmentAmount\": 3000,\n \"overtime\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 10\n },\n \"overtimeCondition\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 5\n },\n \"createdBy\": \"eAuctionAdmin\",\n \"created\": \"2023-05-16T22:01:26.135Z\",\n \"updated\": \"2023-05-16T22:01:26.135Z\",\n \"__v\": 0\n}"}],"_postman_id":"e739d5fa-8f14-42cb-87d4-4a78babe9eab"},{"name":"edit-auction","event":[{"listen":"test","script":{"id":"211eb53a-08fe-41ab-922c-a9cf1c6312ef","exec":[""],"type":"text/javascript"}}],"id":"068382d3-1456-443d-b83d-fec601d27d29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"projectId\": \"AUC12345\",\n \"projectTitle\":\"This is an edited title\",\n \"eventEnd\": \"2022-01-02T19:00:00.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auction-core-api}}/edit-auction","description":"

Edit Auction API is protected by OAuth 2.0. You need to pass the access token from OAuth 2.0 in the header

Authorization: Bearer {{access_token}}

The edit-auction endpoint allows you to make changes in the auction once it has been created. It accepts a similar payload as the create-auction endpoint. Please include the modified value against the fields in the payload. Additional details about the request payload are mentioned below.

\n\n

Note: This endpoint allows all the fields e.g eventStart, eventEnd, currency to be modified until an auction is \"Live\". Once the auction is \"Live\", the endpoint allows limited modification in an existing auction. Please find the list of restricted fields in a \"Live\" auction below.

","urlObject":{"path":["edit-auction"],"host":["{{auction-core-api}}"],"query":[],"variable":[]}},"response":[{"id":"f90058b2-8a3c-4ad3-bb0e-b817d881ee3d","name":"edit-auction","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"editedBy\": \"eAuctionAdmin\",\n \"projectId\": \"PR-10929912\",\n \"projectTitle\": \"This is modified title\",\n \"eventEnd\": \"2023-05-22T12:22:00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auction-core-api}}/edit-auction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jul 2022 15:28:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"access-control-allow-origin","value":"*"},{"key":"content-security-policy","value":"default-src 'self'"},{"key":"x-content-security-policy","value":"default-src 'self'"},{"key":"x-webkit-csp","value":"default-src 'self'"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"DENY"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"surrogate-control","value":"no-store"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"1b5-PtLluSos046uP9W9g25KRmIwYq4\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"Auction PR-10929912 updated successfully"}],"_postman_id":"068382d3-1456-443d-b83d-fec601d27d29"},{"name":"disable-auction","event":[{"listen":"test","script":{"id":"211eb53a-08fe-41ab-922c-a9cf1c6312ef","exec":[""],"type":"text/javascript"}}],"id":"4e6322f6-2882-4ec0-b564-7737b19d6622","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"projectId\": \"AUC12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auction-core-api}}/disable-auction","description":"

Disable Auction API is protected by OAuth 2.0. You need to pass the access token from OAuth 2.0 in the header

Authorization: Bearer {{access_token}}

Please use this disable-auction endpoint to disable an auction. Disabled auctions will still be visible to the participants invited to the auction but won't allow the participant to place bids or take any further action.

\n\n

Note: A \"Live\" auction cannot be disabled.

\n","urlObject":{"path":["disable-auction"],"host":["{{auction-core-api}}"],"query":[],"variable":[]}},"response":[{"id":"0cc9c547-78e8-4927-acb7-c43930ab328a","name":"disable-auction","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"projectId\": \"PR-10929912\",\n \"doneBy\": \"eAuctionAdmin\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auction-core-api}}/disable-auction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jul 2022 15:28:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"access-control-allow-origin","value":"*"},{"key":"content-security-policy","value":"default-src 'self'"},{"key":"x-content-security-policy","value":"default-src 'self'"},{"key":"x-webkit-csp","value":"default-src 'self'"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"DENY"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"surrogate-control","value":"no-store"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"1b5-PtLluSos046uP9W9g25KRmIwYq4\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"Auction PR-10929912 has been disabled successfully"}],"_postman_id":"4e6322f6-2882-4ec0-b564-7737b19d6622"},{"name":"delete-auction","event":[{"listen":"test","script":{"id":"211eb53a-08fe-41ab-922c-a9cf1c6312ef","exec":[""],"type":"text/javascript"}}],"id":"a0faaa76-ebcc-46ff-a6fc-669281d180cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"projectId\": \"AUC12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auction-core-api}}/disable-auction","description":"

Delete Auction API is protected by OAuth 2.0. You need to pass the access token from OAuth 2.0 in the header.

Authorization: Bearer {{access_token}}

The delete-auction endpoint allows deleting an auction. Once an auction is deleted, it won't be visible to any participants invited to that auction. The auction is archived and will be available for any future reporting.

\n\n

Note: A \"Live\" auction cannot be deleted.

\n","urlObject":{"path":["disable-auction"],"host":["{{auction-core-api}}"],"query":[],"variable":[]}},"response":[{"id":"341a9a99-670b-42e1-8cbf-855a6642451e","name":"delete-auction","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"projectId\": \"PR-10929912\",\n \"doneBy\": \"eAuctionAdmin\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auction-core-api}}/disable-auction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jul 2022 15:28:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"access-control-allow-origin","value":"*"},{"key":"content-security-policy","value":"default-src 'self'"},{"key":"x-content-security-policy","value":"default-src 'self'"},{"key":"x-webkit-csp","value":"default-src 'self'"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"DENY"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"surrogate-control","value":"no-store"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"1b5-PtLluSos046uP9W9g25KRmIwYq4\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"Auction PR-10929912 deleted successfully"}],"_postman_id":"a0faaa76-ebcc-46ff-a6fc-669281d180cc"},{"name":"list-auctions","event":[{"listen":"test","script":{"id":"211eb53a-08fe-41ab-922c-a9cf1c6312ef","exec":[""],"type":"text/javascript"}}],"id":"fe87d98d-6c19-4a7c-ab22-726b0b4f22d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"{{auction-core-api}}/auctions","description":"

List Auction API is protected by OAuth 2.0. You need to pass the access token from OAuth 2.0 in the header

Authorization: Bearer {{access_token}}

This endpoint provides the details of all the auctions.

\n","urlObject":{"path":["auctions"],"host":["{{auction-core-api}}"],"query":[],"variable":[]}},"response":[{"id":"c4c02d15-f6af-416d-8b7d-97237b9deb0c","name":"list-auctions","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"{{auction-core-api}}/auctions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jul 2022 15:28:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"access-control-allow-origin","value":"*"},{"key":"content-security-policy","value":"default-src 'self'"},{"key":"x-content-security-policy","value":"default-src 'self'"},{"key":"x-webkit-csp","value":"default-src 'self'"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"DENY"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"surrogate-control","value":"no-store"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"1b5-PtLluSos046uP9W9g25KRmIwYq4\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"bids\":[\n \n ],\n \"participants\":[\n {\n \"id\":\"Participant01\"\n },\n {\n \"id\":\"Participant02\"\n },\n {\n \"id\":\"Participant03\"\n }\n ],\n \"expiryProcessAttempt\":0,\n \"_id\":\"64599ab20d792454c44a1df2\",\n \"createdBy\":\"eAuctionAdmin\",\n \"projectId\":\"PR-10929912\",\n \"projectTitle\":\"Automation of contract\",\n \"projectDescription\":\"This is a sample descripton of the project and what activities are required a part of it\",\n \"eventStart\":\"2023-05-17T11:22:00.000Z\",\n \"eventEnd\":\"2023-05-21T12:22:00.000Z\",\n \"startAmount\":400000,\n \"currency\":\"USD\",\n \"bidType\":\"DECREMENT\",\n \"auctionType\":\"ENGLISH_REVERSE\",\n \"bidAdjustmentAmount\":3000,\n \"created\":\"2023-05-16T22:01:26.135Z\",\n \"updated\":\"2023-05-16T22:15:26.135Z\",\n \"__v\":0,\n \"currentBidId\":\"64599b0a0d792454c44a1e15\",\n \"currentBidPrice\":370000\n },\n {\n \"bids\":[\n \n ],\n \"participants\":[\n {\n \"id\":\"Participant01\"\n },\n {\n \"id\":\"Participant02\"\n },\n {\n \"id\":\"Participant03\"\n },\n {\n \"id\":\"Participant04\"\n }\n ],\n \"expiryProcessAttempt\":0,\n \"_id\":\"645a28159c10f957989b7b4f\",\n \"auctionType\":\"ENGLISH_REVERSE\",\n \"projectTitle\":\"5G Network services\",\n \"eventStart\":\"2023-05-09T11:03:00.000Z\",\n \"eventEnd\":\"2023-05-09T12:05:00.000Z\",\n \"currency\":\"GBP\",\n \"startAmount\":5000000,\n \"bidAdjustmentAmount\":9500,\n \"bidType\":\"DECREMENT\",\n \"projectDescription\":\"This is sample description for auction to establish 5G network within certain areas.\",\n \"overtime\":{\n \"days\":0,\n \"hours\":0,\n \"minutes\":0\n },\n \"overtimeCondition\":{\n \"days\":0,\n \"hours\":0,\n \"minutes\":0\n },\n \"projectId\":\"PR-12333223\",\n \"createdBy\":\"eAuctionAdmin02\",\n \"created\":\"2023-05-09T11:01:41.851Z\",\n \"updated\":\"2023-05-09T11:01:41.851Z\",\n \"__v\":0,\n\t \"currentBidId\":\"64599b0a0d792454c44a1e22\",\n \"currentBidPrice\":410000\n }\n]"}],"_postman_id":"fe87d98d-6c19-4a7c-ab22-726b0b4f22d3"},{"name":"get-auction-details","event":[{"listen":"test","script":{"id":"211eb53a-08fe-41ab-922c-a9cf1c6312ef","exec":[""],"type":"text/javascript"}}],"id":"eb8ed4c0-df6b-4f2f-864f-cd254e7cbfdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"{{auction-core-api}}/auctions/PR00102?use-internal-id=false","description":"

Get Auction API is protected by OAuth 2.0. You need to pass the access token from OAuth 2.0 in the header.

Authorization: Bearer {{access_token}}

The get-auction-details endpoint can be used to fetch the details of any particular auction. This endpoint will provide the as-is details of the auction along with the bids placed by the participants.

","urlObject":{"path":["auctions","PR00102"],"host":["{{auction-core-api}}"],"query":[{"key":"use-internal-id","value":"false"}],"variable":[]}},"response":[{"id":"e6e83681-e92b-406a-bda2-398c959caff1","name":"get-auction-details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":{"raw":"{{auction-core-api}}/auctions/PR00102?use-internal-id=false","host":["{{auction-core-api}}"],"path":["auctions","PR00102"],"query":[{"key":"use-internal-id","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jul 2022 15:28:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"access-control-allow-origin","value":"*"},{"key":"content-security-policy","value":"default-src 'self'"},{"key":"x-content-security-policy","value":"default-src 'self'"},{"key":"x-webkit-csp","value":"default-src 'self'"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"DENY"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"surrogate-control","value":"no-store"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"1b5-PtLluSos046uP9W9g25KRmIwYq4\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"bids\":[\n {\n \"_id\":\"64620753c490ed0acf60e61a\",\n \"bidAmount\":310000,\n \"projectId\":\"PR-10929912\",\n \"created\":\"2023-05-18T10:20:03.645Z\",\n \"updated\":\"2023-05-18T10:20:03.645Z\",\n \"participantExternalId\":\"Participant01\",\n \"currency\":\"USD\",\n \"projectTitle\":\"Automation of contract\",\n \"__v\":0\n },\n {\n \"_id\":\"6462076ac490ed0acf60e62c\",\n \"bidAmount\":325000,\n \"projectId\":\"PR-10929912\",\n \"created\":\"2023-05-19T10:20:26.338Z\",\n \"updated\":\"2023-05-19T10:20:26.338Z\",\n \"participantExternalId\":\"Participant02\",\n \"currency\":\"USD\",\n \"projectTitle\":\"Automation of contract 100\",\n \"__v\":0\n }\n ],\n \"participants\":[\n {\n \"id\":\"Participant01\"\n },\n {\n \"id\":\"Participant02\"\n },\n {\n \"id\":\"Participant03\"\n }\n ],\n \"expiryProcessAttempt\":0,\n \"_id\":\"6463fd36c490ed0acf60fe51\",\n \"projectId\":\"PR-10929912\",\n \"projectTitle\":\"Automation of contract 100\",\n \"projectDescription\":\"This is a sample descripton of the project and what activities are required a part of it\",\n \"eventStart\":\"2023-05-17T11:22:00.000Z\",\n \"eventEnd\":\"2023-05-21T12:22:00.000Z\",\n \"startAmount\":400000,\n \"currency\":\"USD\",\n \"bidType\":\"DECREMENT\",\n \"auctionType\":\"ENGLISH_REVERSE\",\n \"bidAdjustmentAmount\":3000,\n \"overtime\":{\n \"days\":0,\n \"hours\":0,\n \"minutes\":10\n },\n \"overtimeCondition\":{\n \"days\":0,\n \"hours\":0,\n \"minutes\":5\n },\n \"createdBy\":\"eAuctionAdmin\",\n \"created\":\"2023-05-16T22:01:26.135Z\",\n \"updated\":\"2023-05-16T22:01:26.135Z\",\n \"__v\":0\n}"}],"_postman_id":"eb8ed4c0-df6b-4f2f-864f-cd254e7cbfdb"},{"name":"generate-participant-token","event":[{"listen":"test","script":{"id":"4701ad38-e098-46cf-a4d3-bd45bd2a30c7","exec":["let jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"sessionToken\", jsonData.sessionToken);","postman.setEnvironmentVariable(\"profileId\", jsonData.profileId);"],"type":"text/javascript"}}],"id":"f687ec2f-3bb5-4e45-9285-883b1dca335c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"participantExternalId\":\"001\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auction-core-api}}/participant-login","description":"

Participant token API is protected by OAuth 2.0. You need to pass the access token from OAuth 2.0 in the header.

Authorization: Bearer {{access_token}}

This endpoint provides a unique token to every participant based on the unique identifier of the participant.

","urlObject":{"path":["participant-login"],"host":["{{auction-core-api}}"],"query":[],"variable":[]}},"response":[{"id":"057b12c1-22e6-4fe6-97d3-7ee6769a199c","name":"generate-participant-token","originalRequest":{"method":"POST","header":[{"key":"x-pgd-auth","value":"Bearer