# Shelfforce API ## Docs - [Create account](https://docs.shelfforce.ai/api-reference/accounts/create-account.md): Creates a new account (brand, supplier, distributor, etc.). - [Delete account](https://docs.shelfforce.ai/api-reference/accounts/delete-account.md): Permanently deletes an account. This cannot be undone. - [Get account](https://docs.shelfforce.ai/api-reference/accounts/get-account.md): Retrieves full details for an account. - [List accounts](https://docs.shelfforce.ai/api-reference/accounts/list-accounts.md): Returns a paginated list of accounts (brands, suppliers, distributors, etc.). - [Update account](https://docs.shelfforce.ai/api-reference/accounts/update-account.md): Updates account fields. - [Get alert](https://docs.shelfforce.ai/api-reference/alerts/get-alert.md): Retrieves full details for an alert. - [List alerts](https://docs.shelfforce.ai/api-reference/alerts/list-alerts.md): Returns a paginated list of alerts. By default, dismissed and snoozed alerts are excluded. Pass `status` to filter explicitly. - [Update alert status](https://docs.shelfforce.ai/api-reference/alerts/update-alert-status.md): Updates an alert's status. Use this to mark alerts as read, acknowledged, dismissed, or snoozed. - [Batch submit](https://docs.shelfforce.ai/api-reference/analyses/batch-submit.md): Submits multiple images for shelf analysis in a single request. Each image consumes 1 credit. Maximum batch size depends on your plan tier (20-200). All analyses run asynchronously. - [Get analysis](https://docs.shelfforce.ai/api-reference/analyses/get-analysis.md): Retrieves the current state and results of a shelf analysis. While `status` is `processing`, the `products` array may be empty or partial. Once `completed`, all detected products are included. - [Get upload URL](https://docs.shelfforce.ai/api-reference/analyses/get-upload-url.md): Returns a presigned upload URL for uploading images to Shelfforce storage. Upload the image via POST to the returned URL, then use the resulting storage URL as the `imageUrl` in analysis requests. - [List analyses](https://docs.shelfforce.ai/api-reference/analyses/list-analyses.md): Returns a paginated list of analyses for your organisation. Filter by status, externalId, or placeId. - [Submit analysis](https://docs.shelfforce.ai/api-reference/analyses/submit-analysis.md): Submits a single image URL for AI-powered shelf analysis. Consumes 1 credit. The analysis runs asynchronously; poll GET /api/v1/analyses/{id} or subscribe to the `analysis.completed` webhook event. - [Create inventory](https://docs.shelfforce.ai/api-reference/inventory/create-inventory.md): Adds a new SKU to your master inventory catalogue. - [Delete inventory item](https://docs.shelfforce.ai/api-reference/inventory/delete-inventory-item.md): Permanently deletes an inventory item. This cannot be undone. - [Get inventory](https://docs.shelfforce.ai/api-reference/inventory/get-inventory.md): Retrieves full details for a single inventory item. - [List inventory](https://docs.shelfforce.ai/api-reference/inventory/list-inventory.md): Returns a paginated list of inventory items (master SKU catalogue) for your organisation. - [Update inventory](https://docs.shelfforce.ai/api-reference/inventory/update-inventory.md): Updates one or more fields on an existing inventory item. - [Invite member](https://docs.shelfforce.ai/api-reference/members/invite-member.md): Sends an invitation to join the organisation. Requires admin role. - [List members](https://docs.shelfforce.ai/api-reference/members/list-members.md): Returns a paginated list of organisation members with their roles and territories. - [Remove member](https://docs.shelfforce.ai/api-reference/members/remove-member.md): Removes a member from the organisation. The organisation owner cannot be removed. Requires admin role. - [Update member](https://docs.shelfforce.ai/api-reference/members/update-member.md): Updates a member's role, territory, or reporting line. Requires admin role. - [Create order](https://docs.shelfforce.ai/api-reference/orders/create-order.md): Creates a new purchase order with optional line items. - [Delete order](https://docs.shelfforce.ai/api-reference/orders/delete-order.md): Permanently deletes an order and all its line items. This cannot be undone. - [Get order](https://docs.shelfforce.ai/api-reference/orders/get-order.md): Retrieves full details for an order including line items. - [List orders](https://docs.shelfforce.ai/api-reference/orders/list-orders.md): Returns a paginated list of orders. Filter by status, supplier name, or store ID. - [Update order](https://docs.shelfforce.ai/api-reference/orders/update-order.md): Updates order fields such as status, supplier name, expected delivery date, or notes. - [Create a place](https://docs.shelfforce.ai/api-reference/places/create-a-place.md): Creates a new store location within your organisation. - [Delete place](https://docs.shelfforce.ai/api-reference/places/delete-place.md): Permanently deletes a place. This cannot be undone. - [Get place](https://docs.shelfforce.ai/api-reference/places/get-place.md): Retrieves full details for a single store location. - [List places](https://docs.shelfforce.ai/api-reference/places/list-places.md): Returns a paginated list of store locations belonging to your organisation. - [List products](https://docs.shelfforce.ai/api-reference/products/list-products.md): Returns a paginated list of products detected across all analyses. Filter by brand, category, analysis, or place. - [Share of shelf](https://docs.shelfforce.ai/api-reference/reports/share-of-shelf.md): Aggregates shelf unit counts by brand over a time period. Use this to understand brand visibility relative to competitors. - [Store performance](https://docs.shelfforce.ai/api-reference/reports/store-performance.md): Aggregates task completion and compliance metrics by store over a time period. - [Create a task](https://docs.shelfforce.ai/api-reference/tasks/create-a-task.md): Creates a new field data-collection task. Optionally link to a place, assign a user, and attach inventory items. - [Delete task](https://docs.shelfforce.ai/api-reference/tasks/delete-task.md): Permanently deletes a task. This cannot be undone. - [Get task](https://docs.shelfforce.ai/api-reference/tasks/get-task.md): Retrieves full details for a task including compliance scores when available. - [List tasks](https://docs.shelfforce.ai/api-reference/tasks/list-tasks.md): Returns a paginated list of field data-collection tasks. Filter by status, place, assignee, or project. - [Update task](https://docs.shelfforce.ai/api-reference/tasks/update-task.md): Updates mutable fields on a task. Status transitions are validated: pending -> in_progress, pending -> cancelled, in_progress -> completed, in_progress -> cancelled. - [Get usage](https://docs.shelfforce.ai/api-reference/usage/get-usage.md): Returns current credit balance, plan details, and per-endpoint rate-limit allocations. - [Analysis completed](https://docs.shelfforce.ai/api-reference/webhooks/analysis-completed.md): Fired when a shelf analysis finishes successfully. - [Analysis failed](https://docs.shelfforce.ai/api-reference/webhooks/analysis-failed.md): Fired when a shelf analysis fails. - [Delete webhook](https://docs.shelfforce.ai/api-reference/webhooks/delete-webhook.md): Permanently deletes a webhook endpoint. Requires admin role. No further events will be delivered to this URL. - [List webhooks](https://docs.shelfforce.ai/api-reference/webhooks/list-webhooks.md): Returns all registered webhook endpoints. Secrets are never included in list responses. - [Register webhook](https://docs.shelfforce.ai/api-reference/webhooks/register-webhook.md): Registers a new webhook endpoint to receive event notifications. Requires admin role. The `secret` for HMAC-SHA256 signature verification is returned only in this response -- store it securely. - [Task completed](https://docs.shelfforce.ai/api-reference/webhooks/task-completed.md): Fired when a task is marked as completed. - [Task created](https://docs.shelfforce.ai/api-reference/webhooks/task-created.md): Fired when a new task is created. - [Task updated](https://docs.shelfforce.ai/api-reference/webhooks/task-updated.md): Fired when a task's fields are modified. - [Authentication](https://docs.shelfforce.ai/authentication.md): Create and manage API keys to authenticate requests to the Shelfforce API. - [Credits](https://docs.shelfforce.ai/credits.md): Understand how Shelfforce credits work, what costs credits, and how to manage your balance. - [Errors](https://docs.shelfforce.ai/errors.md): A complete reference of error codes returned by the Shelfforce API. - [AI Agent Integration](https://docs.shelfforce.ai/guides/agent-integration.md): Connect Shelfforce to AI agents, LLMs, and automated pipelines using OpenAPI, llms.txt, and webhooks. - [Batch Analysis](https://docs.shelfforce.ai/guides/batch-analysis.md): Submit multiple shelf images for analysis in a single API call. - [CLI](https://docs.shelfforce.ai/guides/cli.md): Install and use the Shelfforce CLI to analyze shelf images, manage resources, and pull reports from your terminal. - [Field Operations](https://docs.shelfforce.ai/guides/field-operations.md): Manage stores, tasks, inventory, orders, accounts, alerts, and team members through the API. - [Shelf Analysis](https://docs.shelfforce.ai/guides/shelf-analysis.md): Learn the core workflow for analyzing shelf images and extracting structured product data. - [Shelfforce API](https://docs.shelfforce.ai/index.md): Turn shelf photos into structured product data. Detect SKUs, count facings, read prices, and measure brand share — all from a single API call. - [Quickstart](https://docs.shelfforce.ai/quickstart.md): Analyze your first shelf in 60 seconds. - [Rate Limits](https://docs.shelfforce.ai/rate-limits.md): Understand request rate limits by plan tier and how to handle throttled responses. - [Webhooks](https://docs.shelfforce.ai/webhooks.md): Receive real-time notifications when analyses complete, tasks update, and other events occur. ## OpenAPI Specs - [openapi](https://docs.shelfforce.ai/openapi.json) ## Optional - [API Reference](https://docs.shelfforce.ai/api-reference) - [CLI](https://docs.shelfforce.ai/guides/cli) - [Blog](https://shelfforce.ai/resources)