curl --request GET \
--url https://api.sibipro.com/offers/{id} \
--header 'Authorization: Bearer <token>'{
"id": "offer-123",
"orderIds": [
"<string>"
],
"thirdPartyId": "ext-123",
"customerName": "<string>",
"customerEmail": "<string>",
"customerPhone": "<string>",
"fullAddress": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"status": "pending",
"acceptedByRole": "curator",
"offerSentAt": "<string>",
"selectedOffering": [
{
"productId": "<string>",
"curatorSelectedAddons": [
{
"addonId": "<string>"
}
],
"customerSelectedAddons": [
{
"addonId": "<string>"
}
]
}
],
"offerings": [
{
"products": [
{
"productId": "<string>",
"curatorSelectedAddons": [
{
"addonId": "<string>"
}
]
}
]
}
],
"buyoutAmountCents": 50000,
"creditAmountCents": 75000,
"companySpendCents": 123,
"customerSpendCents": 123,
"offerPricingBreakdown": {
"subtotal": 123,
"tax": 123,
"total": 123,
"discounts": [
{
"amount": 123
}
],
"fees": [
{
"amount": 123
}
],
"pricedItems": [
{
"id": "<string>",
"title": "<string>",
"purchasePrice": 123,
"addons": [
{
"id": "<string>",
"title": "<string>",
"purchasePrice": 123
}
]
}
]
}
}Retrieves an offer by its ID.
curl --request GET \
--url https://api.sibipro.com/offers/{id} \
--header 'Authorization: Bearer <token>'{
"id": "offer-123",
"orderIds": [
"<string>"
],
"thirdPartyId": "ext-123",
"customerName": "<string>",
"customerEmail": "<string>",
"customerPhone": "<string>",
"fullAddress": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"status": "pending",
"acceptedByRole": "curator",
"offerSentAt": "<string>",
"selectedOffering": [
{
"productId": "<string>",
"curatorSelectedAddons": [
{
"addonId": "<string>"
}
],
"customerSelectedAddons": [
{
"addonId": "<string>"
}
]
}
],
"offerings": [
{
"products": [
{
"productId": "<string>",
"curatorSelectedAddons": [
{
"addonId": "<string>"
}
]
}
]
}
],
"buyoutAmountCents": 50000,
"creditAmountCents": 75000,
"companySpendCents": 123,
"customerSpendCents": 123,
"offerPricingBreakdown": {
"subtotal": 123,
"tax": 123,
"total": 123,
"discounts": [
{
"amount": 123
}
],
"fees": [
{
"amount": 123
}
],
"pricedItems": [
{
"id": "<string>",
"title": "<string>",
"purchasePrice": 123,
"addons": [
{
"id": "<string>",
"title": "<string>",
"purchasePrice": 123
}
]
}
]
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The ID of the offer to retrieve
Offer retrieved successfully
The unique identifier for the offer
"offer-123"
The unique identifiers of the associated orders created from an offer decision. Will be omitted/null if no order exists
External system identifier for this offer. May be omitted or empty when not available
"ext-123"
The full name of the customer associated with this offer
The email address of the customer associated with this offer
The phone number of the customer associated with this offer
The complete formatted address for the offer property
The first line of the property address (street address)
The second line of the property address (unit, suite, etc.). May be omitted or empty when not applicable
The city of the property address
The state or province of the property address
The postal or ZIP code of the property address
Current offer status
pending, generating_upsells, awaiting_customer, canceled, buyout_accepted, order_placed, expired, unknown "pending"
The role of the person who accepted or processed the offer. Will be omitted/null if the offer has not been accepted
curator, customer The timestamp when the offer was sent to the customer in ISO 8601 format
An array of selected offering objects, each containing the chosen products and any selected addons. This is the offering that was chosen by the customer or by the curator on behalf of the customer. If the offer is in a status that is not order_placed, this will be omitted/null
Show child attributes
An array of offering options presented in this offer. When the offer is initially created and the status is pending, only the isIncluded product may be present. Upsells are generated asynchronously and may not be present until the offer is updated
Show child attributes
The amount given to the customer for their buyout option on this offer, represented in cents
50000
The amount of credit applied to this offer, represented in cents. May be omitted/null when no credit is applied or when the offer has no upsells
75000
The amount the company will spend on this offer, represented in cents
The amount the customer will spend on this offer, represented in cents
Detailed pricing breakdown for the offer checkout, including subtotal, tax, total, discounts, fees, and priced items. Represents the customer pricing shown at checkout. Will be omitted/null if no offer checkout pricing data is available
Show child attributes