Cancel offer

Cancels an offer. The offer must not already be in a resolved status (canceled, buyout accepted, order placed, or expired).

POST/{id}/cancel

Authorization

AuthorizationBearer token · headerrequired

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

Scopes:write:offers

Path parameters

idstringrequired

The ID of the offer to cancel

Responses

200

Offer canceled successfully

offerIdstringrequired

Unique identifier for the canceled offer

statusstringrequired

Status of the offer after cancellation

canceledAtstring<date-time>required

Timestamp when the offer was canceled

400

Bad request - Offer is not in a cancelable state

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 - Caller can view this offer but is not allowed to cancel it

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

404

Not found - Offer does not exist or caller is not allowed to view it

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/string/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.sibipro.com/prod/offers/string/cancel", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

Response

{
  "offerId": "offer-123",
  "status": "CANCELED",
  "canceledAt": "2024-01-20T12:00:00Z"
}

{
  "code": "OFFER_CANCELLATION_ERROR",
  "message": "Offer cannot be canceled because it is in \"canceled\" status"
}

{
  "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": "FORBIDDEN",
  "message": "User does not have permission to cancel this offer"
}

{
  "code": "OFFER_NOT_FOUND",
  "message": "Offer not found"
}

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