eBay-Style Marketplace Backend

frontend-prompt-5-auctionofferservice • 1/2/2026

EBAYCCLONE

FRONTEND GUIDE FOR AI CODING AGENTS - PART 5 - AuctionOffer Service

This document is a part of a REST API guide for the ebaycclone project. It is designed for AI agents that will generate frontend code to consume the project’s backend.

This document provides extensive instruction for the usage of auctionOffer

Service Access

AuctionOffer service management is handled through service specific base urls.

AuctionOffer service may be deployed to the preview server, staging server, or production server. Therefore,it has 3 access URLs. The frontend application must support all deployment environments during development, and the user should be able to select the target API server on the login page (already handled in first part.).

For the auctionOffer service, the base URLs are:

  • Preview: https://ebaycclone.prw.mindbricks.com/auctionoffer-api
  • Staging: https://ebaycclone-stage.mindbricks.co/auctionoffer-api
  • Production: https://ebaycclone.mindbricks.co/auctionoffer-api

Scope

AuctionOffer Service Description

Handles auction bids and fixed-price offers for product listings, enforces real-time auction state, handles strict offer workflows including counter-offers, and triggers domain events for bid/offer notifications. No payment or frontend aggregation logic included.

AuctionOffer service provides apis and business logic for following data objects in ebaycclone application. Each data object may be either a central domain of the application data structure or a related helper data object for a central concept. Note that data object concept is equal to table concept in the database, in the service database each data object is represented as a db table scheme and the object instances as table rows.

auctionOfferOffer Data Object: Represents an offer (best offer/counter-offer) made on a fixed-price product. Tracks buyer, seller, amounts, currency, state transitions, counter-offers, and expiry.

auctionOfferBid Data Object: Represents an individual bid placed on an auction-type product. Linked to product and user, tracks bid amount, currency, status (ACTIVE, WON, LOST, CANCELLED), and time placed.

AuctionOffer Service Frontend Description By The Backend Architect

auctionOffer Service UX Prompt

  • Provides backend bid/offer flows; surfaces only valid actions per product type and state.
  • Bids can be placed only on active AUCTION products not owned by the user, with validation for auction timing and minimum bid increments per product type.
  • Offers and counter-offers only eligible for FIXED products with acceptOffers enabled; UI must fetch product type/details before allowing offer flow.
  • All offer/bid actions automatically trigger downstream notification events; UI should be prepared for backend event-driven updates (bids outbid, offers accepted/declined, etc.).
  • For offers: strict status transitions—UI enforces only one possible action per party/state (pending offers can be accepted, declined, or countered by seller; buyer can only withdraw prior to response).
  • For counter-offers, navigate chain via counterOfferId. Show clear status/history/expiry for each user’s offers.
  • All APIs require authentication, show errors for forbidden actions. No direct notification/inbox UI exposed here—consume notification events to show relevant updates.

API Structure

Object Structure of a Successful Response

When the service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope includes the data and essential metadata such as configuration details and pagination information, providing context to the client.

HTTP Status Codes:

  • 200 OK: Returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request was processed successfully.
  • 201 Created: Returned for CREATE operations, indicating that the resource was created successfully.

Success Response Format:

For successful operations, the response includes a "status": "OK" property, signaling that the request executed successfully. The structure of a successful response is outlined below:

{
  "status":"OK",
  "statusCode": 200,   
  "elapsedMs":126,
  "ssoTime":120,
  "source": "db",
  "cacheKey": "hexCode",
  "userId": "ID",
  "sessionId": "ID",
  "requestId": "ID",
  "dataName":"products",
  "method":"GET",
  "action":"list",
  "appVersion":"Version",
  "rowCount":3,
  "products":[{},{},{}],
  "paging": {
    "pageNumber":1, 
    "pageRowCount":25, 
    "totalRowCount":3,
    "pageCount":1
  },
  "filters": [],
  "uiPermissions": []
}
  • products: In this example, this key contains the actual response content, which may be a single object or an array of objects depending on the operation.

Additional Data

