# Offergrid Docs ## Docs - [API Documentation](https://offergrid.io/docs/api-documentation.md): Complete API reference and integration guides for engineering teams - [API Authentication](https://offergrid.io/docs/api-reference/authentication.md): Detailed guide to authenticating with the Offergrid API - [Introduction](https://offergrid.io/docs/api-reference/introduction.md): Offergrid API documentation for managing service offerings and partner links - [Authentication](https://offergrid.io/docs/authentication.md): Learn how to authenticate with the Offergrid API - [How It Works](https://offergrid.io/docs/how-it-works.md): Understand how Offergrid connects service providers with reseller partners - [Welcome to Offergrid](https://offergrid.io/docs/index.md): The B2B marketplace connecting service providers with reseller partners - [Get customer detail](https://offergrid.io/docs/provider-api-reference/provider-customers/get-customer-detail.md): Detail view of a customer including the order items they have placed for your offers. - [List customers](https://offergrid.io/docs/provider-api-reference/provider-customers/list-customers.md): Customers are people who have placed an order for one of your offers. This list does not include reseller-side leads. - [Add a geographic area to a market](https://offergrid.io/docs/provider-api-reference/provider-markets/add-a-geographic-area-to-a-market.md): Areas compose a market. Supply the `type` field and the matching fields: postalCodes (postal), admin* fields (admin), geometry (polygon), or h3Cells (h3). Use operation=exclude to carve a hole out of the market. - [Create a market](https://offergrid.io/docs/provider-api-reference/provider-markets/create-a-market.md) - [Delete a market](https://offergrid.io/docs/provider-api-reference/provider-markets/delete-a-market.md) - [Get a market by id](https://offergrid.io/docs/provider-api-reference/provider-markets/get-a-market-by-id.md) - [List all markets for your team](https://offergrid.io/docs/provider-api-reference/provider-markets/list-all-markets-for-your-team.md) - [Remove an area from a market](https://offergrid.io/docs/provider-api-reference/provider-markets/remove-an-area-from-a-market.md) - [Update a market](https://offergrid.io/docs/provider-api-reference/provider-markets/update-a-market.md) - [Bulk upload offers from CSV](https://offergrid.io/docs/provider-api-reference/provider-offers/bulk-upload-offers-from-csv.md): Upload a CSV file to create multiple offers at once. Download the template first using GET /bulk-upload/template. The CSV supports linking offers to markets using the "marketNames" column (comma-separated market names). Markets must already exist before uploading - create them first via the markets… - [Create a new offer](https://offergrid.io/docs/provider-api-reference/provider-offers/create-a-new-offer.md): Create a new service offering as a provider. The offer will be associated with your team. - [Delete an offer](https://offergrid.io/docs/provider-api-reference/provider-offers/delete-an-offer.md): Permanently delete an offer. You can only delete your own offers. - [Download CSV template for bulk offer upload](https://offergrid.io/docs/provider-api-reference/provider-offers/download-csv-template-for-bulk-offer-upload.md): Download a CSV template file with headers and an example row. Use this template to bulk upload offers. - [Duplicate an offer](https://offergrid.io/docs/provider-api-reference/provider-offers/duplicate-an-offer.md): Create a new draft offer pre-filled from an existing one. The copy gets a "(Copy)" name, resets to draft status, omits the unique SKU, and strips known sample pricing entries. - [Get a specific offer](https://offergrid.io/docs/provider-api-reference/provider-offers/get-a-specific-offer.md): Retrieve details of a specific offer you created. - [List all your offers](https://offergrid.io/docs/provider-api-reference/provider-offers/list-all-your-offers.md): Retrieve all offers created by your provider team. - [Publish an offer](https://offergrid.io/docs/provider-api-reference/provider-offers/publish-an-offer.md): Validate an offer against the publish-readiness rules and, if it passes, set its status to active. Returns 400 with structured validationErrors when the offer is not ready to publish. - [Update an offer](https://offergrid.io/docs/provider-api-reference/provider-offers/update-an-offer.md): Update an existing offer. You can only update your own offers. - [Validate CSV file without creating offers](https://offergrid.io/docs/provider-api-reference/provider-offers/validate-csv-file-without-creating-offers.md): Upload a CSV file to validate its structure and data without actually creating offers. This is useful for checking your CSV before performing the actual bulk upload. - [Get order item details](https://offergrid.io/docs/provider-api-reference/provider-orders/get-order-item-details.md): Retrieve detailed information about a specific order item for fulfillment. - [List order items to fulfill](https://offergrid.io/docs/provider-api-reference/provider-orders/list-order-items-to-fulfill.md): Retrieve all order items for your offers that need fulfillment. Each item represents a single offer ordered by a reseller. - [Update order item status](https://offergrid.io/docs/provider-api-reference/provider-orders/update-order-item-status.md): Update the fulfillment status of an order item (e.g., accept, reject, schedule, complete). Use this to manage the order workflow from acceptance to completion. - [Provider Documentation](https://offergrid.io/docs/provider-documentation.md): Complete guide for service providers using Offergrid - [API Integration Guide](https://offergrid.io/docs/providers/api-integration.md): Integrate Offergrid with your existing systems - [Provider Business Case](https://offergrid.io/docs/providers/business-case.md): How Offergrid reduces fulfillment costs by enabling direct API orders from PMS partners - [Creating Offers](https://offergrid.io/docs/providers/creating-offers.md): Learn how to create and publish service offerings - [Fulfillment Best Practices](https://offergrid.io/docs/providers/fulfillment-best-practices.md): Tips and strategies for smooth order fulfillment - [Provider Overview](https://offergrid.io/docs/providers/index.md): Start distributing your services through the Offergrid marketplace - [Service Categories](https://offergrid.io/docs/providers/offer-categories.md): Understanding service categories and category-specific requirements - [Offer Visibility & Access Control](https://offergrid.io/docs/providers/offer-visibility.md): Control which resellers can see and order your services - [Order Lifecycle & Status Updates](https://offergrid.io/docs/providers/order-workflow.md): Understanding order status progression and when to update - [Preferred Reseller Programs](https://offergrid.io/docs/providers/preferred-resellers.md): Setting up and managing preferred partner lists - [Pricing Strategies](https://offergrid.io/docs/providers/pricing-strategies.md): Understanding different pricing models and how to set them up - [Provider Quick Start](https://offergrid.io/docs/providers/quickstart.md): Get up and running as a service provider in minutes - [Receiving Orders](https://offergrid.io/docs/providers/receiving-orders.md): Understanding incoming orders from resellers - [Managing Reseller Relationships](https://offergrid.io/docs/providers/reseller-relationships.md): Building and maintaining partnerships with resellers - [Webhooks](https://offergrid.io/docs/providers/webhooks.md): Receive real-time notifications about orders and events - [Quick Start](https://offergrid.io/docs/quickstart.md): Get started with Offergrid in minutes - [Find available offers for an address](https://offergrid.io/docs/reseller-api-reference/reseller-availability/find-available-offers-for-an-address.md): Given a service address, returns every offer your reseller team can sell at that location. Coverage is evaluated against each offer’s availability rules — postal codes and active market areas (including state-wide and city-level coverage) — and provider visibility settings (all resellers, preferred… - [Browse available offers](https://offergrid.io/docs/reseller-api-reference/reseller-catalog/browse-available-offers.md): Browse all service offers available to your reseller team. Visibility is based on provider settings (all resellers, preferred resellers, or selected resellers). Supports filtering by category, price range, ZIP code, and search terms. Results are sorted by relevance! - [Get offer details](https://offergrid.io/docs/reseller-api-reference/reseller-catalog/get-offer-details.md): Retrieve detailed information about a specific offer in the catalog. You can only view offers that are available to your reseller team. - [Add a customer or lead manually](https://offergrid.io/docs/reseller-api-reference/reseller-customers/add-a-customer-or-lead-manually.md): Create a new lead or customer record. Resellers use this to track contacts from off-platform sources before they place an order. - [Get customer detail (with this reseller's orders)](https://offergrid.io/docs/reseller-api-reference/reseller-customers/get-customer-detail-with-this-resellers-orders.md) - [List customers and leads](https://offergrid.io/docs/reseller-api-reference/reseller-customers/list-customers-and-leads.md): Returns this reseller team's customers (people who have placed an order) and leads (people added manually, by API import, or by event). Filter via the kind query param. - [Remove customer from this reseller's list](https://offergrid.io/docs/reseller-api-reference/reseller-customers/remove-customer-from-this-resellers-list.md): Removes the link between this reseller and the customer. The shared Customer record itself is preserved so other teams' views are unaffected. - [Update customer notes / tags / status / kind](https://offergrid.io/docs/reseller-api-reference/reseller-customers/update-customer-notes-tags-status-kind.md): Update reseller-private fields. To update the underlying contact info (name, email, address) the contact themselves must place a new order, since those fields are shared across all teams that know this person. - [Create a shareable link](https://offergrid.io/docs/reseller-api-reference/reseller-links/create-a-shareable-link.md): Generate a shareable link for tenants to order services at a specific address. The link can be shared via email or SMS. Tenants can use the link to browse available offers and place orders without needing to create an account. - [Delete a link](https://offergrid.io/docs/reseller-api-reference/reseller-links/delete-a-link.md): Permanently delete a shareable link. Orders placed via this link will be preserved. - [Get link details](https://offergrid.io/docs/reseller-api-reference/reseller-links/get-link-details.md): Retrieve detailed information about a specific link, including recent orders placed via the link. - [List all shareable links](https://offergrid.io/docs/reseller-api-reference/reseller-links/list-all-shareable-links.md): Retrieve all shareable links created by your reseller team. Includes view and order counts for analytics. - [Update a link](https://offergrid.io/docs/reseller-api-reference/reseller-links/update-a-link.md): Update link properties such as property name, move-in date, or status. Set status to "inactive" to disable a link without deleting it. - [Cancel an order](https://offergrid.io/docs/reseller-api-reference/reseller-orders/cancel-an-order.md): Cancel a pending or submitted order. Orders can only be cancelled if they have not been accepted by providers. - [Get order details](https://offergrid.io/docs/reseller-api-reference/reseller-orders/get-order-details.md): Retrieve detailed information about a specific order, including all items and their fulfillment status. - [List your orders](https://offergrid.io/docs/reseller-api-reference/reseller-orders/list-your-orders.md): Retrieve all orders placed by your reseller team. Includes order items and their fulfillment status. - [Place a new order](https://offergrid.io/docs/reseller-api-reference/reseller-orders/place-a-new-order.md): Create a new order for one or more service offers. Each offer will be sent to its respective provider for fulfillment. You can only order offers that are available to your reseller team. - [Reseller Documentation](https://offergrid.io/docs/reseller-documentation.md): Complete guide for reseller partners using Offergrid - [API Integration Guide](https://offergrid.io/docs/resellers/api-integration.md): Integrate Offergrid into your existing systems - [Browsing the Catalog](https://offergrid.io/docs/resellers/browsing-catalog.md): Search and filter available service offerings - [Canceling Orders](https://offergrid.io/docs/resellers/cancellations.md): How to cancel orders when needed - [Checking Availability](https://offergrid.io/docs/resellers/checking-availability.md): Verify service availability before placing orders - [Comparing Offers](https://offergrid.io/docs/resellers/comparing-offers.md): How to evaluate and compare service offerings - [Creating Orders](https://offergrid.io/docs/resellers/creating-orders.md): How to place orders for your customers - [Customer Information Requirements](https://offergrid.io/docs/resellers/customer-information.md): What customer details you need to collect - [Reseller Overview](https://offergrid.io/docs/resellers/index.md): Start selling essential services through the Offergrid marketplace - [Order Lifecycle](https://offergrid.io/docs/resellers/order-lifecycle.md): Understanding how orders progress from submission to completion - [Order Submission Process](https://offergrid.io/docs/resellers/order-submission.md): What happens after you submit an order - [Reseller Quick Start](https://offergrid.io/docs/resellers/quickstart.md): Get up and running as a reseller in minutes - [Understanding Service Categories](https://offergrid.io/docs/resellers/service-categories.md): Learn about different service types available on Offergrid - [Webhooks](https://offergrid.io/docs/resellers/webhooks.md): Receive real-time notifications about order updates ## OpenAPI Specs - [openapi-provider](https://api.offergrid.io/openapi-provider) - [openapi-reseller](https://api.offergrid.io/openapi-reseller) - [openapi](https://offergrid.io/docs/api-reference/openapi.json) ## Optional - [Dashboard](https://offergrid.io) - [Support](mailto:support@offergrid.io)