Skip to content
SIBISIBI Developers
Esc
↑↓navigate↵open⌘Jpreview

Get offer

Retrieves an offer by its ID.

GET/{id}
Path parameters
idstringrequired
The ID of the offer to retrieve
Responses
200Offer retrieved successfully
idstringrequired
The unique identifier for the offer
orderIdsstring[] | nullrequired
The unique identifiers of the associated orders created from an offer decision. Will be omitted/null if no order exists
thirdPartyIdstring | nullrequired
External system identifier for this offer. May be omitted or empty when not available
customerNamestringrequired
The full name of the customer associated with this offer
customerEmailstringrequired
The email address of the customer associated with this offer
customerPhonestringrequired
The phone number of the customer associated with this offer
fullAddressstring | nullrequired
The complete formatted address for the offer property
line1stringrequired
The first line of the property address (street address)
line2string | nullrequired
The second line of the property address (unit, suite, etc.). May be omitted or empty when not applicable
citystringrequired
The city of the property address
stateOrProvincestringrequired
The state or province of the property address
postalCodestringrequired
The postal or ZIP code of the property address
statusstringrequired
Current offer status
Allowed:pendingawaiting_customercanceledbuyout_acceptedorder_placedexpiredunknown
generatingUpsellsbooleanrequireddeprecated
Deprecated — use `processing`. True while upsells are still being generated asynchronously.
processingbooleanrequired
True while the offer’s asynchronous post-create pipeline (credit calculation and, if requested, upsell generation) is still running. The offer cannot be sent until this is false. Poll this endpoint until it clears.
acceptedByRolestring | nullrequired
The role of the person who accepted or processed the offer. Will be omitted/null if the offer has not been accepted
Allowed:curatorcustomer
offerSentAtstring | nullrequired
The timestamp when the offer was sent to the customer in ISO 8601 format
selectedOfferingobject[] | nullrequired
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 properties
Array of object
productIdstringrequired
The identifier of the selected product
curatorSelectedAddonsobject[]
Array of addons included by the curator for this product selection
Show properties
Array of object
addonIdstringrequired
The identifier of the addon product
customerSelectedAddonsobject[]
Array of addons explicitly selected by the customer for this product selection
Show properties
Array of object
addonIdstringrequired
The identifier of the addon product
offeringsobject[]required
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 properties
Array of object
productsobject[]required
Show properties
Array of object
productIdstringrequired
The identifier of a product associated with this offering option
curatorSelectedAddonsobject[]
Array of addons included by the curator for this offering product
Show properties
Array of object
addonIdstringrequired
The identifier of the addon product
buyoutAmountCentsnumber | nullrequired
The amount given to the customer for their buyout option on this offer, represented in cents
creditAmountCentsnumber | nullrequired
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
companySpendCentsnumberrequired
The amount the company will spend on this offer, represented in cents
customerSpendCentsnumber | nullrequired
The amount the customer will spend on this offer, represented in cents
offerPricingBreakdownobject | nullrequired
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 properties
subtotalnumberrequired
The subtotal amount for the offer checkout, represented in cents. null if unavailable
taxnumberrequired
The tax amount for the offer checkout, represented in cents. null if unavailable
totalnumberrequired
The total amount for the offer checkout, represented in cents. null if unavailable
discountsobject[]required
An array of discount objects applied to the offer checkout
Show properties
Array of object
amountnumberrequired
The discount amount, represented in cents
feesobject[]required
An array of fee objects applied to the offer checkout
Show properties
Array of object
amountnumberrequired
The fee amount, represented in cents
pricedItemsobject[] | nullrequired
An array of items included in the offer checkout pricing
Show properties
Array of object
idstringrequired
The unique identifier of the priced item
titlestringrequired
The title/name of the priced item
purchasePricenumberrequired
The purchase price of the item, represented in cents
addonsobject[]
Show properties
Array of object
idstringrequired
titlestringrequired
purchasePricenumberrequired
401Unauthorized - Missing or invalid authentication
codestringrequired
Error code indicating the type of error
messagestringrequired
Human-readable error message explaining what went wrong
detailsobject[]
Detailed validation errors when applicable
Show properties
Array of object
fieldstringrequired
errorstringrequired
403Forbidden - Caller is not allowed to view this offer
codestringrequired
Error code indicating the type of error
messagestringrequired
Human-readable error message explaining what went wrong
detailsobject[]
Detailed validation errors when applicable
Show properties
Array of object
fieldstringrequired
errorstringrequired
404Not found - Offer does not exist
codestringrequired
Error code indicating the type of error
messagestringrequired
Human-readable error message explaining what went wrong
detailsobject[]
Detailed validation errors when applicable
Show properties
Array of object
fieldstringrequired
errorstringrequired
500Internal server error
codestringrequired
Error code indicating the type of error
messagestringrequired
Human-readable error message explaining what went wrong
detailsobject[]
Detailed validation errors when applicable
Show properties
Array of object
fieldstringrequired
errorstringrequired
Request
curl -X GET "https://api.sibipro.com/prod/offers/string"
Response
{
  "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",
  "generatingUpsells": true,
  "processing": true,
  "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": 0,
  "customerSpendCents": 0,
  "offerPricingBreakdown": {
    "subtotal": 0,
    "tax": 0,
    "total": 0,
    "discounts": [
      {
        "amount": 0
      }
    ],
    "fees": [
      {
        "amount": 0
      }
    ],
    "pricedItems": [
      {
        "id": "string",
        "title": "string",
        "purchasePrice": 0,
        "addons": [
          {
            "id": "string",
            "title": "string",
            "purchasePrice": 0
          }
        ]
      }
    ]
  }
}