Provider API Reference

The Provider API is how a service provider publishes offers and fulfills the orders resellers place against them. 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-provider.json

Provider Brands

Endpoint	Method	Path	What it does
Create a brand	`POST`	`/provider/brands`	Brands are the visual identity offers display under instead of your team name.
List all brands for your team	`GET`	`/provider/brands`
Get a brand by id	`GET`	`/provider/brands/{id}`
Update a brand	`PATCH`	`/provider/brands/{id}`	Renaming or re-logoing a brand changes it for every offer displaying it.
Delete an unused brand	`DELETE`	`/provider/brands/{id}`	Only brands no offer references can be deleted.

Provider Customers

Endpoint	Method	Path	What it does
List customers	`GET`	`/provider/customers`	Customers are people who have placed an order for one of your offers.
Get customer detail	`GET`	`/provider/customers/{customerId}`	Detail view of a customer including the order items they have placed for your offers.

Provider Markets

Endpoint	Method	Path	What it does
Create a market	`POST`	`/provider/markets`
List all markets for your team	`GET`	`/provider/markets`
Get a market by id	`GET`	`/provider/markets/{id}`
Update a market	`PATCH`	`/provider/markets/{id}`
Delete a market	`DELETE`	`/provider/markets/{id}`
Add a geographic area to a market	`POST`	`/provider/markets/{id}/areas`	Areas compose a market.
Remove an area from a market	`DELETE`	`/provider/markets/{id}/areas/{areaId}`

Provider Offers

Provider: Manage your service offerings

Endpoint	Method	Path	What it does
Create a new offer	`POST`	`/provider/offers`	Create a new service offering as a provider.
List all your offers	`GET`	`/provider/offers`	Retrieve all offers created by your provider team.
Get a specific offer	`GET`	`/provider/offers/{id}`	Retrieve details of a specific offer you created.
Update an offer	`PATCH`	`/provider/offers/{id}`	Update an existing offer.
Delete an offer	`DELETE`	`/provider/offers/{id}`	Permanently delete an offer.
Publish an offer	`POST`	`/provider/offers/{id}/publish`	Validate an offer against the publish-readiness rules and, if it passes, set its status to active.
Duplicate an offer	`POST`	`/provider/offers/{id}/duplicate`	Create a new draft offer pre-filled from an existing one.
Download CSV template for bulk offer upload	`GET`	`/provider/offers/bulk-upload/template`	Download a CSV template file with headers and an example row.
Bulk upload offers from CSV	`POST`	`/provider/offers/bulk-upload`	Upload a CSV file to create multiple offers at once.
Validate CSV file without creating offers	`POST`	`/provider/offers/bulk-upload/validate`	Upload a CSV file to validate its structure and data without actually creating offers.
Bulk update offers from CSV	`POST`	`/provider/offers/bulk-update`	Upload a CSV file to update multiple existing offers at once, using the same template as bulk upload (GET /bulk-upload/template).
Validate a bulk-update CSV without updating offers	`POST`	`/provider/offers/bulk-update/validate`	Upload a CSV file to validate it against the bulk-update rules without writing anything.

Provider Orders

Provider: Fulfill orders from resellers

Endpoint	Method	Path	What it does
List order items to fulfill	`GET`	`/provider/orders`	Retrieve all order items for your offers that need fulfillment.
Get order item details	`GET`	`/provider/orders/{itemId}`	Retrieve detailed information about a specific order item for fulfillment.
Update order item status	`PATCH`	`/provider/orders/{itemId}/status`	Update the fulfillment status of an order item (e.g., accept, reject, schedule, complete).

Provider Webhooks

Provider: Receive order events for your offers

Endpoint	Method	Path	What it does
Register a webhook	`POST`	`/provider/webhooks`	Register an HTTPS endpoint to receive signed order-event deliveries.
List your registered webhooks	`GET`	`/provider/webhooks`	Secrets are masked — the full value is only ever returned at creation.
Get a webhook by id	`GET`	`/provider/webhooks/{id}`
Update a webhook (url, subscribed events, or active state)	`PATCH`	`/provider/webhooks/{id}`
Delete a webhook	`DELETE`	`/provider/webhooks/{id}`
List recent delivery attempts for a webhook	`GET`	`/provider/webhooks/{id}/deliveries`

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

Provider Brands

Provider Customers

Provider Markets

Provider Offers

Provider Orders

Provider Webhooks

Conventions

​Provider Brands

​Provider Customers

​Provider Markets

​Provider Offers

​Provider Orders

​Provider Webhooks

​Conventions

Provider Brands

Provider Customers

Provider Markets

Provider Offers

Provider Orders

Provider Webhooks

Conventions