# SIBI Developer Documentation

> Build with the SIBI Platform and Research Agent APIs — clear guides, examples, and references.

## Docs

- [Build with SIBI](https://docs.sibipro.com/): APIs for product research, ordering, fulfillment, and events.

## Getting Started

- [Authentication](https://docs.sibipro.com/getting-started/authentication): Learn how to authenticate with the SIBI API
- [REST API Tokens](https://docs.sibipro.com/getting-started/rest-tokens): Scoped tokens for the SIBI REST APIs.
- [Checkout Links](https://docs.sibipro.com/getting-started/checkout-links): Checkout links unlock one-click ordering on Sibi from anywhere in the web. Can be configured using URL params.

## Research Agent

### Api Reference

- [Research Agent API](https://docs.sibipro.com/research-agent/api-reference)

#### Feedback

- [Send task feedback](https://docs.sibipro.com/research-agent/api-reference/feedback/send-research-feedback)

#### Tasks

- [Continue a task](https://docs.sibipro.com/research-agent/api-reference/tasks/continue-research-task)
- [Create a research task](https://docs.sibipro.com/research-agent/api-reference/tasks/create-research-task)
- [Get a task](https://docs.sibipro.com/research-agent/api-reference/tasks/get-research-task)

## Events

- [Receive Events](https://docs.sibipro.com/events/receive-events): Subscribe to Sibi events via webhooks.
- [Monitor Webhook Deliveries](https://docs.sibipro.com/events/webhook-deliveries): Inspect webhook deliveries, attempts, payloads, and responses in the SIBI Developer Portal, and re-send a delivery.
- [Asset Data](https://docs.sibipro.com/events/assets): Attributes on the asset payload body for events with the topic asset.created and asset.updated
- [Invoice Data](https://docs.sibipro.com/events/invoices): Attributes on the invoice payload body for events with the topic invoice.created
- [Order Data](https://docs.sibipro.com/events/orders): Attributes on the order payload body for events with the topics order.created and order.updated.
- [Order Exceptions](https://docs.sibipro.com/events/order.exceptions): This event is triggered when an order exception is added to an order. The event will have a topic of order.exception.created.
- [Order Cancellation Requests](https://docs.sibipro.com/events/order.cancellation-requests): Payloads for the order.cancellationrequest.created and order.cancellationrequest.updated topics.
- [Order Return Requests](https://docs.sibipro.com/events/order.return-requests): Payloads for the order.returnrequest.created, order.returnrequest.item-approved, and order.returnrequest.item-denied topics.
- [Offer Data](https://docs.sibipro.com/events/offers): Attributes on the offer payload body for events with the topic offer.created and offer.updated.

## Graphql

- [Making a GraphQL Request](https://docs.sibipro.com/graphql/making-a-graphql-request): The SIBI public API is a GraphQL API. You can use any GraphQL client to make requests to it.
- [Test GraphQL Environment](https://docs.sibipro.com/graphql/test-environment): Make test GraphQL requests without financial transactions

### Ordering

- [OrderingQuery.productCategories()](https://docs.sibipro.com/graphql/ordering/product-categories): Retrieve the list of product categories available for a given manufacturer.
- [OrderingQuery.searchProducts()](https://docs.sibipro.com/graphql/ordering/search-products): Search Products and see availability, pricing, and other Product information.
- [OrderingQuery.products()](https://docs.sibipro.com/graphql/ordering/list-products): Retrieve products for a manufacturer by SKU, with availability for an address.
- [OrderingQuery.reviewOrder()](https://docs.sibipro.com/graphql/ordering/review-order): Validate an Order and see valid parameters for placing an Order and other Order information before Order placement.
- [OrderingMutation.createOrder()](https://docs.sibipro.com/graphql/ordering/create-order): Create an Order for products. Currently you can create an Order for products that share the same manufacturer.
- [OrderingMutation.createDraftOrder()](https://docs.sibipro.com/graphql/ordering/create-draft-order): The Draft Order API allows you to create a draft order that can be used to validate an order and create a reference for the order that can later be used to place the order.
- [OrderingQuery.getDraftOrder()](https://docs.sibipro.com/graphql/ordering/get-draft-order): Retrieves a draft order by its ID. Can be used to retrieve updated pricing & availability information for the order.
- [OrderingQuery.draftOrders()](https://docs.sibipro.com/graphql/ordering/list-draft-orders): Retrieves a paginated list of draft orders. Can optionally filter by a search term.
- [OrderingMutation.deleteDraftOrder()](https://docs.sibipro.com/graphql/ordering/delete-draft-order): Deletes a draft order by its ID.
- [OrderingMutation.createOrderFromDraft()](https://docs.sibipro.com/graphql/ordering/create-order-from-draft): Creates an order from a draft order. Can be called multiple times for the same draft order to create multiple orders.
- [OrderingQuery.order()](https://docs.sibipro.com/graphql/ordering/get-order): Retrieve an order by its ID.
- [OrderingQuery.orders()](https://docs.sibipro.com/graphql/ordering/list-orders): Retrieve a paginated list of orders.
- [OrderingQuery.asset()](https://docs.sibipro.com/graphql/ordering/get-asset): Look up a single asset by its id.
- [OrderingQuery.assets()](https://docs.sibipro.com/graphql/ordering/list-assets): Look up the assets installed at a property, addressed the same way as reviewOrder(). Fails if the address does not resolve to a property in the system. With no address, browses every asset across all the properties the caller can see.

#### Types

- [OrderingAddress](https://docs.sibipro.com/graphql/ordering/ordering-address)
- [OrderingCustomerContactInfoInput](https://docs.sibipro.com/graphql/ordering/ordering-customer-contact-info-input)
- [OrderingCustomerContactInfoPartialInput](https://docs.sibipro.com/graphql/ordering/ordering-customer-contact-info-partial-input)
- [OrderingOrderProductInput](https://docs.sibipro.com/graphql/ordering/ordering-order-product-input)
- [OrderingOrderProduct](https://docs.sibipro.com/graphql/ordering/ordering-order-product)
- [OrderingProductWarranty](https://docs.sibipro.com/graphql/ordering/ordering-product-warranty)
- [OrderingReviewOrderWarranties](https://docs.sibipro.com/graphql/ordering/ordering-review-order-warranties)
- [OrderingProductAttribute](https://docs.sibipro.com/graphql/ordering/ordering-product-attribute)
- [OrderingProductFulfillmentMethod](https://docs.sibipro.com/graphql/ordering/ordering-product-fulfillment-method)
- [OrderingDistributionCenterFulfillmentAvailability](https://docs.sibipro.com/graphql/ordering/ordering-distribution-center-fulfillment-availability)
- [OrderingOrder](https://docs.sibipro.com/graphql/ordering/ordering-order)
- [OrderingOrderLineItem](https://docs.sibipro.com/graphql/ordering/ordering-order-line-item)
- [OrderingOrderFee](https://docs.sibipro.com/graphql/ordering/ordering-order-fee)
- [OrderingOrderException](https://docs.sibipro.com/graphql/ordering/ordering-order-exception)
- [OrderingOrderCancellationRequest](https://docs.sibipro.com/graphql/ordering/ordering-order-cancellation-request)
- [OrderingOrderCancellationRequestStatus](https://docs.sibipro.com/graphql/ordering/ordering-order-cancellation-request-status)
- [OrderingDeliveryContact](https://docs.sibipro.com/graphql/ordering/ordering-delivery-contact)
- [OrderingUser](https://docs.sibipro.com/graphql/ordering/ordering-user)
- [OrderingOrderImage](https://docs.sibipro.com/graphql/ordering/ordering-order-image)
- [OrderingOrderConfirmationNumber](https://docs.sibipro.com/graphql/ordering/ordering-order-confirmation-number)
- [OrderingOrderStatus](https://docs.sibipro.com/graphql/ordering/ordering-order-status)
- [OrderingAsset](https://docs.sibipro.com/graphql/ordering/ordering-asset)
- [OrderingAssetProperty](https://docs.sibipro.com/graphql/ordering/ordering-asset-property)
- [OrderingAssetDimensions](https://docs.sibipro.com/graphql/ordering/ordering-asset-dimensions)
- [OrderingWarrantyCoverage](https://docs.sibipro.com/graphql/ordering/ordering-warranty-coverage)

### Invoices

- [Get Invoices](https://docs.sibipro.com/graphql/invoices/get-invoices): The Invoices API enables you to retrieve invoices. These capabilities are exposed through a single query.

## REST

- [Making a REST Request](https://docs.sibipro.com/rest/making-a-rest-request): How to call the SIBI REST APIs
- [Test REST Environment](https://docs.sibipro.com/rest/test-environment): Make test REST requests without financial transactions

## REST API Reference

### Assets

- [Assets Guide](https://docs.sibipro.com/api-reference/assets/guide): Look up the assets installed at a property, their warranty coverage, and export them in bulk
- [Assets API](https://docs.sibipro.com/api-reference/assets)

#### Operations

- [Get asset](https://docs.sibipro.com/api-reference/assets/operations/get-asset)
- [List assets](https://docs.sibipro.com/api-reference/assets/operations/list-assets)

#### Exports

- [Create export](https://docs.sibipro.com/api-reference/assets/exports/create-export)
- [Get export](https://docs.sibipro.com/api-reference/assets/exports/get-export)

### Draft Orders

- [Draft Orders Guide](https://docs.sibipro.com/api-reference/draft-orders/guide): Preview an order with a draft order, then place it
- [Draft Orders API](https://docs.sibipro.com/api-reference/draft-orders)

#### Operations

- [Create draft order](https://docs.sibipro.com/api-reference/draft-orders/operations/create-draft-order)
- [Create order from draft](https://docs.sibipro.com/api-reference/draft-orders/operations/create-order-from-draft)
- [Get draft order](https://docs.sibipro.com/api-reference/draft-orders/operations/get-draft-order)

### Feedback

- [Feedback Guide](https://docs.sibipro.com/api-reference/feedback/guide): Send the Sibi team questions, error reports, and feedback about the API
- [Feedback API](https://docs.sibipro.com/api-reference/feedback)

#### Operations

- [Send feedback](https://docs.sibipro.com/api-reference/feedback/operations/create-feedback)

### Invoices

- [Invoices API](https://docs.sibipro.com/api-reference/invoices)

#### Operations

- [List invoices](https://docs.sibipro.com/api-reference/invoices/operations/list-invoices)

### Offers

- [Offers Guide](https://docs.sibipro.com/api-reference/offers/guide): Accept and manage home warranty claims through customizable offers
- [Offers API](https://docs.sibipro.com/api-reference/offers)

#### Operations

- [Accept offer](https://docs.sibipro.com/api-reference/offers/operations/post-id-accept)
- [Accept offer buyout](https://docs.sibipro.com/api-reference/offers/operations/post-id-accept-buyout)
- [Cancel offer](https://docs.sibipro.com/api-reference/offers/operations/post-id-cancel)
- [Create offer](https://docs.sibipro.com/api-reference/offers/operations/post)
- [Get offer](https://docs.sibipro.com/api-reference/offers/operations/get-id)
- [Get offers](https://docs.sibipro.com/api-reference/offers/operations/get)
- [Get sub-brands](https://docs.sibipro.com/api-reference/offers/operations/get-sub-brands)
- [Send offer](https://docs.sibipro.com/api-reference/offers/operations/post-id-send)
- [Update offer buyout amount](https://docs.sibipro.com/api-reference/offers/operations/post-id-buyout)
- [Update offer credit amount](https://docs.sibipro.com/api-reference/offers/operations/post-id-credit)

### Orders

- [Orders API](https://docs.sibipro.com/api-reference/orders)

#### Operations

- [Cancel order](https://docs.sibipro.com/api-reference/orders/operations/post-id-cancel)
- [Create order](https://docs.sibipro.com/api-reference/orders/operations/post)
- [Get order](https://docs.sibipro.com/api-reference/orders/operations/get-id)
- [Get order PDF](https://docs.sibipro.com/api-reference/orders/operations/get-order-pdf)
- [List orders](https://docs.sibipro.com/api-reference/orders/operations/list-orders)
- [Start a return](https://docs.sibipro.com/api-reference/orders/operations/create-return-request)

### Products

- [Products Guide](https://docs.sibipro.com/api-reference/products/guide): Search the catalog, and look up product details and available add-ons by SKU and delivery address
- [Products API](https://docs.sibipro.com/api-reference/products)

#### Operations

- [Get product details with available add-ons (deprecated)](https://docs.sibipro.com/api-reference/products/operations/get-sku)
- [Search the product catalog](https://docs.sibipro.com/api-reference/products/operations/get)

#### Categories

- [Product Categories API](https://docs.sibipro.com/api-reference/products/categories)

##### Operations

- [List product categories](https://docs.sibipro.com/api-reference/products/categories/operations/list-product-categories)

#### Suppliers

- [Product Suppliers API](https://docs.sibipro.com/api-reference/products/suppliers)

##### Operations

- [List product suppliers](https://docs.sibipro.com/api-reference/products/suppliers/operations/list-product-suppliers)

## Agent resources

- [llms-full.txt](https://docs.sibipro.com/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://docs.sibipro.com/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://docs.sibipro.com/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://docs.sibipro.com/openapi.json.
- [API catalog](https://docs.sibipro.com/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [AI catalog](https://docs.sibipro.com/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs).
- [agent-readability.json](https://docs.sibipro.com/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://docs.sibipro.com/sitemap.xml): Every indexable page URL with its last-modified date.