# Switchyard Documentation

## Docs

- [Get manifest data for printing](https://docs.switchyard.run/api-reference/admin--partner-manifests/get-manifest-data-for-printing.md): Returns manifest data formatted for printing, including QR code data.
- [Get manifest details](https://docs.switchyard.run/api-reference/admin--partner-manifests/get-manifest-details.md)
- [List all partner manifests](https://docs.switchyard.run/api-reference/admin--partner-manifests/list-all-partner-manifests.md)
- [Get partner payout details](https://docs.switchyard.run/api-reference/admin--partner-payouts/get-partner-payout-details.md): Returns detailed payout information for a specific partner, broken down by period.
- [List pending payouts](https://docs.switchyard.run/api-reference/admin--partner-payouts/list-pending-payouts.md): Returns a summary of pending payouts for all partners.
- [Mark sales as paid](https://docs.switchyard.run/api-reference/admin--partner-payouts/mark-sales-as-paid.md): Updates the payout status of pending sales to "paid" for a partner.
- [Approve a partner product](https://docs.switchyard.run/api-reference/admin--partner-products/approve-a-partner-product.md): Approves a pending partner product, making it active and available for sale.
- [Approve a product request](https://docs.switchyard.run/api-reference/admin--partner-products/approve-a-product-request.md): Approves a claim, edit, or conversion request. For conversions, deactivates all retailer mappings.
- [Convert a retailer-sourced product to a partner product](https://docs.switchyard.run/api-reference/admin--partner-products/convert-a-retailer-sourced-product-to-a-partner-product.md): Converts a product from retailer-sourced to partner-supplied. Sets partner ownership, deactivates retailer mappings and pricing.
- [Deactivate a partner product](https://docs.switchyard.run/api-reference/admin--partner-products/deactivate-a-partner-product.md): Reverts a partner product to retailer-sourced. Clears partner ownership, restores retailer mappings that were deactivated during conversion.
- [Get partner product detail](https://docs.switchyard.run/api-reference/admin--partner-products/get-partner-product-detail.md): Returns detailed information about a partner product including inventory and sales data.
- [List product requests (claims, edits, conversions)](https://docs.switchyard.run/api-reference/admin--partner-products/list-product-requests-claims-edits-conversions.md): Returns a paginated list of partner product requests with optional type filter.
- [List products pending approval](https://docs.switchyard.run/api-reference/admin--partner-products/list-products-pending-approval.md): Returns a paginated list of partner products awaiting approval.
- [Reject a partner product](https://docs.switchyard.run/api-reference/admin--partner-products/reject-a-partner-product.md): Rejects a pending partner product with a reason.
- [Reject a product request](https://docs.switchyard.run/api-reference/admin--partner-products/reject-a-product-request.md): Rejects a claim, edit, or conversion request with a reason.
- [Update a partner product](https://docs.switchyard.run/api-reference/admin--partner-products/update-a-partner-product.md): Updates a partner product's details.
- [Approve a partner brand](https://docs.switchyard.run/api-reference/admin--partners/approve-a-partner-brand.md): Approves a pending partner brand and creates their retailer/location entries.
- [Create a partner brand](https://docs.switchyard.run/api-reference/admin--partners/create-a-partner-brand.md): Creates a new partner brand. Can optionally set as approved immediately.
- [Create a product for partner brand](https://docs.switchyard.run/api-reference/admin--partners/create-a-product-for-partner-brand.md): Creates a new product for a specific partner brand.
- [Get all products for a linked brand](https://docs.switchyard.run/api-reference/admin--partners/get-all-products-for-a-linked-brand.md): Returns all products matching the linked brand, with claim status and retailer mapping counts.
- [Get partner brand detail with products and sales](https://docs.switchyard.run/api-reference/admin--partners/get-partner-brand-detail-with-products-and-sales.md): Returns detailed information about a partner brand including all products and sales summary.
- [Get partner brand details](https://docs.switchyard.run/api-reference/admin--partners/get-partner-brand-details.md): Returns detailed information about a specific partner brand.
- [Get partner statistics](https://docs.switchyard.run/api-reference/admin--partners/get-partner-statistics.md): Returns aggregate statistics about partner brands and products.
- [Link partner brand to existing brand](https://docs.switchyard.run/api-reference/admin--partners/link-partner-brand-to-existing-brand.md): Links a partner_brand to an existing brand in the brands table, surfacing all that brand's products to the partner.
- [List partner brands](https://docs.switchyard.run/api-reference/admin--partners/list-partner-brands.md): Returns a paginated list of partner brands with optional status filter.
- [Reactivate a suspended partner brand](https://docs.switchyard.run/api-reference/admin--partners/reactivate-a-suspended-partner-brand.md): Reactivates a suspended partner brand.
- [Reject a partner brand](https://docs.switchyard.run/api-reference/admin--partners/reject-a-partner-brand.md): Rejects a pending partner brand registration.
- [Search brands for linking](https://docs.switchyard.run/api-reference/admin--partners/search-brands-for-linking.md): Search the brands table by name to find an existing brand to link to a partner brand.
- [Suspend a partner brand](https://docs.switchyard.run/api-reference/admin--partners/suspend-a-partner-brand.md): Suspends an approved partner brand.
- [Unlink partner brand from brand](https://docs.switchyard.run/api-reference/admin--partners/unlink-partner-brand-from-brand.md): Removes the link between a partner_brand and its brand.
- [Cancel a reorder request](https://docs.switchyard.run/api-reference/admin--reorder-requests/cancel-a-reorder-request.md): Cancels a pending reorder request.
- [Create a reorder request](https://docs.switchyard.run/api-reference/admin--reorder-requests/create-a-reorder-request.md): Creates a new reorder request for a partner brand. The partner will be notified and can accept or reject.
- [Get auto-reorder status summary](https://docs.switchyard.run/api-reference/admin--reorder-requests/get-auto-reorder-status-summary.md): Returns a summary of auto-reorder status for all partner brands.
- [Get reorder request details](https://docs.switchyard.run/api-reference/admin--reorder-requests/get-reorder-request-details.md): Returns detailed request information including all requested items.
- [List all reorder requests](https://docs.switchyard.run/api-reference/admin--reorder-requests/list-all-reorder-requests.md): Returns a paginated list of reorder requests across all partner brands.
- [List auto-reorder candidates](https://docs.switchyard.run/api-reference/admin--reorder-requests/list-auto-reorder-candidates.md): Returns products that are below their reorder point and eligible for auto-reorder.
- [List partner products for reorder selection](https://docs.switchyard.run/api-reference/admin--reorder-requests/list-partner-products-for-reorder-selection.md): Returns a list of products from a partner brand that can be included in a reorder request.
- [Trigger auto-reorder generation](https://docs.switchyard.run/api-reference/admin--reorder-requests/trigger-auto-reorder-generation.md): Runs the auto-reorder check and creates reorder requests for all products below their reorder point.
- [Update reorder request status](https://docs.switchyard.run/api-reference/admin--reorder-requests/update-reorder-request-status.md): Update the status of a reorder request. When accepting, creates a manifest. When reverting from accepted, cancels the linked manifest.
- [List notifications for the current user](https://docs.switchyard.run/api-reference/admin-notifications/list-notifications-for-the-current-user.md)
- [Mark a notification as read](https://docs.switchyard.run/api-reference/admin-notifications/mark-a-notification-as-read.md)
- [Mark all notifications as read](https://docs.switchyard.run/api-reference/admin-notifications/mark-all-notifications-as-read.md)
- [Create API key](https://docs.switchyard.run/api-reference/api-keys/create-api-key.md): Creates a new API key. The secret is only returned once and cannot be retrieved later.
- [Delete API key](https://docs.switchyard.run/api-reference/api-keys/delete-api-key.md): Permanently deletes an API key. This action cannot be undone.
- [Get API key audit log](https://docs.switchyard.run/api-reference/api-keys/get-api-key-audit-log.md): Returns the audit log for an API key.
- [Get API key by ID](https://docs.switchyard.run/api-reference/api-keys/get-api-key-by-id.md): Returns a single API key by ID.
- [List API keys](https://docs.switchyard.run/api-reference/api-keys/list-api-keys.md): Returns all API keys the user has access to. Admins see all keys, others see their own.
- [Revoke API key](https://docs.switchyard.run/api-reference/api-keys/revoke-api-key.md): Revokes an API key. Revoked keys cannot be used or reactivated.
- [Update API key](https://docs.switchyard.run/api-reference/api-keys/update-api-key.md): Updates an API key's name, description, scopes, or expiration.
- [Clock in or out](https://docs.switchyard.run/api-reference/auth/clock-in-or-out.md): Perform a clock in or clock out action via Deputy
- [Clock in/out](https://docs.switchyard.run/api-reference/auth/clock-inout.md): Clock in or out. Supports staff_id in body for PIN auth.
- [Get clock status](https://docs.switchyard.run/api-reference/auth/get-clock-status.md): Get current clock in/out status. Supports staff_id query param for PIN auth.
- [Get clock status](https://docs.switchyard.run/api-reference/auth/get-clock-status-1.md): Get current clock in/out status for the authenticated user or specified staff
- [Get current user](https://docs.switchyard.run/api-reference/auth/get-current-user.md): Get current authenticated user with staff info, role, and permissions
- [List staff](https://docs.switchyard.run/api-reference/auth/list-staff.md): Returns list of active staff (for UI display, without exposing PINs).
- [List staff for PIN selection](https://docs.switchyard.run/api-reference/auth/list-staff-for-pin-selection.md): Get a list of active staff members for PIN-based login selection
- [Update PIN](https://docs.switchyard.run/api-reference/auth/update-pin.md): Update a staff member's PIN.
- [Update staff PIN](https://docs.switchyard.run/api-reference/auth/update-staff-pin.md): Update a staff member's 6-digit PIN
- [Verify PIN](https://docs.switchyard.run/api-reference/auth/verify-pin.md): Verify a 6-digit PIN and return staff info.
- [Verify staff PIN](https://docs.switchyard.run/api-reference/auth/verify-staff-pin.md): Verify a 6-digit PIN and return staff information if valid
- [Backfill aggregated scores](https://docs.switchyard.run/api-reference/availability/backfill-aggregated-scores.md): Recalculates aggregated product availability scores from per-location scores.
- [Backfill aggregated scores](https://docs.switchyard.run/api-reference/availability/backfill-aggregated-scores-1.md): Recalculates aggregated product availability scores from per-location scores.
- [Get availability events](https://docs.switchyard.run/api-reference/availability/get-availability-events.md): Returns availability events for a product over the last 60 days.
- [Get availability events](https://docs.switchyard.run/api-reference/availability/get-availability-events-1.md): Returns availability events for a product over the last 60 days.
- [Get per-location availability scores](https://docs.switchyard.run/api-reference/availability/get-per-location-availability-scores.md): Returns availability scores for each retailer location that carries the product.
- [Get per-location availability scores](https://docs.switchyard.run/api-reference/availability/get-per-location-availability-scores-1.md): Returns availability scores for each retailer location that carries the product.
- [Get product availability](https://docs.switchyard.run/api-reference/availability/get-product-availability.md): Calculates and returns availability score for a single product.
- [Get product availability](https://docs.switchyard.run/api-reference/availability/get-product-availability-1.md): Calculates and returns availability score for a single product.
- [List products with availability](https://docs.switchyard.run/api-reference/availability/list-products-with-availability.md): Returns paginated list of products with availability scores and stats.
- [List products with availability](https://docs.switchyard.run/api-reference/availability/list-products-with-availability-1.md): Returns paginated list of products with availability scores and stats.
- [Process availability score queue](https://docs.switchyard.run/api-reference/availability/process-availability-score-queue.md): Manually processes the availability score update queue.
- [Process availability score queue](https://docs.switchyard.run/api-reference/availability/process-availability-score-queue-1.md): Manually processes the availability score update queue.
- [Recalculate availability scores](https://docs.switchyard.run/api-reference/availability/recalculate-availability-scores.md): Recalculates availability scores for one or all products.
- [Recalculate availability scores](https://docs.switchyard.run/api-reference/availability/recalculate-availability-scores-1.md): Recalculates availability scores for one or all products.
- [Create category](https://docs.switchyard.run/api-reference/categories/create-category.md): Create a new category
- [Delete category](https://docs.switchyard.run/api-reference/categories/delete-category.md): Soft delete a category
- [List all categories](https://docs.switchyard.run/api-reference/categories/list-all-categories.md): List all categories with hierarchy
- [Toggle category active status](https://docs.switchyard.run/api-reference/categories/toggle-category-active-status.md): Toggle the active status of a category
- [Update category](https://docs.switchyard.run/api-reference/categories/update-category.md): Update an existing category
- [Bulk refresh analytics](https://docs.switchyard.run/api-reference/customers/bulk-refresh-analytics.md): Trigger a bulk refresh of analytics for all customer profiles.
- [Bulk refresh analytics](https://docs.switchyard.run/api-reference/customers/bulk-refresh-analytics-1.md): Trigger a bulk refresh of analytics for all customer profiles.
- [Get category analytics](https://docs.switchyard.run/api-reference/customers/get-category-analytics.md): Get category spending and frequency analytics for a customer.
- [Get category analytics](https://docs.switchyard.run/api-reference/customers/get-category-analytics-1.md): Get category spending and frequency analytics for a customer.
- [Get customer by ID](https://docs.switchyard.run/api-reference/customers/get-customer-by-id.md): Get detailed customer profile with full analytics data.
- [Get customer by ID](https://docs.switchyard.run/api-reference/customers/get-customer-by-id-1.md): Get detailed customer profile with full analytics data.
- [Get customer orders](https://docs.switchyard.run/api-reference/customers/get-customer-orders.md): Get paginated list of orders for a specific customer.
- [Get customer orders](https://docs.switchyard.run/api-reference/customers/get-customer-orders-1.md): Get paginated list of orders for a specific customer.
- [Get frequently purchased products](https://docs.switchyard.run/api-reference/customers/get-frequently-purchased-products.md): Get products frequently purchased by a specific customer.
- [Get frequently purchased products](https://docs.switchyard.run/api-reference/customers/get-frequently-purchased-products-1.md): Get products frequently purchased by a specific customer.
- [Get retailer sourcing](https://docs.switchyard.run/api-reference/customers/get-retailer-sourcing.md): Get retailer spending and frequency distribution for a customer.
- [Get retailer sourcing](https://docs.switchyard.run/api-reference/customers/get-retailer-sourcing-1.md): Get retailer spending and frequency distribution for a customer.
- [List customers with analytics](https://docs.switchyard.run/api-reference/customers/list-customers-with-analytics.md): Get a paginated list of customer profiles with their analytics data.
- [List customers with analytics](https://docs.switchyard.run/api-reference/customers/list-customers-with-analytics-1.md): Get a paginated list of customer profiles with their analytics data.
- [Refresh customer analytics](https://docs.switchyard.run/api-reference/customers/refresh-customer-analytics.md): Recompute analytics for a specific customer based on their order history.
- [Refresh customer analytics](https://docs.switchyard.run/api-reference/customers/refresh-customer-analytics-1.md): Recompute analytics for a specific customer based on their order history.
- [Generate PINs for staff without one](https://docs.switchyard.run/api-reference/deputy-sync/generate-pins-for-staff-without-one.md): Generates 6-digit PINs for all active staff members without a PIN.
- [Generate PINs for staff without one](https://docs.switchyard.run/api-reference/deputy-sync/generate-pins-for-staff-without-one-1.md): Generates 6-digit PINs for all active staff members without a PIN.
- [List Deputy operational units](https://docs.switchyard.run/api-reference/deputy-sync/list-deputy-operational-units.md): Returns all active operational units from Deputy.
- [List Deputy operational units](https://docs.switchyard.run/api-reference/deputy-sync/list-deputy-operational-units-1.md): Returns all active operational units from Deputy.
- [Push all staff operational units to Deputy](https://docs.switchyard.run/api-reference/deputy-sync/push-all-staff-operational-units-to-deputy.md): Pushes all staff operational unit assignments to Deputy.
- [Push all staff operational units to Deputy](https://docs.switchyard.run/api-reference/deputy-sync/push-all-staff-operational-units-to-deputy-1.md): Pushes all staff operational unit assignments to Deputy.
- [Sync employees from Deputy](https://docs.switchyard.run/api-reference/deputy-sync/sync-employees-from-deputy.md): Syncs all active Deputy employees to Supabase, creating auth users, user records, and staff records.
- [Sync employees from Deputy](https://docs.switchyard.run/api-reference/deputy-sync/sync-employees-from-deputy-1.md): Syncs all active Deputy employees to Supabase, creating auth users, user records, and staff records.
- [Sync operational units from Deputy](https://docs.switchyard.run/api-reference/deputy-sync/sync-operational-units-from-deputy.md): Syncs operational unit assignments from Deputy to staff records.
- [Sync operational units from Deputy](https://docs.switchyard.run/api-reference/deputy-sync/sync-operational-units-from-deputy-1.md): Syncs operational unit assignments from Deputy to staff records.
- [Update staff operational units](https://docs.switchyard.run/api-reference/deputy-sync/update-staff-operational-units.md): Updates a staff member's operational units and pushes to Deputy.
- [Update staff operational units](https://docs.switchyard.run/api-reference/deputy-sync/update-staff-operational-units-1.md): Updates a staff member's operational units and pushes to Deputy.
- [Get template and subscribers for a notification type](https://docs.switchyard.run/api-reference/email-templates/get-template-and-subscribers-for-a-notification-type.md)
- [List all email notification templates](https://docs.switchyard.run/api-reference/email-templates/list-all-email-notification-templates.md)
- [Reset template to default](https://docs.switchyard.run/api-reference/email-templates/reset-template-to-default.md)
- [Send test email for a template](https://docs.switchyard.run/api-reference/email-templates/send-test-email-for-a-template.md)
- [Update email template](https://docs.switchyard.run/api-reference/email-templates/update-email-template.md)
- [Assign bag to slot](https://docs.switchyard.run/api-reference/equipment/assign-bag-to-slot.md): Assign a bag to an available cold storage slot
- [Assign bag to tote](https://docs.switchyard.run/api-reference/equipment/assign-bag-to-tote.md): Assign a bag to a tote for delivery
- [Assign cart to order](https://docs.switchyard.run/api-reference/equipment/assign-cart-to-order.md): Assign an available cart to an order.
- [Assign cart to order](https://docs.switchyard.run/api-reference/equipment/assign-cart-to-order-1.md): Assign a cart to an order for picking
- [Clear bag contents](https://docs.switchyard.run/api-reference/equipment/clear-bag-contents.md): Remove all items from a bag and set status to empty
- [Get bag by ID](https://docs.switchyard.run/api-reference/equipment/get-bag-by-id.md): Get detailed information about a specific bag including items
- [Get cart by ID](https://docs.switchyard.run/api-reference/equipment/get-cart-by-id.md): Returns detailed information about a specific cart.
- [Get cart by ID](https://docs.switchyard.run/api-reference/equipment/get-cart-by-id-1.md): Get detailed information about a specific cart including totes and stocking items
- [Get robot by ID](https://docs.switchyard.run/api-reference/equipment/get-robot-by-id.md): Returns detailed information about a specific robot.
- [Get robot by ID](https://docs.switchyard.run/api-reference/equipment/get-robot-by-id-1.md): Get detailed information about a specific robot including its active tote
- [Get tote by ID](https://docs.switchyard.run/api-reference/equipment/get-tote-by-id.md): Get detailed information about a specific tote including items and order progress
- [Get tote by ID](https://docs.switchyard.run/api-reference/equipment/get-tote-by-id-1.md): Get detailed information about a specific tote including items and order progress
- [Get tote by ID](https://docs.switchyard.run/api-reference/equipment/get-tote-by-id-2.md): Get detailed information about a specific tote including items and order progress
- [List all bags](https://docs.switchyard.run/api-reference/equipment/list-all-bags.md): Get a list of all bags with item counts and stats
- [List all carts](https://docs.switchyard.run/api-reference/equipment/list-all-carts.md): Get a list of all carts with optional filtering by location or availability
- [List all robots](https://docs.switchyard.run/api-reference/equipment/list-all-robots.md): Get a list of all robots with optional filtering by status or active state
- [List all sensors](https://docs.switchyard.run/api-reference/equipment/list-all-sensors.md): Get a list of all temperature and humidity sensors with their current readings and status
- [List all totes](https://docs.switchyard.run/api-reference/equipment/list-all-totes.md): Get a list of all totes with their container and order associations
- [List all totes](https://docs.switchyard.run/api-reference/equipment/list-all-totes-1.md): Get a list of all totes with their container and order associations
- [List all totes](https://docs.switchyard.run/api-reference/equipment/list-all-totes-2.md): Get a list of all totes with their container and order associations
- [List carts](https://docs.switchyard.run/api-reference/equipment/list-carts.md): Returns all carts, optionally filtered by location or availability.
- [List cold equipment](https://docs.switchyard.run/api-reference/equipment/list-cold-equipment.md): Returns all fridges and freezers with monitoring status.
- [List cold storage equipment](https://docs.switchyard.run/api-reference/equipment/list-cold-storage-equipment.md): Get a list of all cold storage equipment (fridges and freezers)
- [List robots](https://docs.switchyard.run/api-reference/equipment/list-robots.md): Returns all robots with optional status or active filters.
- [Release tote from cart](https://docs.switchyard.run/api-reference/equipment/release-tote-from-cart.md): Remove a tote from a cart
- [Remove bag from tote](https://docs.switchyard.run/api-reference/equipment/remove-bag-from-tote.md): Remove a bag from its current tote
- [Scan tote to cart](https://docs.switchyard.run/api-reference/equipment/scan-tote-to-cart.md): Add a tote to a cart by scanning its ID
- [Update bag](https://docs.switchyard.run/api-reference/equipment/update-bag.md): Update bag status, label_printed, or fulfilled state
- [Update cart](https://docs.switchyard.run/api-reference/equipment/update-cart.md): Update cart location, release from order, or change active tote.
- [Update cart](https://docs.switchyard.run/api-reference/equipment/update-cart-1.md): Update cart location, release from order, or change active tote
- [Update robot](https://docs.switchyard.run/api-reference/equipment/update-robot.md): Update robot status, active state, or active tote.
- [Update robot](https://docs.switchyard.run/api-reference/equipment/update-robot-1.md): Update robot status, active state, or assigned tote
- [Get v1dispatch](https://docs.switchyard.run/api-reference/get-v1dispatch.md)
- [Get v1dispatch:id](https://docs.switchyard.run/api-reference/get-v1dispatch:id.md)
- [Get v1scannerdispatch](https://docs.switchyard.run/api-reference/get-v1scannerdispatch.md)
- [Get v1scannerdispatch:id](https://docs.switchyard.run/api-reference/get-v1scannerdispatch:id.md)
- [Get v1scannerreceipts](https://docs.switchyard.run/api-reference/get-v1scannerreceipts.md)
- [Convert multipack inventory](https://docs.switchyard.run/api-reference/inventory/convert-multipack-inventory.md): Convert parent multipack inventory to child units.
- [Convert multipack inventory](https://docs.switchyard.run/api-reference/inventory/convert-multipack-inventory-1.md): Convert parent multipack inventory to child units.
- [Get all slots with availability](https://docs.switchyard.run/api-reference/inventory/get-all-slots-with-availability.md): Returns all inventory slots in a zone with is_occupied flag.
- [Get all slots with availability](https://docs.switchyard.run/api-reference/inventory/get-all-slots-with-availability-1.md): Returns all inventory slots in a zone with is_occupied flag.
- [Get inventory group](https://docs.switchyard.run/api-reference/inventory/get-inventory-group.md): Returns details for a specific inventory group by location code or UUID.
- [Get inventory group](https://docs.switchyard.run/api-reference/inventory/get-inventory-group-1.md): Returns details for a specific inventory group by location code or UUID.
- [Get inventory summary metrics](https://docs.switchyard.run/api-reference/inventory/get-inventory-summary-metrics.md): Returns aggregate inventory metrics including total items, cost, age, and demand.
- [List inventory groups](https://docs.switchyard.run/api-reference/inventory/list-inventory-groups.md): Returns all inventory groups, optionally filtered by type, zone, aisle, or parent.
- [List inventory groups](https://docs.switchyard.run/api-reference/inventory/list-inventory-groups-1.md): Returns all inventory groups, optionally filtered by type, zone, aisle, or parent.
- [Lookup product by barcode](https://docs.switchyard.run/api-reference/inventory/lookup-product-by-barcode.md): Find a product by barcode and optionally check inventory at a specific location.
- [Lookup product by barcode](https://docs.switchyard.run/api-reference/inventory/lookup-product-by-barcode-1.md): Find a product by barcode and optionally check inventory at a specific location.
- [Recalculate demand velocity for inventory products](https://docs.switchyard.run/api-reference/inventory/recalculate-demand-velocity-for-inventory-products.md): Recalculates 7-day demand velocity for all products currently in inventory based on order history.
- [Scan inventory](https://docs.switchyard.run/api-reference/inventory/scan-inventory.md): Lookup, adjust, or count inventory at a location by scanning a barcode.
- [Scan inventory](https://docs.switchyard.run/api-reference/inventory/scan-inventory-1.md): Lookup, adjust, or count inventory at a location by scanning a barcode.
- [Get current node](https://docs.switchyard.run/api-reference/nodes/get-current-node.md): Returns the current/default active node.
- [Get current node](https://docs.switchyard.run/api-reference/nodes/get-current-node-1.md): Returns the current/default active node.
- [Get formatted operating hours](https://docs.switchyard.run/api-reference/nodes/get-formatted-operating-hours.md): Returns operating hours formatted for display.
- [Get formatted operating hours](https://docs.switchyard.run/api-reference/nodes/get-formatted-operating-hours-1.md): Returns operating hours formatted for display.
- [Get node by ID](https://docs.switchyard.run/api-reference/nodes/get-node-by-id.md): Returns a single node by ID.
- [Get node by ID](https://docs.switchyard.run/api-reference/nodes/get-node-by-id-1.md): Returns a single node by ID.
- [List all nodes](https://docs.switchyard.run/api-reference/nodes/list-all-nodes.md): Returns all RFC (Retail Fulfillment Center) nodes.
- [List all nodes](https://docs.switchyard.run/api-reference/nodes/list-all-nodes-1.md): Returns all RFC (Retail Fulfillment Center) nodes.
- [Update node](https://docs.switchyard.run/api-reference/nodes/update-node.md): Updates a node's configuration.
- [Update node](https://docs.switchyard.run/api-reference/nodes/update-node-1.md): Updates a node's configuration.
- [Update operating hours](https://docs.switchyard.run/api-reference/nodes/update-operating-hours.md): Updates a node's operating hours.
- [Update operating hours](https://docs.switchyard.run/api-reference/nodes/update-operating-hours-1.md): Updates a node's operating hours.
- [Deactivate notification token](https://docs.switchyard.run/api-reference/notifications/deactivate-notification-token.md): Deactivates a notification token.
- [Deactivate notification token](https://docs.switchyard.run/api-reference/notifications/deactivate-notification-token-1.md): Deactivates a notification token.
- [Deactivate staff notification token](https://docs.switchyard.run/api-reference/notifications/deactivate-staff-notification-token.md): Deactivates a push notification token for a staff member.
- [Deactivate staff notification token](https://docs.switchyard.run/api-reference/notifications/deactivate-staff-notification-token-1.md): Deactivates a push notification token for a staff member.
- [Dismiss notification](https://docs.switchyard.run/api-reference/notifications/dismiss-notification.md): Dismisses a notification.
- [Dismiss notification](https://docs.switchyard.run/api-reference/notifications/dismiss-notification-1.md): Dismisses a notification.
- [Get notification analytics](https://docs.switchyard.run/api-reference/notifications/get-notification-analytics.md): Returns notification analytics and statistics.
- [Get notification analytics](https://docs.switchyard.run/api-reference/notifications/get-notification-analytics-1.md): Returns notification analytics and statistics.
- [Get notification by ID](https://docs.switchyard.run/api-reference/notifications/get-notification-by-id.md): Returns a single notification by ID.
- [Get notification by ID](https://docs.switchyard.run/api-reference/notifications/get-notification-by-id-1.md): Returns a single notification by ID.
- [Get notification preferences](https://docs.switchyard.run/api-reference/notifications/get-notification-preferences.md): Returns notification preferences for a user.
- [Get notification preferences](https://docs.switchyard.run/api-reference/notifications/get-notification-preferences-1.md): Returns notification preferences for a user.
- [Get notification tokens](https://docs.switchyard.run/api-reference/notifications/get-notification-tokens.md): Returns notification tokens for a user.
- [Get notification tokens](https://docs.switchyard.run/api-reference/notifications/get-notification-tokens-1.md): Returns notification tokens for a user.
- [Get staff notification preferences](https://docs.switchyard.run/api-reference/notifications/get-staff-notification-preferences.md): Returns notification preferences for a staff member.
- [Get staff notification preferences](https://docs.switchyard.run/api-reference/notifications/get-staff-notification-preferences-1.md): Returns notification preferences for a staff member.
- [List notifications](https://docs.switchyard.run/api-reference/notifications/list-notifications.md): Returns paginated list of notifications with optional filters.
- [List notifications](https://docs.switchyard.run/api-reference/notifications/list-notifications-1.md): Returns paginated list of notifications with optional filters.
- [Mark notification as read](https://docs.switchyard.run/api-reference/notifications/mark-notification-as-read.md): Marks a notification as read.
- [Mark notification as read](https://docs.switchyard.run/api-reference/notifications/mark-notification-as-read-1.md): Marks a notification as read.
- [Send equipment alert](https://docs.switchyard.run/api-reference/notifications/send-equipment-alert.md): Sends an equipment alert notification.
- [Send equipment alert](https://docs.switchyard.run/api-reference/notifications/send-equipment-alert-1.md): Sends an equipment alert notification.
- [Send low inventory alert](https://docs.switchyard.run/api-reference/notifications/send-low-inventory-alert.md): Sends low inventory alerts for specified products.
- [Send low inventory alert](https://docs.switchyard.run/api-reference/notifications/send-low-inventory-alert-1.md): Sends low inventory alerts for specified products.
- [Send notification](https://docs.switchyard.run/api-reference/notifications/send-notification.md): Sends a notification to specified recipients.
- [Send notification](https://docs.switchyard.run/api-reference/notifications/send-notification-1.md): Sends a notification to specified recipients.
- [Send notification to staff](https://docs.switchyard.run/api-reference/notifications/send-notification-to-staff.md): Sends a push notification to a specific staff member.
- [Send notification to staff](https://docs.switchyard.run/api-reference/notifications/send-notification-to-staff-1.md): Sends a push notification to a specific staff member.
- [Send operations alert](https://docs.switchyard.run/api-reference/notifications/send-operations-alert.md): Sends an operations alert notification.
- [Send operations alert](https://docs.switchyard.run/api-reference/notifications/send-operations-alert-1.md): Sends an operations alert notification.
- [Send order confirmed notification](https://docs.switchyard.run/api-reference/notifications/send-order-confirmed-notification.md): Sends a notification that an order has been confirmed.
- [Send order confirmed notification](https://docs.switchyard.run/api-reference/notifications/send-order-confirmed-notification-1.md): Sends a notification that an order has been confirmed.
- [Send order ready notification](https://docs.switchyard.run/api-reference/notifications/send-order-ready-notification.md): Sends a notification that an order is ready for pickup.
- [Send order ready notification](https://docs.switchyard.run/api-reference/notifications/send-order-ready-notification-1.md): Sends a notification that an order is ready for pickup.
- [Send pick list ready notification](https://docs.switchyard.run/api-reference/notifications/send-pick-list-ready-notification.md): Sends a notification that a pick list is ready for a picker.
- [Send pick list ready notification](https://docs.switchyard.run/api-reference/notifications/send-pick-list-ready-notification-1.md): Sends a notification that a pick list is ready for a picker.
- [Send sweep assigned notification](https://docs.switchyard.run/api-reference/notifications/send-sweep-assigned-notification.md): Sends a notification that a sweep has been assigned to a driver.
- [Send sweep assigned notification](https://docs.switchyard.run/api-reference/notifications/send-sweep-assigned-notification-1.md): Sends a notification that a sweep has been assigned to a driver.
- [Update notification preferences](https://docs.switchyard.run/api-reference/notifications/update-notification-preferences.md): Updates notification preferences for a user.
- [Update notification preferences](https://docs.switchyard.run/api-reference/notifications/update-notification-preferences-1.md): Updates notification preferences for a user.
- [Update staff notification preferences](https://docs.switchyard.run/api-reference/notifications/update-staff-notification-preferences.md): Updates notification preferences for a staff member.
- [Update staff notification preferences](https://docs.switchyard.run/api-reference/notifications/update-staff-notification-preferences-1.md): Updates notification preferences for a staff member.
- [Allocate order items](https://docs.switchyard.run/api-reference/orders/allocate-order-items.md): Allocates order items to RFC inventory (pick_list_items) or sweeps (sweep_items).
- [Allocate order items](https://docs.switchyard.run/api-reference/orders/allocate-order-items-1.md): Allocates order items to RFC inventory (pick_list_items) or sweeps (sweep_items).
- [Complete order fulfillment](https://docs.switchyard.run/api-reference/orders/complete-order-fulfillment.md): Marks an order as completed and resets all associated equipment to idle state.
- [Complete order fulfillment](https://docs.switchyard.run/api-reference/orders/complete-order-fulfillment-1.md): Marks an order as completed and resets all associated equipment to idle state.
- [Create test order](https://docs.switchyard.run/api-reference/orders/create-test-order.md): Creates a test order for development and testing purposes.
- [Create test order](https://docs.switchyard.run/api-reference/orders/create-test-order-1.md): Creates a test order for development and testing purposes.
- [Force complete an order item](https://docs.switchyard.run/api-reference/orders/force-complete-an-order-item.md): Marks an order item (and its associated sweep_item or pick_list_item) as picked/complete, assigning it to a tote or bag.
- [Force complete an order item](https://docs.switchyard.run/api-reference/orders/force-complete-an-order-item-1.md): Marks an order item (and its associated sweep_item or pick_list_item) as picked/complete, assigning it to a tote or bag.
- [Get order details](https://docs.switchyard.run/api-reference/orders/get-order-details.md): Returns detailed order information including items, fulfillment status, and economics.
- [Get order details](https://docs.switchyard.run/api-reference/orders/get-order-details-1.md): Returns detailed order information including items, fulfillment status, and economics.
- [List active pickup portals](https://docs.switchyard.run/api-reference/orders/list-active-pickup-portals.md): Returns all active pickup portals for portal selection during customer arrival.
- [List active pickup portals](https://docs.switchyard.run/api-reference/orders/list-active-pickup-portals-1.md): Returns all active pickup portals for portal selection during customer arrival.
- [List orders with filtering and pagination](https://docs.switchyard.run/api-reference/orders/list-orders-with-filtering-and-pagination.md): Returns a paginated list of orders with customer and item details.
- [List orders with filtering and pagination](https://docs.switchyard.run/api-reference/orders/list-orders-with-filtering-and-pagination-1.md): Returns a paginated list of orders with customer and item details.
- [List test orders](https://docs.switchyard.run/api-reference/orders/list-test-orders.md): Returns a paginated list of test orders (orders with TEST- prefix).
- [List test orders](https://docs.switchyard.run/api-reference/orders/list-test-orders-1.md): Returns a paginated list of test orders (orders with TEST- prefix).
- [Mark order as delivered](https://docs.switchyard.run/api-reference/orders/mark-order-as-delivered.md): Marks an order as delivered (the step before completion).
- [Mark order as delivered](https://docs.switchyard.run/api-reference/orders/mark-order-as-delivered-1.md): Marks an order as delivered (the step before completion).
- [Retry allocation for unallocated order items](https://docs.switchyard.run/api-reference/orders/retry-allocation-for-unallocated-order-items.md): Re-runs allocation for items that failed or were never allocated. Records attempts in allocation_attempts table.
- [Retry allocation for unallocated order items](https://docs.switchyard.run/api-reference/orders/retry-allocation-for-unallocated-order-items-1.md): Re-runs allocation for items that failed or were never allocated. Records attempts in allocation_attempts table.
- [Transition order status](https://docs.switchyard.run/api-reference/orders/transition-order-status.md): Transitions an order to a new RFC status with appropriate side effects.
- [Transition order status](https://docs.switchyard.run/api-reference/orders/transition-order-status-1.md): Transitions an order to a new RFC status with appropriate side effects.
- [Update order](https://docs.switchyard.run/api-reference/orders/update-order.md): Updates order status and metadata.
- [Update order](https://docs.switchyard.run/api-reference/orders/update-order-1.md): Updates order status and metadata.
- [List categories](https://docs.switchyard.run/api-reference/partner-categories/list-categories.md): Returns a list of top-level product categories for product submission.
- [List subcategories](https://docs.switchyard.run/api-reference/partner-categories/list-subcategories.md): Returns leaf-level subcategories for a given parent category.
- [Get manifest data for printing](https://docs.switchyard.run/api-reference/partner-manifests/get-manifest-data-for-printing.md): Returns manifest data formatted for printing, including QR code data.
- [Get manifest details](https://docs.switchyard.run/api-reference/partner-manifests/get-manifest-details.md): Returns detailed manifest information including all line items.
- [List manifests](https://docs.switchyard.run/api-reference/partner-manifests/list-manifests.md): Returns a paginated list of manifests for this partner brand.
- [Mark manifest as shipped](https://docs.switchyard.run/api-reference/partner-manifests/mark-manifest-as-shipped.md): Marks an approved manifest as in transit.
- [Update shipping info](https://docs.switchyard.run/api-reference/partner-manifests/update-shipping-info.md): Updates tracking number, carrier, and expected delivery date for a manifest.
- [Claim an existing product](https://docs.switchyard.run/api-reference/partner-products/claim-an-existing-product.md): Creates a claim request for an existing product that belongs to the partner's brand.
- [Create Shopify sync configuration for a product](https://docs.switchyard.run/api-reference/partner-products/create-shopify-sync-configuration-for-a-product.md)
- [Delete Shopify sync configuration](https://docs.switchyard.run/api-reference/partner-products/delete-shopify-sync-configuration.md)
- [Get product details](https://docs.switchyard.run/api-reference/partner-products/get-product-details.md): Returns detailed information about a specific partner product.
- [Get Shopify sync configuration for a product](https://docs.switchyard.run/api-reference/partner-products/get-shopify-sync-configuration-for-a-product.md)
- [Get signed URL for image upload](https://docs.switchyard.run/api-reference/partner-products/get-signed-url-for-image-upload.md): Returns a signed URL to upload an image directly to Supabase Storage. The URL is valid for 60 seconds.
- [Import product data from Shopify URL](https://docs.switchyard.run/api-reference/partner-products/import-product-data-from-shopify-url.md): Fetches product information from a public Shopify product URL and returns normalized data. Images are re-uploaded to storage for reliability.
- [List partner products](https://docs.switchyard.run/api-reference/partner-products/list-partner-products.md): Returns a paginated list of products submitted by this partner.
- [List product requests](https://docs.switchyard.run/api-reference/partner-products/list-product-requests.md): Returns the partner's pending and recent product requests.
- [List products from linked brand](https://docs.switchyard.run/api-reference/partner-products/list-products-from-linked-brand.md): Returns products matching the partner's linked brand, including claim status and retailer mapping info.
- [Manually trigger sync for a product](https://docs.switchyard.run/api-reference/partner-products/manually-trigger-sync-for-a-product.md)
- [Request an edit to a claimed product](https://docs.switchyard.run/api-reference/partner-products/request-an-edit-to-a-claimed-product.md): Creates an edit request for a product the partner owns or has claimed. UPC edits are blocked for products with retailer mappings.
- [Request to supply a product directly](https://docs.switchyard.run/api-reference/partner-products/request-to-supply-a-product-directly.md): Creates a conversion request to start supplying a product directly instead of through retailers.
- [Submit a new product](https://docs.switchyard.run/api-reference/partner-products/submit-a-new-product.md): Submits a new product for approval. Creates a scraped_product and a disabled sellable_product.
- [Update product](https://docs.switchyard.run/api-reference/partner-products/update-product.md): Updates a product. Only allowed for products that are not yet approved.
- [Update Shopify sync preferences](https://docs.switchyard.run/api-reference/partner-products/update-shopify-sync-preferences.md)
- [List manifests available for receiving](https://docs.switchyard.run/api-reference/partner-receiving/list-manifests-available-for-receiving.md): Returns partner manifests that are approved or in transit, ready to be received.
- [List manifests available for receiving](https://docs.switchyard.run/api-reference/partner-receiving/list-manifests-available-for-receiving-1.md): Returns partner manifests that are approved or in transit, ready to be received.
- [Lookup manifest by taxonomy ID](https://docs.switchyard.run/api-reference/partner-receiving/lookup-manifest-by-taxonomy-id.md): Scans a manifest QR code (TYPE 27) and returns the manifest with items for receiving.
- [Lookup manifest by taxonomy ID](https://docs.switchyard.run/api-reference/partner-receiving/lookup-manifest-by-taxonomy-id-1.md): Scans a manifest QR code (TYPE 27) and returns the manifest with items for receiving.
- [Receive a manifest item](https://docs.switchyard.run/api-reference/partner-receiving/receive-a-manifest-item.md): Marks a manifest item as received, creates consignment inventory.
- [Receive a manifest item](https://docs.switchyard.run/api-reference/partner-receiving/receive-a-manifest-item-1.md): Marks a manifest item as received, creates consignment inventory.
- [Accept reorder request](https://docs.switchyard.run/api-reference/partner-reorder-requests/accept-reorder-request.md): Accepts a pending reorder request and creates a manifest for the shipment.
- [Get reorder request details](https://docs.switchyard.run/api-reference/partner-reorder-requests/get-reorder-request-details.md): Returns detailed request information including all requested items.
- [List reorder requests](https://docs.switchyard.run/api-reference/partner-reorder-requests/list-reorder-requests.md): Returns a paginated list of reorder requests for this partner brand.
- [Reject reorder request](https://docs.switchyard.run/api-reference/partner-reorder-requests/reject-reorder-request.md): Rejects a pending reorder request with a reason.
- [Get sales summary](https://docs.switchyard.run/api-reference/partner-sales/get-sales-summary.md): Returns sales summary grouped by period (month) plus lifetime totals.
- [List inventory](https://docs.switchyard.run/api-reference/partner-sales/list-inventory.md): Returns current inventory levels for all products owned by the partner.
- [List sales](https://docs.switchyard.run/api-reference/partner-sales/list-sales.md): Returns a paginated list of consignment sales with optional period filtering.
- [Get dashboard statistics](https://docs.switchyard.run/api-reference/partner/get-dashboard-statistics.md): Returns dashboard statistics for the partner including pending requests, inventory, and sales.
- [Get partner profile](https://docs.switchyard.run/api-reference/partner/get-partner-profile.md): Returns the partner brand profile for the authenticated user, or null if not registered.
- [Register as a partner brand](https://docs.switchyard.run/api-reference/partner/register-as-a-partner-brand.md): Creates a new partner brand registration for the authenticated user. The registration will be pending until approved by an admin.
- [Update partner profile](https://docs.switchyard.run/api-reference/partner/update-partner-profile.md): Updates the partner brand profile for the authenticated user.
- [Get performance metrics](https://docs.switchyard.run/api-reference/performance/get-performance-metrics.md): Returns performance metrics for a date range including: - Order count and total sales - Average fulfillment time (from arrival to delivery) - RFC vs sweep item breakdown - Estimated profit based on selling price minus purchase price
- [List all portals](https://docs.switchyard.run/api-reference/portals/list-all-portals.md): Returns all pickup portals with their current active status.
- [Update portal status](https://docs.switchyard.run/api-reference/portals/update-portal-status.md): Activate or deactivate a pickup portal. Used by the robot dashboard to manage portal availability.
- [Post v1dispatch:idassign bag to tote](https://docs.switchyard.run/api-reference/post-v1dispatch:idassign-bag-to-tote.md)
- [Post v1dispatch:idcomplete](https://docs.switchyard.run/api-reference/post-v1dispatch:idcomplete.md)
- [Post v1dispatch:idstart](https://docs.switchyard.run/api-reference/post-v1dispatch:idstart.md)
- [Post v1dispatch:idverify tote](https://docs.switchyard.run/api-reference/post-v1dispatch:idverify-tote.md)
- [Post v1scannerdispatch:idassign bag to tote](https://docs.switchyard.run/api-reference/post-v1scannerdispatch:idassign-bag-to-tote.md)
- [Post v1scannerdispatch:idcomplete](https://docs.switchyard.run/api-reference/post-v1scannerdispatch:idcomplete.md)
- [Post v1scannerdispatch:idstart](https://docs.switchyard.run/api-reference/post-v1scannerdispatch:idstart.md)
- [Post v1scannerdispatch:idverify tote](https://docs.switchyard.run/api-reference/post-v1scannerdispatch:idverify-tote.md)
- [Post v1scannerreceipts](https://docs.switchyard.run/api-reference/post-v1scannerreceipts.md)
- [Post v1scannerreceipts stitch](https://docs.switchyard.run/api-reference/post-v1scannerreceipts-stitch.md)
- [Activate a product](https://docs.switchyard.run/api-reference/products/activate-a-product.md): Activates a product and optionally updates its details. Accepts UUID or taxonomy ID.
- [Adjust inventory quantity for a product at a specific slot](https://docs.switchyard.run/api-reference/products/adjust-inventory-quantity-for-a-product-at-a-specific-slot.md): Creates or updates an inventory item for a product at the specified warehouse slot. Quantity is an absolute value (not a delta).
- [Create/publish a sellable product](https://docs.switchyard.run/api-reference/products/createpublish-a-sellable-product.md): Creates a new sellable product from an existing scraped product.
- [Get product by barcode](https://docs.switchyard.run/api-reference/products/get-product-by-barcode.md): Looks up a product by barcode and returns detailed information including inventory, availability, and history.
- [Get product count statistics](https://docs.switchyard.run/api-reference/products/get-product-count-statistics.md): Returns counts of products by type (RFC/non-RFC) and status (active/inactive).
- [Get product demand data](https://docs.switchyard.run/api-reference/products/get-product-demand-data.md): Returns 30-day demand data for a product including daily order counts, velocity, and trend analysis.
- [Get product details](https://docs.switchyard.run/api-reference/products/get-product-details.md): Returns detailed product information including inventory and retailer availability. Accepts UUID or taxonomy ID.
- [Get product order activity](https://docs.switchyard.run/api-reference/products/get-product-order-activity.md): Returns recent order activity for a product showing the last 20 orders.
- [List products with filtering and pagination](https://docs.switchyard.run/api-reference/products/list-products-with-filtering-and-pagination.md): Returns a paginated list of sellable products with optional filtering by type, status, and search. Supports sorting by name or demand.
- [Relocate all inventory items for a product to a new slot](https://docs.switchyard.run/api-reference/products/relocate-all-inventory-items-for-a-product-to-a-new-slot.md): Moves all active inventory items for a product to a different warehouse slot.
- [Update product details](https://docs.switchyard.run/api-reference/products/update-product-details.md): Updates product information. Accepts UUID or taxonomy ID.
- [Get all brands](https://docs.switchyard.run/api-reference/reference/get-all-brands.md): Returns distinct brands from scraped products.
- [Get all brands](https://docs.switchyard.run/api-reference/reference/get-all-brands-1.md): Returns distinct brands from scraped products.
- [Get category tree](https://docs.switchyard.run/api-reference/reference/get-category-tree.md): Returns hierarchical category tree.
- [Get category tree](https://docs.switchyard.run/api-reference/reference/get-category-tree-1.md): Returns hierarchical category tree.
- [Create restock list for stocking cart](https://docs.switchyard.run/api-reference/restocking/create-restock-list-for-stocking-cart.md): Creates a restock list from all unrectocked items on a stocking cart.
- [Get restock list detail](https://docs.switchyard.run/api-reference/restocking/get-restock-list-detail.md)
- [Get restocking cart summaries](https://docs.switchyard.run/api-reference/restocking/get-restocking-cart-summaries.md): Returns a summary of stocking carts with unrestocked items, sorted by oldest item first.
- [List restock lists](https://docs.switchyard.run/api-reference/restocking/list-restock-lists.md)
- [Perform restock action](https://docs.switchyard.run/api-reference/restocking/perform-restock-action.md)
- [Update restock item](https://docs.switchyard.run/api-reference/restocking/update-restock-item.md)
- [Create location](https://docs.switchyard.run/api-reference/retailers/create-location.md): Create a new retailer location
- [Create location](https://docs.switchyard.run/api-reference/retailers/create-location-1.md): Create a new retailer location
- [Get all locations](https://docs.switchyard.run/api-reference/retailers/get-all-locations.md): Get all retailer locations for dropdown selection
- [Get all locations](https://docs.switchyard.run/api-reference/retailers/get-all-locations-1.md): Get all retailer locations for dropdown selection
- [Get location detail](https://docs.switchyard.run/api-reference/retailers/get-location-detail.md): Get location details with products, stats, and filters
- [Get location detail](https://docs.switchyard.run/api-reference/retailers/get-location-detail-1.md): Get location details with products, stats, and filters
- [Get retailer](https://docs.switchyard.run/api-reference/retailers/get-retailer.md): Get a single retailer with its locations
- [Get retailer](https://docs.switchyard.run/api-reference/retailers/get-retailer-1.md): Get a single retailer with its locations
- [List retailers with locations](https://docs.switchyard.run/api-reference/retailers/list-retailers-with-locations.md): List all retailers with their locations and product counts
- [List retailers with locations](https://docs.switchyard.run/api-reference/retailers/list-retailers-with-locations-1.md): List all retailers with their locations and product counts
- [Update location](https://docs.switchyard.run/api-reference/retailers/update-location.md): Update a retailer location
- [Update location](https://docs.switchyard.run/api-reference/retailers/update-location-1.md): Update a retailer location
- [Assign cart to pick list](https://docs.switchyard.run/api-reference/rfc-picks/assign-cart-to-pick-list.md): Assigns an order cart to the pick list and sets it as the active cart. The cart must be an order cart and idle.
- [Assign cart to pick list](https://docs.switchyard.run/api-reference/rfc-picks/assign-cart-to-pick-list-1.md): Assigns an order cart to the pick list and sets it as the active cart. The cart must be an order cart and idle.
- [Assign tote to active cart](https://docs.switchyard.run/api-reference/rfc-picks/assign-tote-to-active-cart.md): Assigns a tote to the active cart. The cart can have up to 3 totes. First tote becomes the active tote.
- [Assign tote to active cart](https://docs.switchyard.run/api-reference/rfc-picks/assign-tote-to-active-cart-1.md): Assigns a tote to the active cart. The cart can have up to 3 totes. First tote becomes the active tote.
- [Complete cart and route to destination](https://docs.switchyard.run/api-reference/rfc-picks/complete-cart-and-route-to-destination.md): Completes the active cart. Routes to receiving_zone if order has sweep items, otherwise to staging_zone.
- [Complete cart and route to destination](https://docs.switchyard.run/api-reference/rfc-picks/complete-cart-and-route-to-destination-1.md): Completes the active cart. Routes to receiving_zone if order has sweep items, otherwise to staging_zone.
- [Create pick list](https://docs.switchyard.run/api-reference/rfc-picks/create-pick-list.md): Creates a new pick list for an order.
- [Create pick list](https://docs.switchyard.run/api-reference/rfc-picks/create-pick-list-1.md): Creates a new pick list for an order.
- [Force-release a cart and all its totes from existing assignments](https://docs.switchyard.run/api-reference/rfc-picks/force-release-a-cart-and-all-its-totes-from-existing-assignments.md): Clears all assignments on a cart: pick_list_id, order_id, totes, and resets all associated totes, pick_list_items, and bags.
- [Force-release a cart and all its totes from existing assignments](https://docs.switchyard.run/api-reference/rfc-picks/force-release-a-cart-and-all-its-totes-from-existing-assignments-1.md): Clears all assignments on a cart: pick_list_id, order_id, totes, and resets all associated totes, pick_list_items, and bags.
- [Force-release a tote from existing assignments](https://docs.switchyard.run/api-reference/rfc-picks/force-release-a-tote-from-existing-assignments.md): Clears all assignments on a tote: cart_id, order_id, and resets associated pick_list_items and bags.
- [Force-release a tote from existing assignments](https://docs.switchyard.run/api-reference/rfc-picks/force-release-a-tote-from-existing-assignments-1.md): Clears all assignments on a tote: cart_id, order_id, and resets associated pick_list_items and bags.
- [Get pick list by ID](https://docs.switchyard.run/api-reference/rfc-picks/get-pick-list-by-id.md): Returns detailed pick list information including items and locations.
- [Get pick list by ID](https://docs.switchyard.run/api-reference/rfc-picks/get-pick-list-by-id-1.md): Returns detailed pick list information including items and locations.
- [List pick lists](https://docs.switchyard.run/api-reference/rfc-picks/list-pick-lists.md): Returns pick lists filtered by status.
- [List pick lists](https://docs.switchyard.run/api-reference/rfc-picks/list-pick-lists-1.md): Returns pick lists filtered by status.
- [Mark tote as full](https://docs.switchyard.run/api-reference/rfc-picks/mark-tote-as-full.md): Marks the active tote as full and switches to the next available tote on the cart.
- [Mark tote as full](https://docs.switchyard.run/api-reference/rfc-picks/mark-tote-as-full-1.md): Marks the active tote as full and switches to the next available tote on the cart.
- [Perform pick list action](https://docs.switchyard.run/api-reference/rfc-picks/perform-pick-list-action.md): Performs an action on a pick list (claim, start, complete).
- [Perform pick list action](https://docs.switchyard.run/api-reference/rfc-picks/perform-pick-list-action-1.md): Performs an action on a pick list (claim, start, complete).
- [Scan barcode for item](https://docs.switchyard.run/api-reference/rfc-picks/scan-barcode-for-item.md): Scans a barcode to verify and pick an item.
- [Scan barcode for item](https://docs.switchyard.run/api-reference/rfc-picks/scan-barcode-for-item-1.md): Scans a barcode to verify and pick an item.
- [Update pick list item](https://docs.switchyard.run/api-reference/rfc-picks/update-pick-list-item.md): Updates a pick list item status or picked quantity.
- [Update pick list item](https://docs.switchyard.run/api-reference/rfc-picks/update-pick-list-item-1.md): Updates a pick list item status or picked quantity.
- [Get role by ID](https://docs.switchyard.run/api-reference/roles/get-role-by-id.md): Get a single role with its permissions
- [Get role by ID](https://docs.switchyard.run/api-reference/roles/get-role-by-id-1.md): Get a single role with its permissions
- [List all permissions](https://docs.switchyard.run/api-reference/roles/list-all-permissions.md): Get a list of all available permissions, grouped by resource
- [List all permissions](https://docs.switchyard.run/api-reference/roles/list-all-permissions-1.md): Get a list of all available permissions, grouped by resource
- [List all roles](https://docs.switchyard.run/api-reference/roles/list-all-roles.md): Get a list of all roles with their permissions
- [List all roles](https://docs.switchyard.run/api-reference/roles/list-all-roles-1.md): Get a list of all roles with their permissions
- [Update role](https://docs.switchyard.run/api-reference/roles/update-role.md): Update a role's description
- [Update role](https://docs.switchyard.run/api-reference/roles/update-role-1.md): Update a role's description
- [Update role permissions](https://docs.switchyard.run/api-reference/roles/update-role-permissions.md): Replace all permissions for a role
- [Update role permissions](https://docs.switchyard.run/api-reference/roles/update-role-permissions-1.md): Replace all permissions for a role
- [Assign tote to cart](https://docs.switchyard.run/api-reference/scanner-actions/assign-tote-to-cart.md): Assigns a tote to a cart and sets it as the active tote.
- [Assign tote to cart](https://docs.switchyard.run/api-reference/scanner-actions/assign-tote-to-cart-1.md): Assigns a tote to a cart and sets it as the active tote.
- [Assign tote to robot](https://docs.switchyard.run/api-reference/scanner-actions/assign-tote-to-robot.md): Assigns a tote to a robot and sets it as the active tote.
- [Assign tote to robot](https://docs.switchyard.run/api-reference/scanner-actions/assign-tote-to-robot-1.md): Assigns a tote to a robot and sets it as the active tote.
- [Identify barcode](https://docs.switchyard.run/api-reference/scanner-actions/identify-barcode.md): Identifies what entity a barcode represents (tote, robot, cart, bag, or product).
- [Identify barcode](https://docs.switchyard.run/api-reference/scanner-actions/identify-barcode-1.md): Identifies what entity a barcode represents (tote, robot, cart, bag, or product).
- [Remove tote from cart](https://docs.switchyard.run/api-reference/scanner-actions/remove-tote-from-cart.md): Removes a tote from a cart.
- [Remove tote from cart](https://docs.switchyard.run/api-reference/scanner-actions/remove-tote-from-cart-1.md): Removes a tote from a cart.
- [Activate product](https://docs.switchyard.run/api-reference/scanner/activate-product.md): Activate a sellable product and optionally update its details.
- [Add scan history entries](https://docs.switchyard.run/api-reference/scanner/add-scan-history-entries.md): Add scan history entries in batch (upsert on conflict).
- [Add scan history entries](https://docs.switchyard.run/api-reference/scanner/add-scan-history-entries-1.md): Add scan history entries in batch (upsert on conflict).
- [Clear scan history](https://docs.switchyard.run/api-reference/scanner/clear-scan-history.md): Clears all scan history for the user.
- [Clear scan history](https://docs.switchyard.run/api-reference/scanner/clear-scan-history-1.md): Clears all scan history for the user.
- [Get notification preferences](https://docs.switchyard.run/api-reference/scanner/get-notification-preferences.md): Get the current staff member notification preferences.
- [Get pending approvals](https://docs.switchyard.run/api-reference/scanner/get-pending-approvals.md): Returns pending timesheets and leave requests from Deputy.
- [Get product details by barcode or sellable product ID](https://docs.switchyard.run/api-reference/scanner/get-product-details-by-barcode-or-sellable-product-id.md): Returns detailed product information including inventory, availability, and history. Accepts either a barcode or a sellable product UUID.
- [Get scan history](https://docs.switchyard.run/api-reference/scanner/get-scan-history.md): Returns the user's scan history from the database.
- [Get scan history](https://docs.switchyard.run/api-reference/scanner/get-scan-history-1.md): Returns the user's scan history from the database.
- [Get user tasks](https://docs.switchyard.run/api-reference/scanner/get-user-tasks.md): Returns tasks split into two lists: - myTasks: Tasks assigned to the current staff member - availableTasks: Unassigned tasks (staff_id IS NULL) ordered by priority
- [Get user tasks](https://docs.switchyard.run/api-reference/scanner/get-user-tasks-1.md): Returns tasks split into two lists: - myTasks: Tasks assigned to the current staff member - availableTasks: Unassigned tasks (staff_id IS NULL) ordered by priority
- [Get workforce insights](https://docs.switchyard.run/api-reference/scanner/get-workforce-insights.md): Returns workforce insights from Deputy for the specified period.
- [List all sensors](https://docs.switchyard.run/api-reference/scanner/list-all-sensors.md): Returns all temperature sensors with current readings and status.
- [List staff](https://docs.switchyard.run/api-reference/scanner/list-staff.md): Returns staff from local database with PIN info.
- [Publish product](https://docs.switchyard.run/api-reference/scanner/publish-product.md): Create a sellable product from a scraped product.
- [Register push notification token](https://docs.switchyard.run/api-reference/scanner/register-push-notification-token.md): Register or update an Expo push token for the current staff member.
- [Send test notification](https://docs.switchyard.run/api-reference/scanner/send-test-notification.md): Send a test push notification to the current staff member.
- [Update notification preferences](https://docs.switchyard.run/api-reference/scanner/update-notification-preferences.md): Update the current staff member notification preferences.
- [Update staff PIN](https://docs.switchyard.run/api-reference/scanner/update-staff-pin.md): Update a staff member's PIN.
- [Approve leave request](https://docs.switchyard.run/api-reference/scheduling/approve-leave-request.md): Approve a leave request in Deputy.
- [Approve leave request](https://docs.switchyard.run/api-reference/scheduling/approve-leave-request-1.md): Approve a leave request in Deputy.
- [Approve timesheet](https://docs.switchyard.run/api-reference/scheduling/approve-timesheet.md): Approves a timesheet in Deputy.
- [Approve timesheet](https://docs.switchyard.run/api-reference/scheduling/approve-timesheet-1.md): Approve a timesheet in Deputy.
- [Create shift](https://docs.switchyard.run/api-reference/scheduling/create-shift.md): Create a new shift (Roster) in Deputy.
- [Decline leave request](https://docs.switchyard.run/api-reference/scheduling/decline-leave-request.md): Decline a leave request in Deputy with optional comment.
- [Decline leave request](https://docs.switchyard.run/api-reference/scheduling/decline-leave-request-1.md): Decline a leave request in Deputy with an optional comment.
- [Delete shift](https://docs.switchyard.run/api-reference/scheduling/delete-shift.md): Delete a shift (Roster) from Deputy.
- [Get employee schedule](https://docs.switchyard.run/api-reference/scheduling/get-employee-schedule.md): Returns shifts for the next 7 days. Supports staff_id query param for PIN auth.
- [Get employee schedule](https://docs.switchyard.run/api-reference/scheduling/get-employee-schedule-1.md): Returns shifts for the next 7 days. Supports staff_id query param for PIN auth.
- [Get leave requests](https://docs.switchyard.run/api-reference/scheduling/get-leave-requests.md): Get leave requests from Deputy, optionally filtered by status.
- [Get pending approvals](https://docs.switchyard.run/api-reference/scheduling/get-pending-approvals.md): Get all pending timesheet and leave approvals from Deputy.
- [Get schedules](https://docs.switchyard.run/api-reference/scheduling/get-schedules.md): Returns schedules from Deputy for the specified number of days.
- [Get shifts](https://docs.switchyard.run/api-reference/scheduling/get-shifts.md): Get scheduled shifts for the specified number of days from Deputy.
- [Get timesheets](https://docs.switchyard.run/api-reference/scheduling/get-timesheets.md): Returns timesheets from Deputy for the specified number of days.
- [Get timesheets](https://docs.switchyard.run/api-reference/scheduling/get-timesheets-1.md): Get timesheets for the specified number of days from Deputy.
- [Get workforce insights](https://docs.switchyard.run/api-reference/scheduling/get-workforce-insights.md): Get workforce insights and analytics from Deputy for the specified time period.
- [List leave requests](https://docs.switchyard.run/api-reference/scheduling/list-leave-requests.md): Returns leave requests from Deputy, optionally filtered by status.
- [Update shift](https://docs.switchyard.run/api-reference/scheduling/update-shift.md): Update an existing shift (Roster) in Deputy.
- [Bulk activate scraped products](https://docs.switchyard.run/api-reference/scraped-products/bulk-activate-scraped-products.md): Bulk activate scraped products matching filters
- [Bulk activate sellable products](https://docs.switchyard.run/api-reference/scraped-products/bulk-activate-sellable-products.md): Bulk activate sellable products by category
- [Bulk deactivate scraped products](https://docs.switchyard.run/api-reference/scraped-products/bulk-deactivate-scraped-products.md): Bulk deactivate scraped products matching filters
- [Bulk deactivate sellable products](https://docs.switchyard.run/api-reference/scraped-products/bulk-deactivate-sellable-products.md): Bulk deactivate sellable products by category
- [Bulk publish by criteria](https://docs.switchyard.run/api-reference/scraped-products/bulk-publish-by-criteria.md): Bulk publish scraped products matching specified criteria
- [Bulk publish scraped products](https://docs.switchyard.run/api-reference/scraped-products/bulk-publish-scraped-products.md): Bulk publish scraped products to sellable products by IDs
- [Bulk unpublish](https://docs.switchyard.run/api-reference/scraped-products/bulk-unpublish.md): Bulk unpublish (soft delete sellable products) matching filters
- [Get category hierarchy](https://docs.switchyard.run/api-reference/scraped-products/get-category-hierarchy.md): Get category hierarchy with product counts from sellable products
- [Get scraped product details](https://docs.switchyard.run/api-reference/scraped-products/get-scraped-product-details.md): Get detailed information about a scraped product including retailer availability
- [Get scraped product statistics](https://docs.switchyard.run/api-reference/scraped-products/get-scraped-product-statistics.md): Get statistics about scraped products including field completeness
- [List scraped products](https://docs.switchyard.run/api-reference/scraped-products/list-scraped-products.md): List scraped products with filtering, pagination, and field completeness filters
- [Publish scraped product](https://docs.switchyard.run/api-reference/scraped-products/publish-scraped-product.md): Create a sellable product from a scraped product
- [Update scraped product](https://docs.switchyard.run/api-reference/scraped-products/update-scraped-product.md): Update a scraped product
- [Bulk disable scrapers](https://docs.switchyard.run/api-reference/scrapers/bulk-disable-scrapers.md): Disable multiple scrapers at once.
- [Bulk disable scrapers](https://docs.switchyard.run/api-reference/scrapers/bulk-disable-scrapers-1.md): Disable multiple scrapers at once.
- [Bulk enable scrapers](https://docs.switchyard.run/api-reference/scrapers/bulk-enable-scrapers.md): Enable multiple scrapers at once.
- [Bulk enable scrapers](https://docs.switchyard.run/api-reference/scrapers/bulk-enable-scrapers-1.md): Enable multiple scrapers at once.
- [Bulk update scraper configuration](https://docs.switchyard.run/api-reference/scrapers/bulk-update-scraper-configuration.md): Update configuration for multiple scrapers at once.
- [Bulk update scraper configuration](https://docs.switchyard.run/api-reference/scrapers/bulk-update-scraper-configuration-1.md): Update configuration for multiple scrapers at once.
- [Bulk update scraper schedules](https://docs.switchyard.run/api-reference/scrapers/bulk-update-scraper-schedules.md): Update schedule for multiple scrapers at once.
- [Bulk update scraper schedules](https://docs.switchyard.run/api-reference/scrapers/bulk-update-scraper-schedules-1.md): Update schedule for multiple scrapers at once.
- [Cancel running scraper](https://docs.switchyard.run/api-reference/scrapers/cancel-running-scraper.md): Cancel a currently running scraper.
- [Cancel running scraper](https://docs.switchyard.run/api-reference/scrapers/cancel-running-scraper-1.md): Cancel a currently running scraper.
- [Extract and upload cookies from HAR file](https://docs.switchyard.run/api-reference/scrapers/extract-and-upload-cookies-from-har-file.md): Parse a HAR file and extract cookies for scraper authentication.
- [Extract and upload cookies from HAR file](https://docs.switchyard.run/api-reference/scrapers/extract-and-upload-cookies-from-har-file-1.md): Parse a HAR file and extract cookies for scraper authentication.
- [Get real-time scraper status](https://docs.switchyard.run/api-reference/scrapers/get-real-time-scraper-status.md): Returns real-time status for polling.
- [Get real-time scraper status](https://docs.switchyard.run/api-reference/scrapers/get-real-time-scraper-status-1.md): Returns real-time status for polling.
- [Get recent runs across all scrapers](https://docs.switchyard.run/api-reference/scrapers/get-recent-runs-across-all-scrapers.md): Returns the most recent scraper runs across all retailers.
- [Get recent runs across all scrapers](https://docs.switchyard.run/api-reference/scrapers/get-recent-runs-across-all-scrapers-1.md): Returns the most recent scraper runs across all retailers.
- [Get run logs](https://docs.switchyard.run/api-reference/scrapers/get-run-logs.md): Returns logs for a specific scraper run.
- [Get run logs](https://docs.switchyard.run/api-reference/scrapers/get-run-logs-1.md): Returns logs for a specific scraper run.
- [Get schedule presets](https://docs.switchyard.run/api-reference/scrapers/get-schedule-presets.md): Returns schedule presets and current schedules for bulk updates.
- [Get schedule presets](https://docs.switchyard.run/api-reference/scrapers/get-schedule-presets-1.md): Returns schedule presets and current schedules for bulk updates.
- [Get scraper details](https://docs.switchyard.run/api-reference/scrapers/get-scraper-details.md): Returns detailed info for a specific scraper.
- [Get scraper details](https://docs.switchyard.run/api-reference/scrapers/get-scraper-details-1.md): Returns detailed info for a specific scraper.
- [Get scraper run history](https://docs.switchyard.run/api-reference/scrapers/get-scraper-run-history.md): Returns paginated run history for a scraper.
- [Get scraper run history](https://docs.switchyard.run/api-reference/scrapers/get-scraper-run-history-1.md): Returns paginated run history for a scraper.
- [Get single run details](https://docs.switchyard.run/api-reference/scrapers/get-single-run-details.md): Returns details for a specific scraper run.
- [Get single run details](https://docs.switchyard.run/api-reference/scrapers/get-single-run-details-1.md): Returns details for a specific scraper run.
- [Invalidate cookies](https://docs.switchyard.run/api-reference/scrapers/invalidate-cookies.md): Mark cookies as invalid for a retailer.
- [Invalidate cookies](https://docs.switchyard.run/api-reference/scrapers/invalidate-cookies-1.md): Mark cookies as invalid for a retailer.
- [List all scrapers](https://docs.switchyard.run/api-reference/scrapers/list-all-scrapers.md): Returns all scrapers with their configs and last run status.
- [List all scrapers](https://docs.switchyard.run/api-reference/scrapers/list-all-scrapers-1.md): Returns all scrapers with their configs and last run status.
- [List cookie records](https://docs.switchyard.run/api-reference/scrapers/list-cookie-records.md): Returns all cookie records for scrapers.
- [List cookie records](https://docs.switchyard.run/api-reference/scrapers/list-cookie-records-1.md): Returns all cookie records for scrapers.
- [Trigger scraper run](https://docs.switchyard.run/api-reference/scrapers/trigger-scraper-run.md): Manually trigger a scraper run.
- [Trigger scraper run](https://docs.switchyard.run/api-reference/scrapers/trigger-scraper-run-1.md): Manually trigger a scraper run.
- [Update scraper configuration](https://docs.switchyard.run/api-reference/scrapers/update-scraper-configuration.md): Update configuration for a specific scraper.
- [Update scraper configuration](https://docs.switchyard.run/api-reference/scrapers/update-scraper-configuration-1.md): Update configuration for a specific scraper.
- [Upload cookies for a retailer](https://docs.switchyard.run/api-reference/scrapers/upload-cookies-for-a-retailer.md): Upload or update cookies for scraper authentication.
- [Upload cookies for a retailer](https://docs.switchyard.run/api-reference/scrapers/upload-cookies-for-a-retailer-1.md): Upload or update cookies for scraper authentication.
- [Global search](https://docs.switchyard.run/api-reference/search/global-search.md): Search across all entity types: products, orders, sweeps, staff, customers, retailers, and locations.
- [Global search](https://docs.switchyard.run/api-reference/search/global-search-1.md): Search across all entity types: products, orders, sweeps, staff, customers, retailers, and locations.
- [Search products](https://docs.switchyard.run/api-reference/search/search-products.md): Search sellable products using Meilisearch with Supabase fallback.
- [Search products](https://docs.switchyard.run/api-reference/search/search-products-1.md): Search sellable products using Meilisearch with Supabase fallback.
- [Bulk activate sellable products](https://docs.switchyard.run/api-reference/sellable-products/bulk-activate-sellable-products.md): Bulk activate sellable products with filters
- [Bulk deactivate sellable products](https://docs.switchyard.run/api-reference/sellable-products/bulk-deactivate-sellable-products.md): Bulk deactivate sellable products with filters
- [Get sellable product categories](https://docs.switchyard.run/api-reference/sellable-products/get-sellable-product-categories.md): Get category hierarchy for sellable products with counts
- [Get sellable product statistics](https://docs.switchyard.run/api-reference/sellable-products/get-sellable-product-statistics.md): Get statistics about sellable products
- [Get sweep economics defaults](https://docs.switchyard.run/api-reference/settings/get-sweep-economics-defaults.md): Returns default sweep economics configuration values.
- [Get sweep economics defaults](https://docs.switchyard.run/api-reference/settings/get-sweep-economics-defaults-1.md): Returns default sweep economics configuration values.
- [Get sweep economics settings](https://docs.switchyard.run/api-reference/settings/get-sweep-economics-settings.md): Returns current sweep economics configuration values.
- [Get sweep economics settings](https://docs.switchyard.run/api-reference/settings/get-sweep-economics-settings-1.md): Returns current sweep economics configuration values.
- [Update sweep economics settings](https://docs.switchyard.run/api-reference/settings/update-sweep-economics-settings.md): Updates sweep economics configuration values.
- [Update sweep economics settings](https://docs.switchyard.run/api-reference/settings/update-sweep-economics-settings-1.md): Updates sweep economics configuration values.
- [Get current staff](https://docs.switchyard.run/api-reference/staff/get-current-staff.md): Get the currently authenticated staff member
- [Get staff by ID](https://docs.switchyard.run/api-reference/staff/get-staff-by-id.md): Get a staff member by UUID or taxonomy ID
- [Get staff member by ID](https://docs.switchyard.run/api-reference/staff/get-staff-member-by-id.md): Returns a single staff member by ID with detailed information.
- [List all staff](https://docs.switchyard.run/api-reference/staff/list-all-staff.md): Get a list of all active staff members with their roles
- [List staff members](https://docs.switchyard.run/api-reference/staff/list-staff-members.md): Returns all active staff members with their roles.
- [Update staff](https://docs.switchyard.run/api-reference/staff/update-staff.md): Update staff role and operational units
- [Update staff member](https://docs.switchyard.run/api-reference/staff/update-staff-member.md): Updates a staff member's role or operational units.
- [Update staff PIN](https://docs.switchyard.run/api-reference/staff/update-staff-pin.md): Update a staff member's 6-digit PIN
- [Add barcode to a product missing one](https://docs.switchyard.run/api-reference/sweeps/add-barcode-to-a-product-missing-one.md): Sets the barcode, scan_barcode, and norm_barcode fields on a scraped_product that is missing a barcode. Used during receiving when scanning a physical product for the first time.
- [Add barcode to a product missing one](https://docs.switchyard.run/api-reference/sweeps/add-barcode-to-a-product-missing-one-1.md): Sets the barcode, scan_barcode, and norm_barcode fields on a scraped_product that is missing a barcode. Used during receiving when scanning a physical product for the first time.
- [Confirm cart moved to staging zone](https://docs.switchyard.run/api-reference/sweeps/confirm-cart-moved-to-staging-zone.md): Updates cart location to staging_zone after all ambient items received
- [Confirm cart moved to staging zone](https://docs.switchyard.run/api-reference/sweeps/confirm-cart-moved-to-staging-zone-1.md): Updates cart location to staging_zone after all ambient items received
- [Create a sweep](https://docs.switchyard.run/api-reference/sweeps/create-a-sweep.md): Creates a new sweep with optional items.
- [Create sweep](https://docs.switchyard.run/api-reference/sweeps/create-sweep.md): Create a new sweep with optional items
- [Get pending items for receiving](https://docs.switchyard.run/api-reference/sweeps/get-pending-items-for-receiving.md): Returns items from completed/delivered sweeps that are pending receiving.
- [Get pending items for receiving](https://docs.switchyard.run/api-reference/sweeps/get-pending-items-for-receiving-1.md): Returns items from completed/delivered sweeps that are pending receiving.
- [Get single sweep economics](https://docs.switchyard.run/api-reference/sweeps/get-single-sweep-economics.md): Returns economics data for a specific sweep.
- [Get single sweep economics](https://docs.switchyard.run/api-reference/sweeps/get-single-sweep-economics-1.md): Returns economics data for a specific sweep.
- [Get sweep by ID](https://docs.switchyard.run/api-reference/sweeps/get-sweep-by-id.md): Returns detailed sweep information including items and products.
- [Get sweep by ID](https://docs.switchyard.run/api-reference/sweeps/get-sweep-by-id-1.md): Get detailed information about a specific sweep including items and order allocations
- [Get sweep economics](https://docs.switchyard.run/api-reference/sweeps/get-sweep-economics.md): Returns economics data for all active/upcoming sweeps.
- [Get sweep economics](https://docs.switchyard.run/api-reference/sweeps/get-sweep-economics-1.md): Returns economics data for all active/upcoming sweeps.
- [List sweeps](https://docs.switchyard.run/api-reference/sweeps/list-sweeps.md): Returns sweeps filtered by status.
- [List sweeps](https://docs.switchyard.run/api-reference/sweeps/list-sweeps-1.md): Get a list of sweeps with optional filtering by status
- [Mark bag as full](https://docs.switchyard.run/api-reference/sweeps/mark-bag-as-full.md): Marks a filling bag as full during cold receiving.
- [Mark bag as full](https://docs.switchyard.run/api-reference/sweeps/mark-bag-as-full-1.md): Marks a filling bag as full during cold receiving.
- [Mark item as not received](https://docs.switchyard.run/api-reference/sweeps/mark-item-as-not-received.md): Marks a sweep item as not received / unavailable during the receiving process. Requires a reason.
- [Mark item as not received](https://docs.switchyard.run/api-reference/sweeps/mark-item-as-not-received-1.md): Marks a sweep item as not received / unavailable during the receiving process. Requires a reason.
- [Mark item as received](https://docs.switchyard.run/api-reference/sweeps/mark-item-as-received.md): Marks a sweep item as received and optionally assigns it to a cart or bag.
- [Mark item as received](https://docs.switchyard.run/api-reference/sweeps/mark-item-as-received-1.md): Marks a sweep item as received and optionally assigns it to a cart or bag.
- [Merge a duplicate product into a canonical product](https://docs.switchyard.run/api-reference/sweeps/merge-a-duplicate-product-into-a-canonical-product.md): Re-points all foreign key references from the duplicate product to the canonical product, then deactivates the duplicate. Used when a barcode scan reveals two products are the same.
- [Merge a duplicate product into a canonical product](https://docs.switchyard.run/api-reference/sweeps/merge-a-duplicate-product-into-a-canonical-product-1.md): Re-points all foreign key references from the duplicate product to the canonical product, then deactivates the duplicate. Used when a barcode scan reveals two products are the same.
- [Optimize sweeps](https://docs.switchyard.run/api-reference/sweeps/optimize-sweeps.md): Runs the sweep optimization algorithm to consolidate under-threshold sweeps.
- [Optimize sweeps](https://docs.switchyard.run/api-reference/sweeps/optimize-sweeps-1.md): Run sweep optimization to consolidate items and reduce trips
- [Perform sweep action](https://docs.switchyard.run/api-reference/sweeps/perform-sweep-action.md): Performs an action on a sweep (claim, start, checkout, complete, deliver, decant).
- [Perform sweep action](https://docs.switchyard.run/api-reference/sweeps/perform-sweep-action-1.md): Perform an action on a sweep (claim, start, checkout, complete, deliver, decant)
- [Scan bag for cold receiving](https://docs.switchyard.run/api-reference/sweeps/scan-bag-for-cold-receiving.md): Scans a bag barcode, assigns it to an order, and auto-assigns a cold storage slot.
- [Scan bag for cold receiving](https://docs.switchyard.run/api-reference/sweeps/scan-bag-for-cold-receiving-1.md): Scans a bag barcode, assigns it to an order, and auto-assigns a cold storage slot.
- [Scan barcode for receiving](https://docs.switchyard.run/api-reference/sweeps/scan-barcode-for-receiving.md): Scans a barcode and returns matching items ready to be received.
- [Scan barcode for receiving](https://docs.switchyard.run/api-reference/sweeps/scan-barcode-for-receiving-1.md): Scans a barcode and returns matching items ready to be received.
- [Update sweep](https://docs.switchyard.run/api-reference/sweeps/update-sweep.md): Update sweep details including date, time, status, and add new items
- [Update sweep item](https://docs.switchyard.run/api-reference/sweeps/update-sweep-item.md): Updates a sweep item status or picked quantity.
- [Update sweep item](https://docs.switchyard.run/api-reference/sweeps/update-sweep-item-1.md): Update a sweep item's picked quantity, status, or notes
- [V1 API Overview](https://docs.switchyard.run/api-reference/v1/overview.md): Unified domain-based API for all Switchyard operations
- [Data Model](https://docs.switchyard.run/architecture/data-model.md): Key entities and their relationships in Switchyard
- [Order Flow](https://docs.switchyard.run/architecture/order-flow.md): Complete order lifecycle from placement to delivery
- [Sourcing Architecture](https://docs.switchyard.run/architecture/sourcing.md): How Switchyard sources products from RFC inventory, retailers, and partner brands
- [Taxonomy IDs](https://docs.switchyard.run/architecture/taxonomy-ids.md): Comprehensive guide to the 18-digit taxonomy ID system used across all Switchyard entities
- [Authentication Overview](https://docs.switchyard.run/authentication/overview.md): Understanding authentication and authorization in Switchyard
- [Role-Based Access Control](https://docs.switchyard.run/authentication/rbac.md): Managing roles and permissions in Switchyard
- [Service Accounts](https://docs.switchyard.run/authentication/service-accounts.md): Setting up automated system access with API keys
- [Equipment Monitoring System](https://docs.switchyard.run/guides/equipment-monitoring.md): Set up and manage temperature and humidity monitoring for refrigeration equipment using Swift Sensors integration
- [Inventory Management](https://docs.switchyard.run/guides/inventory-management.md): Managing inventory locations and items in Switchyard
- [MCP Server Installation](https://docs.switchyard.run/guides/mcp-installation.md): Connect your IDE to Switchyard documentation with AI assistance
- [Placing Orders](https://docs.switchyard.run/guides/placing-orders.md): How to create and manage orders in Switchyard
- [Scanner API](https://docs.switchyard.run/guides/scanner-api.md): Mobile scanning and inventory operations
- [Scraping & Product Data](https://docs.switchyard.run/guides/scraping.md): How product data flows from retailers into Switchyard
- [Zebra Hardware Setup Guide](https://docs.switchyard.run/guides/zebra-hardware-setup.md): Complete setup guide for Zebra ZD421 printer and TC58 scanner integration with Goods
- [Introduction](https://docs.switchyard.run/introduction.md): Welcome to the Switchyard platform documentation
- [Quickstart](https://docs.switchyard.run/quickstart.md): Get started with the Switchyard API in minutes

## OpenAPI Specs

- [openapi](https://docs.switchyard.run/api-reference/openapi.json)