> ## Documentation Index > Fetch the complete documentation index at: https://offergrid.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Reseller API Reference > Every reseller endpoint — catalog, availability, orders, links, and customers The Reseller API is how a reseller partner browses the catalog, checks what is available at a service address, and places and tracks orders on behalf of customers. Every endpoint below links to its full reference page with parameters, schemas, and a request builder. **Base URL** `https://api.offergrid.io` **Authentication** `x-api-key: YOUR_TEAM_API_KEY` on every request — see [Authentication](/docs/api-reference/authentication). **OpenAPI spec** [`openapi-reseller.json`](/docs/openapi/openapi-reseller.json) ## Reseller Availability Reseller: Find offers available at a service address | Endpoint | Method | Path | What it does | | -------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------ | ------------------------------------------------------------------------------------------ | | [Find available offers for an address](/docs/reseller-api-reference/reseller-availability/find-available-offers-for-an-address) | `POST` | `/reseller/availability` | Given a service address, returns every offer your reseller team can sell at that location. | ## Reseller Catalog Reseller: Browse available service offerings | Endpoint | Method | Path | What it does | | ------------------------------------------------------------------------------------------- | ------ | ------------------------ | -------------------------------------------------------------------- | | [Browse available offers](/docs/reseller-api-reference/reseller-catalog/browse-available-offers) | `GET` | `/reseller/catalog` | Browse all service offers available to your reseller team. | | [Get offer details](/docs/reseller-api-reference/reseller-catalog/get-offer-details) | `GET` | `/reseller/catalog/{id}` | Retrieve detailed information about a specific offer in the catalog. | ## Reseller Customers Reseller: Manage customers and leads | Endpoint | Method | Path | What it does | | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | [List customers and leads](/docs/reseller-api-reference/reseller-customers/list-customers-and-leads) | `GET` | `/reseller/customers` | Returns this reseller team's customers (people who have placed an order) and leads (people added manually, by API import, or by event). | | [Add a customer or lead manually](/docs/reseller-api-reference/reseller-customers/add-a-customer-or-lead-manually) | `POST` | `/reseller/customers` | Create a new lead or customer record. | | [Get customer detail (with this reseller's orders)](/docs/reseller-api-reference/reseller-customers/get-customer-detail-with-this-resellers-orders) | `GET` | `/reseller/customers/{customerId}` | | | [Update customer notes / tags / status / kind](/docs/reseller-api-reference/reseller-customers/update-customer-notes-tags-status-kind) | `PATCH` | `/reseller/customers/{customerId}` | Update reseller-private fields. | | [Remove customer from this reseller's list](/docs/reseller-api-reference/reseller-customers/remove-customer-from-this-resellers-list) | `DELETE` | `/reseller/customers/{customerId}` | Removes the link between this reseller and the customer. | ## Reseller Links Reseller: Manage shareable customer links | Endpoint | Method | Path | What it does | | ------------------------------------------------------------------------------------------- | -------- | ---------------------- | ------------------------------------------------------------------------------------------------- | | [Create a shareable link](/docs/reseller-api-reference/reseller-links/create-a-shareable-link) | `POST` | `/reseller/links` | Generate a shareable link for tenants to order services at a specific address. | | [List all shareable links](/docs/reseller-api-reference/reseller-links/list-all-shareable-links) | `GET` | `/reseller/links` | Retrieve all shareable links created by your reseller team. | | [Get link details](/docs/reseller-api-reference/reseller-links/get-link-details) | `GET` | `/reseller/links/{id}` | Retrieve detailed information about a specific link, including recent orders placed via the link. | | [Update a link](/docs/reseller-api-reference/reseller-links/update-a-link) | `PATCH` | `/reseller/links/{id}` | Update link properties such as property name, move-in date, or status. | | [Delete a link](/docs/reseller-api-reference/reseller-links/delete-a-link) | `DELETE` | `/reseller/links/{id}` | Permanently delete a shareable link. | ## Reseller Orders Reseller: Place and manage orders | Endpoint | Method | Path | What it does | | ------------------------------------------------------------------------------ | ------- | ------------------------------ | ------------------------------------------------------------------------------------------------------- | | [Place a new order](/docs/reseller-api-reference/reseller-orders/place-a-new-order) | `POST` | `/reseller/orders` | Create a new order for one or more service offers. | | [List your orders](/docs/reseller-api-reference/reseller-orders/list-your-orders) | `GET` | `/reseller/orders` | Retrieve all orders placed by your reseller team. | | [Get order details](/docs/reseller-api-reference/reseller-orders/get-order-details) | `GET` | `/reseller/orders/{id}` | Retrieve detailed information about a specific order, including all items and their fulfillment status. | | [Cancel an order](/docs/reseller-api-reference/reseller-orders/cancel-an-order) | `PATCH` | `/reseller/orders/{id}/cancel` | Cancel a pending or submitted order. | ## Reseller Webhooks Reseller: Receive order events for the orders you placed | Endpoint | Method | Path | What it does | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------ | ------------------------------------------------------------------------------------------------ | | [Register a webhook](/docs/reseller-api-reference/reseller-webhooks/register-a-webhook) | `POST` | `/reseller/webhooks` | Register an HTTPS endpoint to receive signed order-event deliveries for orders your team placed. | | [List your registered webhooks](/docs/reseller-api-reference/reseller-webhooks/list-your-registered-webhooks) | `GET` | `/reseller/webhooks` | Secrets are masked — the full value is only ever returned at creation. | | [Get a webhook by id](/docs/reseller-api-reference/reseller-webhooks/get-a-webhook-by-id) | `GET` | `/reseller/webhooks/{id}` | | | [Update a webhook (url, subscribed events, or active state)](/docs/reseller-api-reference/reseller-webhooks/update-a-webhook-url-subscribed-events-or-active-state) | `PATCH` | `/reseller/webhooks/{id}` | | | [Delete a webhook](/docs/reseller-api-reference/reseller-webhooks/delete-a-webhook) | `DELETE` | `/reseller/webhooks/{id}` | | | [List recent delivery attempts for a webhook](/docs/reseller-api-reference/reseller-webhooks/list-recent-delivery-attempts-for-a-webhook) | `GET` | `/reseller/webhooks/{id}/deliveries` | The 50 most recent attempts, newest first. | ## Conventions Every endpoint on this page follows the shared [API conventions](/docs/api-reference/conventions) for list responses, identifiers, timestamps, and money, and the shared [error format](/docs/api-reference/errors).