Each API may include additional data besides the main data object, depending on the business logic of the API. These will be provided in each API’s response signature.

Error Response

If a request encounters an issue—whether due to a logical fault or a technical problem—the service responds with a standardized JSON error structure. The HTTP status code indicates the nature of the error, using commonly recognized codes for clarity:

  • 400 Bad Request: The request was improperly formatted or contained invalid parameters.
  • 401 Unauthorized: The request lacked a valid authentication token; login is required.
  • 403 Forbidden: The current token does not grant access to the requested resource.
  • 404 Not Found: The requested resource was not found on the server.
  • 500 Internal Server Error: The server encountered an unexpected condition.

Each error response is structured to provide meaningful insight into the problem, assisting in efficient diagnosis and resolution.

{
  "result": "ERR",
  "status": 400,
  "message": "errMsg_organizationIdisNotAValidID",
  "errCode": 400,
  "date": "2024-03-19T12:13:54.124Z",
  "detail": "String"
}

Bucket Management

(This information is also given in PART 1 prompt.)

This application has a bucket service used to store user files and other object-related files. The bucket service is login-agnostic, so for write operations or private reads, include a bucket token (provided by services) in the request’s Authorization header as a Bearer token.

Please note that all other business services require the access token in the Bearer header, while the bucket service expects a bucket token because it is login-agnostic. Ensure you manage the required token injection properly; any auth interceptor should not replace the bucket token with the access token.

User Bucket This bucket stores public user files for each user.

When a user logs in—or in the /currentuser response—there is a userBucketToken to use when sending user-related public files to the bucket service.

{
  //...
  "userBucketToken": "e56d...."
}

To upload a file

POST {baseUrl}/bucket/upload

The request body is form-data which includes the bucketId and the file binary in the files field.

{
    bucketId: "{userId}-public-user-bucket",
    files: {binary}
}

Response status is 200 on success, e.g., body:

{
    "success": true,
    "data": [
        {
            "fileId": "9da03f6d-0409-41ad-bb06-225a244ae408",
            "originalName": "test (10).png",
            "mimeType": "image/png",
            "size": 604063,
            "status": "uploaded",
            "bucketName": "f7103b85-fcda-4dec-92c6-c336f71fd3a2-public-user-bucket",
            "isPublic": true,
            "downloadUrl": "https://babilcom.mindbricks.co/bucket/download/9da03f6d-0409-41ad-bb06-225a244ae408"
        }
    ]
}

To download a file from the bucket, you need its fileId. If you upload an avatar or other asset, ensure the download URL or the fileId is stored in the backend.

Buckets are mostly used in object creations that require an additional file, such as a product image or user avatar. After uploading your image to the bucket, insert the returned download URL into the related property of the target object record.

Application Bucket

This Ebaycclone application also includes a common public bucket that anyone can read, but only users with the superAdmin, admin, or saasAdmin roles can write (upload) to it.

When a user with one of these admin roles is logged in, the /login response or the /currentuser response also returns an applicationBucketToken field, which is used when uploading any file to the application bucket.

{
  //...
  "applicationBucketToken": "e23fd...."
}

The common public application bucket ID is

"ebaycclone-public-common-bucket"

In certain admin areas—such as product management pages—since the user already has the application bucket token, they will be able to upload related object images.

Please configure your UI to upload files to the application bucket using this bucket token whenever needed.

Object Buckets Some objects may also return a bucket token for uploading or accessing files related to that object. For example, in a project management application, when you fetch a project’s data, a public or private bucket token may be provided to upload or download project-related files.

These buckets will be used as described in the relevant object definitions.

AuctionOfferOffer Data Object

Represents an offer (best offer/counter-offer) made on a fixed-price product. Tracks buyer, seller, amounts, currency, state transitions, counter-offers, and expiry.

AuctionOfferOffer Data Object Frontend Description By The Backend Architect

One offer or counteroffer for a product. Displays offer amount, parties, messages, expiry, and current status. Allow accept, decline, or counter on eligible state. Only one open 'PENDING' per buyer/product.

