Skip to main content
POST
/
Create offer
curl --request POST \
  --url https://api.sibipro.com/prod/offers/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "phone": "+1 (123) 456-7890"
  },
  "address": {
    "line1": "123 Main St",
    "line2": "Apt 101",
    "city": "Springfield",
    "stateOrProvince": "IL",
    "postalCode": "62701"
  },
  "product": {
    "sku": "GDF511PGRBB",
    "addons": [
      {
        "id": "install-aggregate-id",
        "quantity": 1
      },
      {
        "sku": "M007",
        "quantity": 1
      },
      {
        "sku": "M021",
        "quantity": 1
      }
    ]
  },
  "subBrandId": "<string>",
  "sendOfferImmediately": true,
  "allowCommonCarrier": true,
  "externalJobID": "<string>",
  "buyoutAmount": 50000,
  "includeUpsells": true,
  "allowExistingOffer": false
}
'
{
  "id": "testofferid",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "stateOrProvince": "<string>",
    "postalCode": "<string>",
    "country": "USA",
    "line2": "<string>"
  },
  "createdAt": "2024-01-20T12:00:00Z",
  "customerOfferLink": "<string>",
  "warnings": [
    "This product is only available via common carrier delivery for the selected address."
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
customer
object
required
​
address
object
required

Delivery address details

Example:
{
  "line1": "123 Main St",
  "line2": "Apt 101",
  "city": "Springfield",
  "stateOrProvince": "IL",
  "postalCode": "62701"
}
​
product
object
required

Replacement product and add-ons covered by warranty

Example:
{
  "sku": "GDF511PGRBB",
  "addons": [
    {
      "id": "install-aggregate-id",
      "quantity": 1
    },
    { "sku": "M007", "quantity": 1 },
    { "sku": "M021", "quantity": 1 }
  ]
}
​
subBrandId
string
required

The ID of the sub-brand used to determine customer-facing branding for the offer

​
sendOfferImmediately
boolean
default:true

Whether to send the offer email immediately after creation

Example:

true

​
allowCommonCarrier
boolean
default:true

Whether to allow offers for common carrier delivery properties

Example:

true

​
externalJobID
string
​
buyoutAmount
number

Buyout amount in cents (e.g., 50000 = $500.00). Customer can opt to receive this amount instead of a replacement product.

Required range: x >= 0
Example:

50000

​
includeUpsells
boolean
default:true

Whether to include upsells in the offer

Example:

true

​
allowExistingOffer
boolean
default:false

Creating an offer for an externalJobID that already has an active (pending or awaiting-customer) offer is rejected with DUPLICATE_ACTIVE_OFFER unless this is true, confirming the duplicate is intentional.

Example:

false

Response

Offer created successfully

​
id
string
required

Unique identifier for the offer

Example:

"testofferid"

​
address
object
required
​
createdAt
string<date-time>
required

Timestamp when the offer was created

Example:

"2024-01-20T12:00:00Z"

​
customerOfferLink
string
required

Link to allow the customer to authenticate and view the offer

​
warnings
string[]

Warnings for the offer

Example:
[
  "This product is only available via common carrier delivery for the selected address."
]