Skip to content

Get the demo draft offer

GET
/api/offers
curl --request GET \
--url https://example.com/api/offers \
--cookie better-auth.session_token=<better-auth.session_token>

The current mocked draft offer.

Media type application/json
object
offer
required

A draft or accepted offer for a customer request.

object
id
required
string
customerId
required
string | null
requestId
required
string | null
userId
required
string | null
name
required
string
status
required
string
Allowed values: draft accepted rejected imported
currency
required
string
discountPercent
required
number
<= 100
discountAmount
required
number
notes
required
Array<string>
unmatched
required
Array<string>
items
required
Array<object>

A product line item included in an offer.

object
id
string
offerId
string
productId
required
string | null
name
required
string
description
required
string
quantity
required
number
> 0
unitPriceNet
required
number
vatRate
required
number
unitGrossPrice
required
number
totalNet
required
number
totalGross
required
number
requestItem
required
string
rationale
required
string
matchSource
required
string | null
Allowed values: exact semantic manual
matchScore
required
number | null
position
required
integer
product

Product snapshot used to render an offer line without frontend fixture lookup.

object
id
required
string
sku
string
name
required
string
description
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
customerName
string | null
clientRequest
string | null
userName
string | null
Example
{
"offer": {
"id": "offer-demo-001",
"status": "draft",
"items": [
{
"matchSource": "exact"
}
]
}
}

No valid Better Auth session was present.

Media type application/json

Returned when no valid Better Auth session is present.

object
error
required
string
Example generated
{
"error": "example"
}