AuctionOfferOffer Data Object Properties

AuctionOfferOffer data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

Property Type IsArray Required Description
buyerId ID false Yes Buyer making the offer.
currency String false Yes ISO currency (e.g., USD, EUR) for the offer.
productId ID false Yes Product the offer applies to (must be fixed-price, acceptOffers true).
counterOfferId ID false No References another offer (counter-offer chain).
counterMessage String false No Message accompanying seller's counter-offer (optional).
counterAmount Double false No Counter-offer amount (when offer is COUNTERED).
offerAmount Double false Yes Primary offer amount from buyer.
message String false No Message/special notes from buyer (optional).
sellerId ID false Yes Seller of the product (recipient of offer; auto-fetched from product).
status Enum false Yes Current offer status (e.g., PENDING, ACCEPTED, DECLINED, COUNTERED, EXPIRED, CANCELLED).
expiresAt Date false No When this offer expires (optional).
respondedAt Date false No When the seller (or buyer, for counter-offer) responded/updated the offer status.
  • Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.

  • status: [PENDING, ACCEPTED, DECLINED, COUNTERED, EXPIRED, CANCELLED]

Relation Properties

buyerId productId counterOfferId sellerId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

  • buyerId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

  • productId: ID Relation to productListingProduct.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

  • counterOfferId: ID Relation to auctionOfferOffer.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: No

  • sellerId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

Filter Properties

buyerId currency productId offerAmount sellerId status

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

  • buyerId: ID has a filter named buyerId

  • currency: String has a filter named currency

  • productId: ID has a filter named productId

  • offerAmount: Double has a filter named offerAmount

  • sellerId: ID has a filter named sellerId

  • status: Enum has a filter named status

AuctionOfferBid Data Object

Represents an individual bid placed on an auction-type product. Linked to product and user, tracks bid amount, currency, status (ACTIVE, WON, LOST, CANCELLED), and time placed.

AuctionOfferBid Data Object Frontend Description By The Backend Architect

A single bid on an auction product. Display bid amount, user, time placed, and status. UX should allow placing new bids only within valid auction window, show status (e.g. ACTIVE, WON/LOST). Soft-deleted/cancelled bids never shown in auction history.

AuctionOfferBid Data Object Properties

AuctionOfferBid data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

Property Type IsArray Required Description
userId ID false Yes User placing the bid.
bidAmount Double false Yes Bid amount placed by the user.
placedAt Date false No When the bid was placed.
currency String false Yes ISO currency for the bid (e.g., USD, EUR).
status Enum false Yes Bid status: ACTIVE, WON, LOST, CANCELLED.
productId ID false Yes Product being bid on (must be AUCTION type).
  • Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.

  • status: [ACTIVE, WON, LOST, CANCELLED]

Relation Properties

userId productId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

  • userId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

  • productId: ID Relation to productListingProduct.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

Filter Properties

userId bidAmount currency status productId

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

  • userId: ID has a filter named userId

  • bidAmount: Double has a filter named bidAmount

  • currency: String has a filter named currency

  • status: Enum has a filter named status

  • productId: ID has a filter named productId

API Reference

Update Auctionofferoffer API

Updates offer: accepts/declines/counters by seller, withdraws by buyer before response. Enforces status transition rules, sets respondedAt. Triggers event.

Rest Route

The updateAuctionOfferOffer API REST controller can be triggered via the following route:

/v1/auctionofferoffers/:auctionOfferOfferId

Rest Request Parameters

The updateAuctionOfferOffer api has got 8 request parameters

