# Polinate API

## Docs

- [Create a buyer (phantom) and related contacts/locations](https://docs.polinate.ai/api-reference/buyers/create-a-buyer-phantom-and-related-contactslocations.md): Creates a buyer (phantom) with optional contacts and locations; links default item list for the supplier business. Optionally set initial partnership status (defaults to ACTIVE). Idempotent via Idempotency-Key.
- [Delete a buyer (soft delete)](https://docs.polinate.ai/api-reference/buyers/delete-a-buyer-soft-delete.md): Soft deletes a buyer by setting deletedAt timestamp. The buyer record is retained but marked as deleted.
- [Get a buyer by ID](https://docs.polinate.ai/api-reference/buyers/get-a-buyer-by-id.md): Retrieves a single buyer (phantom) by ID including related contacts, phones, emails, and locations.
- [Update a buyer (comprehensive CRUD)](https://docs.polinate.ai/api-reference/buyers/update-a-buyer-comprehensive-crud.md): Comprehensive buyer updates supporting: - Core buyer fields (name, legalName, primaryEmail, primaryPhone) - phantom buyers only - Partnership status updates (if supplier owns the partnership) - Create, update, and delete operations for emails, phones, and locations - Business buyers can only update…
- [Get an invoice by ID](https://docs.polinate.ai/api-reference/invoices/get-an-invoice-by-id.md): Retrieves a single invoice by ID including its line items.
- [List invoices](https://docs.polinate.ai/api-reference/invoices/list-invoices.md): Returns a paginated list of invoices with optional filters by creation time, artefact presence, status, and JSONB properties.
- [Update an invoice (partial)](https://docs.polinate.ai/api-reference/invoices/update-an-invoice-partial.md): Partially updates invoice fields such as status, reference, notes, and provider-specific properties. Idempotent via Idempotency-Key.
- [Create an item and its variants](https://docs.polinate.ai/api-reference/items/create-an-item-and-its-variants.md): Create a parent item and its variants in one request. Idempotent via Idempotency-Key.
- [Delete an item (soft delete)](https://docs.polinate.ai/api-reference/items/delete-an-item-soft-delete.md): Soft deletes an item by setting deletedAt timestamp. The item and its variants are retained but marked as deleted.
- [Get an item by ID](https://docs.polinate.ai/api-reference/items/get-an-item-by-id.md): Retrieves a single item by ID including its variants.
- [Update an item (partial) and manage variants](https://docs.polinate.ai/api-reference/items/update-an-item-partial-and-manage-variants.md): Partially updates item fields such as name, description, imgUrl, brand, vendorName, status, and properties. Also supports create/update/delete operations for item variants.
- [Delete an order (soft delete)](https://docs.polinate.ai/api-reference/orders/delete-an-order-soft-delete.md): Soft deletes an order by setting deletedAt timestamp. The order record is retained but marked as deleted.
- [Get an order by ID](https://docs.polinate.ai/api-reference/orders/get-an-order-by-id.md): Retrieves a single order by ID including its order items.
- [List orders](https://docs.polinate.ai/api-reference/orders/list-orders.md): Returns a paginated list of orders with optional filters by creation/updated windows, phase, status, and JSONB properties.
- [Notify system that an order has been created (ingestion)](https://docs.polinate.ai/api-reference/orders/notify-system-that-an-order-has-been-created-ingestion.md): Idempotent ingestion endpoint. Provide Idempotency-Key computed as sha256("${orderId}-${businessId}-order-integration").
- [Update an order and manage order items (comprehensive CRUD)](https://docs.polinate.ai/api-reference/orders/update-an-order-and-manage-order-items-comprehensive-crud.md): Comprehensive order updates supporting: - Core order fields (phase, status, externalReference, notes, deliveryAddress, dates, currency, totalAmount, properties) - Create, update, and delete operations for order items
- [Create a price list and entries](https://docs.polinate.ai/api-reference/pricing/create-a-price-list-and-entries.md): Creates a price list with entries and optionally assigns it to partnerships (buyers). Idempotent via Idempotency-Key.
- [Authentication](https://docs.polinate.ai/guides/authentication.md): Learn how to authenticate with the Polinate API using Business ID and API Key headers
- [Buyers](https://docs.polinate.ai/guides/buyers.md): Create buyers and related contacts/locations via the API
- [Idempotency](https://docs.polinate.ai/guides/idempotency.md): Ensure safe retries for POST operations using Idempotency-Key
- [Items](https://docs.polinate.ai/guides/items.md): Create items and variants via the API
- [Orders](https://docs.polinate.ai/guides/orders.md): Create, update, and query orders with powerful filtering, property-based queries, and automatic merging
- [Pricing](https://docs.polinate.ai/guides/pricing.md): Create price lists and entries via the API
- [Rate Limits](https://docs.polinate.ai/guides/rate-limits.md): How Polinate rate limiting works and how to handle 429s

## OpenAPI Specs

- [openapi](https://docs.polinate.ai/openapi.json)