Create offer

POST/

Authorization

AuthorizationBearer token · headerrequired

API token from the SIBI developer dashboard (developer.sibipro.com), sent as Authorization: Bearer <token>.

Scopes:write:offers

Request body

application/json

customerCustomerrequired

Show properties

firstNamestringrequired

First name of the customer

min length 1 · max length 100

lastNamestringrequired

Last name of the customer

min length 1 · max length 100

emailstring<email>required

Valid email address of the customer

phonestringrequired

Customer contact phone number in international format

matches ^\+?[\d\s-()]{10,}$

addressobjectrequired

Delivery address details

Show properties

line1stringrequired

min length 1 · max length 100

line2string

min length 1 · max length 100

citystringrequired

min length 1 · max length 100

stateOrProvincestringrequired

min length 2 · max length 2

postalCodestringrequired

matches ^\d{5}(-\d{4})?$

productobjectrequired

Replacement product and add-ons covered by warranty

Show properties

skustringrequired

Product SKU

manufacturerstring

Product manufacturer

default: "ge"

Allowed:gebestbuylowes

addonsobject[]

Optional add-ons for the product. Each entry must specify at least one of id or sku. Use id for aggregate add-on groups (like Install or Disposal) and sku for individual recommended parts or add-on products.

Show properties

Array of object

idstring

The id of an aggregate add-on group (e.g. Install, Disposal). Use the parent group id from the addOns array returned by GET /products/{sku}.

skustring

The sku of an individual add-on product or recommended part. Use the sku from the recommendedParts array returned by GET /products/{sku}.

quantityintegerrequired

sendOfferImmediatelyboolean

Whether to send the offer email immediately after creation

default: true

allowCommonCarrierboolean

Whether to allow offers for common carrier delivery properties

default: true

externalJobIDstring

buyoutAmountnumber

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

min 0

creditAmountinteger

Credit amount in cents (e.g., 200000 = $2,000.00) that the customer has to spend in the marketplace. When omitted, defaults to the price of the replacement product and add-ons.

min 0

includeUpsellsboolean

Whether to include upsells in the offer

default: true

subBrandIdstringrequired

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

Responses

201

Offer created successfully

idstringrequired

Unique identifier for the offer

addressobjectrequired

Show properties

line1stringrequired

min length 1 · max length 100

line2string

min length 1 · max length 100

citystringrequired

min length 1 · max length 100

stateOrProvincestringrequired

min length 2 · max length 2

postalCodestringrequired

matches ^\d{5}(-\d{4})?$

countrystringrequired

Country of the property address

createdAtstring<date-time>required

Timestamp when the offer was created

customerOfferLinkstringrequired

Link to allow the customer to authenticate and view the offer

warningsstring[]

Warnings for the offer

400

Bad request - Invalid input data

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

401

Unauthorized - 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

403

Forbidden - The presented token does not carry the required scope

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

500

Internal 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 POST 'https://api.sibipro.com/prod/offers/' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "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
      }
    ]
  },
  "sendOfferImmediately": true,
  "allowCommonCarrier": true,
  "externalJobID": "string",
  "buyoutAmount": 50000,
  "creditAmount": 200000,
  "includeUpsells": true,
  "subBrandId": "string"
}'

const response = await fetch("https://api.sibipro.com/prod/offers/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"customer\": {\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\",\n    \"email\": \"john@example.com\",\n    \"phone\": \"+1 (123) 456-7890\"\n  },\n  \"address\": {\n    \"line1\": \"123 Main St\",\n    \"line2\": \"Apt 101\",\n    \"city\": \"Springfield\",\n    \"stateOrProvince\": \"IL\",\n    \"postalCode\": \"62701\"\n  },\n  \"product\": {\n    \"sku\": \"GDF511PGRBB\",\n    \"addons\": [\n      {\n        \"id\": \"install-aggregate-id\",\n        \"quantity\": 1\n      },\n      {\n        \"sku\": \"M007\",\n        \"quantity\": 1\n      },\n      {\n        \"sku\": \"M021\",\n        \"quantity\": 1\n      }\n    ]\n  },\n  \"sendOfferImmediately\": true,\n  \"allowCommonCarrier\": true,\n  \"externalJobID\": \"string\",\n  \"buyoutAmount\": 50000,\n  \"creditAmount\": 200000,\n  \"includeUpsells\": true,\n  \"subBrandId\": \"string\"\n}"
});

Response

{
  "id": "testofferid",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "stateOrProvince": "st",
    "postalCode": "string",
    "country": "USA"
  },
  "createdAt": "2024-01-20T12:00:00Z",
  "customerOfferLink": "string",
  "warnings": [
    "This product is only available via common carrier delivery for the selected address."
  ]
}

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input parameters",
  "details": [
    {
      "field": "customer.email",
      "error": "Invalid email"
    },
    {
      "field": "address.postalCode",
      "error": "Invalid"
    }
  ]
}

{
  "code": "ADDRESS_PROCESSING_ERROR",
  "message": "The provided address is invalid or could not be found"
}

{
  "code": "INVALID_SUB_BRAND_ID",
  "message": "The provided sub-brand ID is invalid or not found"
}

{
  "code": "PRODUCT_OUT_OF_STOCK",
  "message": "Product 123 is out of stock for the selected address."
}

{
  "code": "UNAUTHORIZED",
  "message": "Missing authentication token"
}

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "The presented token is missing the `write:offers` scope, which this endpoint requires. Create a token with the scopes you need at https://developer.sibipro.com."
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred"
}