Parameter Type Required Population
auctionOfferOfferId ID true request.params?.auctionOfferOfferId
counterOfferId ID false request.body?.counterOfferId
counterMessage String false request.body?.counterMessage
counterAmount Double false request.body?.counterAmount
message String false request.body?.message
status Enum false request.body?.status
expiresAt Date false request.body?.expiresAt
respondedAt Date false request.body?.respondedAt
auctionOfferOfferId : This id paremeter is used to select the required data object that will be updated
counterOfferId : References another offer (counter-offer chain).
counterMessage : Message accompanying seller's counter-offer (optional).
counterAmount : Counter-offer amount (when offer is COUNTERED).
message : Message/special notes from buyer (optional).
status : Current offer status (e.g., PENDING, ACCEPTED, DECLINED, COUNTERED, EXPIRED, CANCELLED).
expiresAt : When this offer expires (optional).
respondedAt : When the seller (or buyer, for counter-offer) responded/updated the offer status.

REST Request To access the api you can use the REST controller with the path PATCH /v1/auctionofferoffers/:auctionOfferOfferId

  axios({
    method: 'PATCH',
    url: `/v1/auctionofferoffers/${auctionOfferOfferId}`,
    data: {
            counterOfferId:"ID",  
            counterMessage:"String",  
            counterAmount:"Double",  
            message:"String",  
            status:"Enum",  
            expiresAt:"Date",  
            respondedAt:"Date",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auctionOfferOffer",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"auctionOfferOffer": {
		"id": "ID",
		"buyerId": "ID",
		"currency": "String",
		"productId": "ID",
		"counterOfferId": "ID",
		"counterMessage": "String",
		"counterAmount": "Double",
		"offerAmount": "Double",
		"message": "String",
		"sellerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"expiresAt": "Date",
		"respondedAt": "Date",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Auctionofferbid API

Creates a new bid for an auction product. Validates auction status, not seller, product type, bid window, and ensures min. increment. Updates product.currentBid and product.highestBidderId atomically. Triggers notification event.

Rest Route

The createAuctionOfferBid API REST controller can be triggered via the following route:

/v1/auctionofferbids

Rest Request Parameters

The createAuctionOfferBid api has got 4 request parameters

Parameter Type Required Population
bidAmount Double true request.body?.bidAmount
currency String true request.body?.currency
status Enum true request.body?.status
productId ID true request.body?.productId
bidAmount : Bid amount placed by the user.
currency : ISO currency for the bid (e.g., USD, EUR).
status : Bid status: ACTIVE, WON, LOST, CANCELLED.
productId : Product being bid on (must be AUCTION type).

REST Request To access the api you can use the REST controller with the path POST /v1/auctionofferbids

  axios({
    method: 'POST',
    url: '/v1/auctionofferbids',
    data: {
            bidAmount:"Double",  
            currency:"String",  
            status:"Enum",  
            productId:"ID",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auctionOfferBid",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"auctionOfferBid": {
		"id": "ID",
		"userId": "ID",
		"bidAmount": "Double",
		"placedAt": "Date",
		"currency": "String",
		"status": "Enum",
		"status_idx": "Integer",
		"productId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Auctionofferbid API

Gets a single bid (only visible to owner/admin or for auction history).

Rest Route

The getAuctionOfferBid API REST controller can be triggered via the following route:

/v1/auctionofferbids/:auctionOfferBidId

Rest Request Parameters

The getAuctionOfferBid api has got 1 request parameter

Parameter Type Required Population
auctionOfferBidId ID true request.params?.auctionOfferBidId
auctionOfferBidId : This id paremeter is used to query the required data object.

REST Request To access the api you can use the REST controller with the path GET /v1/auctionofferbids/:auctionOfferBidId

  axios({
    method: 'GET',
    url: `/v1/auctionofferbids/${auctionOfferBidId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auctionOfferBid",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"auctionOfferBid": {
		"id": "ID",
		"userId": "ID",
		"bidAmount": "Double",
		"placedAt": "Date",
		"currency": "String",
		"status": "Enum",
		"status_idx": "Integer",
		"productId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Auctionofferoffer API

Gets a single offer (shown to buyer/seller or admin).

Rest Route

The getAuctionOfferOffer API REST controller can be triggered via the following route:

/v1/auctionofferoffers/:auctionOfferOfferId

Rest Request Parameters

The getAuctionOfferOffer api has got 1 request parameter

Parameter Type Required Population
auctionOfferOfferId ID true request.params?.auctionOfferOfferId
auctionOfferOfferId : This id paremeter is used to query the required data object.

REST Request To access the api you can use the REST controller with the path GET /v1/auctionofferoffers/:auctionOfferOfferId

  axios({
    method: 'GET',
    url: `/v1/auctionofferoffers/${auctionOfferOfferId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auctionOfferOffer",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"auctionOfferOffer": {
		"id": "ID",
		"buyerId": "ID",
		"currency": "String",
		"productId": "ID",
		"counterOfferId": "ID",
		"counterMessage": "String",
		"counterAmount": "Double",
		"offerAmount": "Double",
		"message": "String",
		"sellerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"expiresAt": "Date",
		"respondedAt": "Date",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Auctionofferoffers API

Lists offers by product, user, status, or counterOffer chain.

Rest Route

The listAuctionOfferOffers API REST controller can be triggered via the following route:

/v1/auctionofferoffers

Rest Request Parameters The listAuctionOfferOffers api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/auctionofferoffers

  axios({
    method: 'GET',
    url: '/v1/auctionofferoffers',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auctionOfferOffers",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"auctionOfferOffers": [
		{
			"id": "ID",
			"buyerId": "ID",
			"currency": "String",
			"productId": "ID",
			"counterOfferId": "ID",
			"counterMessage": "String",
			"counterAmount": "Double",
			"offerAmount": "Double",
			"message": "String",
			"sellerId": "ID",
			"status": "Enum",
			"status_idx": "Integer",
			"expiresAt": "Date",
			"respondedAt": "Date",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Update Auctionofferbid API

Updates a bid’s status (allow only status update, e.g. CANCELLED, WIN/LOSE on admin settlement). Only owner/admin, and only if auction not ended or not settled. Triggers notification event.

Rest Route

The updateAuctionOfferBid API REST controller can be triggered via the following route:

/v1/auctionofferbids/:auctionOfferBidId

Rest Request Parameters

The updateAuctionOfferBid api has got 2 request parameters

Parameter Type Required Population
auctionOfferBidId ID true request.params?.auctionOfferBidId
status Enum false request.body?.status
auctionOfferBidId : This id paremeter is used to select the required data object that will be updated
status : Bid status: ACTIVE, WON, LOST, CANCELLED.

REST Request To access the api you can use the REST controller with the path PATCH /v1/auctionofferbids/:auctionOfferBidId

  axios({
    method: 'PATCH',
    url: `/v1/auctionofferbids/${auctionOfferBidId}`,
    data: {
            status:"Enum",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auctionOfferBid",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"auctionOfferBid": {
		"id": "ID",
		"userId": "ID",
		"bidAmount": "Double",
		"placedAt": "Date",
		"currency": "String",
		"status": "Enum",
		"status_idx": "Integer",
		"productId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Auctionofferoffer API

Creates a new offer for a fixed-price product, validating acceptOffers, type, eligibility, and product/seller/buyer active. Defaults to PENDING state. Triggers notification event.

Rest Route

The createAuctionOfferOffer API REST controller can be triggered via the following route:

/v1/auctionofferoffers

Rest Request Parameters

The createAuctionOfferOffer api has got 10 request parameters

Parameter Type Required Population
currency String true request.body?.currency
productId ID true request.body?.productId
counterOfferId ID false request.body?.counterOfferId
counterMessage String false request.body?.counterMessage
counterAmount Double false request.body?.counterAmount
offerAmount Double true request.body?.offerAmount
message String false request.body?.message
status Enum true request.body?.status
expiresAt Date false request.body?.expiresAt
respondedAt Date false request.body?.respondedAt
currency : ISO currency (e.g., USD, EUR) for the offer.
productId : Product the offer applies to (must be fixed-price, acceptOffers true).
counterOfferId : References another offer (counter-offer chain).
counterMessage : Message accompanying seller's counter-offer (optional).
counterAmount : Counter-offer amount (when offer is COUNTERED).
offerAmount : Primary offer amount from buyer.
message : Message/special notes from buyer (optional).
status : Current offer status (e.g., PENDING, ACCEPTED, DECLINED, COUNTERED, EXPIRED, CANCELLED).
expiresAt : When this offer expires (optional).
respondedAt : When the seller (or buyer, for counter-offer) responded/updated the offer status.

REST Request To access the api you can use the REST controller with the path POST /v1/auctionofferoffers

  axios({
    method: 'POST',
    url: '/v1/auctionofferoffers',
    data: {
            currency:"String",  
            productId:"ID",  
            counterOfferId:"ID",  
            counterMessage:"String",  
            counterAmount:"Double",  
            offerAmount:"Double",  
            message:"String",  
            status:"Enum",  
            expiresAt:"Date",  
            respondedAt:"Date",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auctionOfferOffer",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"auctionOfferOffer": {
		"id": "ID",
		"buyerId": "ID",
		"currency": "String",
		"productId": "ID",
		"counterOfferId": "ID",
		"counterMessage": "String",
		"counterAmount": "Double",
		"offerAmount": "Double",
		"message": "String",
		"sellerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"expiresAt": "Date",
		"respondedAt": "Date",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Auctionofferbids API

Lists bids by product, user, or auction, supports history/analytics.

Rest Route

The listAuctionOfferBids API REST controller can be triggered via the following route:

/v1/auctionofferbids

Rest Request Parameters The listAuctionOfferBids api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/auctionofferbids

  axios({
    method: 'GET',
    url: '/v1/auctionofferbids',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auctionOfferBids",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"auctionOfferBids": [
		{
			"id": "ID",
			"userId": "ID",
			"bidAmount": "Double",
			"placedAt": "Date",
			"currency": "String",
			"status": "Enum",
			"status_idx": "Integer",
			"productId": "ID",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Delete Auctionofferbid API

Soft-deletes a bid (for admin or self before auction ends).

Rest Route

The deleteAuctionOfferBid API REST controller can be triggered via the following route:

/v1/auctionofferbids/:auctionOfferBidId

Rest Request Parameters

The deleteAuctionOfferBid api has got 1 request parameter

Parameter Type Required Population
auctionOfferBidId ID true request.params?.auctionOfferBidId
auctionOfferBidId : This id paremeter is used to select the required data object that will be deleted

REST Request To access the api you can use the REST controller with the path DELETE /v1/auctionofferbids/:auctionOfferBidId

  axios({
    method: 'DELETE',
    url: `/v1/auctionofferbids/${auctionOfferBidId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auctionOfferBid",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"auctionOfferBid": {
		"id": "ID",
		"userId": "ID",
		"bidAmount": "Double",
		"placedAt": "Date",
		"currency": "String",
		"status": "Enum",
		"status_idx": "Integer",
		"productId": "ID",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Auctionofferoffer API

Soft-deletes an offer (allowed only in non-accepted/expired state).

Rest Route

The deleteAuctionOfferOffer API REST controller can be triggered via the following route:

/v1/auctionofferoffers/:auctionOfferOfferId

Rest Request Parameters

The deleteAuctionOfferOffer api has got 1 request parameter

Parameter Type Required Population
auctionOfferOfferId ID true request.params?.auctionOfferOfferId
auctionOfferOfferId : This id paremeter is used to select the required data object that will be deleted

REST Request To access the api you can use the REST controller with the path DELETE /v1/auctionofferoffers/:auctionOfferOfferId

  axios({
    method: 'DELETE',
    url: `/v1/auctionofferoffers/${auctionOfferOfferId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "auctionOfferOffer",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"auctionOfferOffer": {
		"id": "ID",
		"buyerId": "ID",
		"currency": "String",
		"productId": "ID",
		"counterOfferId": "ID",
		"counterMessage": "String",
		"counterAmount": "Double",
		"offerAmount": "Double",
		"message": "String",
		"sellerId": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"expiresAt": "Date",
		"respondedAt": "Date",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

After this prompt, the user may give you new instructions to update the output of this prompt or provide subsequent prompts about the project.