Reseller API Reference

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.ioAuthentication x-api-key: YOUR_TEAM_API_KEY on every request — see Authentication.OpenAPI spec 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	`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	`GET`	`/reseller/catalog`	Browse all service offers available to your reseller team.
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	`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	`POST`	`/reseller/customers`	Create a new lead or customer record.
Get customer detail (with this reseller’s orders)	`GET`	`/reseller/customers/{customerId}`
Update customer notes / tags / status / kind	`PATCH`	`/reseller/customers/{customerId}`	Update reseller-private fields.
Remove customer from this reseller’s 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	`POST`	`/reseller/links`	Generate a shareable link for tenants to order services at a specific address.
List all shareable links	`GET`	`/reseller/links`	Retrieve all shareable links created by your reseller team.
Get link details	`GET`	`/reseller/links/{id}`	Retrieve detailed information about a specific link, including recent orders placed via the link.
Update a link	`PATCH`	`/reseller/links/{id}`	Update link properties such as property name, move-in date, or status.
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	`POST`	`/reseller/orders`	Create a new order for one or more service offers.
List your orders	`GET`	`/reseller/orders`	Retrieve all orders placed by your reseller team.
Get order details	`GET`	`/reseller/orders/{id}`	Retrieve detailed information about a specific order, including all items and their fulfillment status.
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	`POST`	`/reseller/webhooks`	Register an HTTPS endpoint to receive signed order-event deliveries for orders your team placed.
List your registered webhooks	`GET`	`/reseller/webhooks`	Secrets are masked — the full value is only ever returned at creation.
Get a webhook by id	`GET`	`/reseller/webhooks/{id}`
Update a webhook (url, subscribed events, or active state)	`PATCH`	`/reseller/webhooks/{id}`
Delete a webhook	`DELETE`	`/reseller/webhooks/{id}`
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 for list responses, identifiers, timestamps, and money, and the shared error format.

Getting Started

Core Concepts

Provider API

Reseller API

Public API

Reseller Availability

Reseller Catalog

Reseller Customers

Reseller Links

Reseller Orders

Reseller Webhooks

Conventions

​Reseller Availability

​Reseller Catalog

​Reseller Customers

​Reseller Links

​Reseller Orders

​Reseller Webhooks

​Conventions

Reseller Availability

Reseller Catalog

Reseller Customers

Reseller Links

Reseller Orders

Reseller Webhooks

Conventions