Overview
Sweeps
- GETList sweeps
- GETGet sweep by ID
- POSTPerform sweep action
- PATCHUpdate sweep item
- GETGet pending items for receiving
- POSTScan barcode for receiving
- POSTScan bag for cold receiving
- POSTMark bag as full
- PATCHMark item as received
- POSTConfirm cart moved to staging zone
- PATCHAdd barcode to a product missing one
- POSTMerge a duplicate product into a canonical product
- PATCHMark item as not received
- POSTCreate a sweep
- POSTOptimize sweeps
- GETGet sweep economics
- GETGet single sweep economics
- GETList sweeps
- POSTCreate sweep
- GETGet sweep by ID
- PATCHUpdate sweep
- POSTOptimize sweeps
- GETGet sweep economics
- GETGet single sweep economics
- POSTPerform sweep action
- PATCHUpdate sweep item
- GETGet pending items for receiving
- POSTScan barcode for receiving
- POSTScan bag for cold receiving
- POSTMark bag as full
- PATCHMark item as received
- POSTConfirm cart moved to staging zone
- PATCHAdd barcode to a product missing one
- POSTMerge a duplicate product into a canonical product
- PATCHMark item as not received
RFC Picks
- GETList pick lists
- POSTCreate pick list
- GETGet pick list by ID
- POSTPerform pick list action
- PATCHUpdate pick list item
- POSTScan barcode for item
- POSTAssign cart to pick list
- POSTAssign tote to active cart
- POSTMark tote as full
- POSTComplete cart and route to destination
- POSTForce-release a cart and all its totes from existing assignments
- POSTForce-release a tote from existing assignments
- GETList pick lists
- POSTCreate pick list
- GETGet pick list by ID
- POSTPerform pick list action
- PATCHUpdate pick list item
- POSTScan barcode for item
- POSTAssign cart to pick list
- POSTAssign tote to active cart
- POSTMark tote as full
- POSTComplete cart and route to destination
- POSTForce-release a cart and all its totes from existing assignments
- POSTForce-release a tote from existing assignments
Inventory
- GETList inventory groups
- GETGet inventory group
- GETLookup product by barcode
- POSTScan inventory
- GETGet all slots with availability
- POSTConvert multipack inventory
- GETList inventory groups
- GETGet inventory group
- GETLookup product by barcode
- POSTScan inventory
- GETGet all slots with availability
- POSTConvert multipack inventory
- GETGet inventory summary metrics
- POSTRecalculate demand velocity for inventory products
Scanner
- GETGet product details by barcode or sellable product ID
- POSTPublish product
- PATCHActivate product
- GETGet user tasks
- GETList staff
- PATCHUpdate staff PIN
- GETGet pending approvals
- GETGet workforce insights
- GETList all sensors
- GETGet scan history
- POSTAdd scan history entries
- DELClear scan history
- POSTRegister push notification token
- GETGet notification preferences
- PUTUpdate notification preferences
- POSTSend test notification
- GETGet user tasks
- GETGet scan history
- POSTAdd scan history entries
- DELClear scan history
Auth
Scheduling
- GETGet employee schedule
- GETGet timesheets
- POSTApprove timesheet
- GETGet schedules
- GETList leave requests
- POSTApprove leave request
- POSTDecline leave request
- GETGet shifts
- POSTCreate shift
- PUTUpdate shift
- DELDelete shift
- GETGet timesheets
- POSTApprove timesheet
- GETGet leave requests
- POSTApprove leave request
- POSTDecline leave request
- GETGet pending approvals
- GETGet workforce insights
- GETGet employee schedule
Equipment
- GETList robots
- GETGet robot by ID
- PATCHUpdate robot
- GETList carts
- POSTAssign cart to order
- GETGet cart by ID
- PATCHUpdate cart
- GETList all totes
- GETGet tote by ID
- GETList all totes
- GETGet tote by ID
- GETList cold equipment
- GETList all carts
- POSTAssign cart to order
- GETGet cart by ID
- PATCHUpdate cart
- POSTScan tote to cart
- POSTRelease tote from cart
- GETList all robots
- GETGet robot by ID
- PATCHUpdate robot
- GETList all totes
- GETGet tote by ID
- GETList all bags
- GETGet bag by ID
- PATCHUpdate bag
- POSTAssign bag to slot
- POSTAssign bag to tote
- POSTRemove bag from tote
- POSTClear bag contents
- GETList all sensors
- GETList cold storage equipment
Scanner Actions
Partner Receiving
Restocking
API Reference
- GETGet v1scannerdispatch
- GETGet v1scannerdispatch:id
- POSTPost v1scannerdispatch:idstart
- POSTPost v1scannerdispatch:idassign bag to tote
- POSTPost v1scannerdispatch:idverify tote
- POSTPost v1scannerdispatch:idcomplete
- GETGet v1scannerreceipts
- POSTPost v1scannerreceipts
- POSTPost v1scannerreceipts stitch
- GETGet v1dispatch
- GETGet v1dispatch:id
- POSTPost v1dispatch:idstart
- POSTPost v1dispatch:idassign bag to tote
- POSTPost v1dispatch:idverify tote
- POSTPost v1dispatch:idcomplete
Email Templates
Admin Notifications
Orders
- GETList orders with filtering and pagination
- GETList active pickup portals
- GETList test orders
- POSTCreate test order
- GETGet order details
- POSTUpdate order
- POSTMark order as delivered
- POSTComplete order fulfillment
- POSTTransition order status
- POSTAllocate order items
- POSTRetry allocation for unallocated order items
- POSTForce complete an order item
- GETList orders with filtering and pagination
- GETList active pickup portals
- GETList test orders
- POSTCreate test order
- GETGet order details
- POSTUpdate order
- POSTMark order as delivered
- POSTComplete order fulfillment
- POSTTransition order status
- POSTAllocate order items
- POSTRetry allocation for unallocated order items
- POSTForce complete an order item
Notifications
- GETList notifications
- GETGet notification analytics
- GETGet notification by ID
- POSTSend notification
- POSTSend order confirmed notification
- POSTSend order ready notification
- POSTSend sweep assigned notification
- POSTSend pick list ready notification
- POSTSend operations alert
- POSTSend equipment alert
- POSTSend low inventory alert
- GETGet notification preferences
- PUTUpdate notification preferences
- GETGet notification tokens
- DELDeactivate notification token
- POSTMark notification as read
- POSTDismiss notification
- GETGet staff notification preferences
- PUTUpdate staff notification preferences
- POSTSend notification to staff
- DELDeactivate staff notification token
- GETList notifications
- GETGet notification analytics
- GETGet notification by ID
- POSTSend notification
- POSTSend order confirmed notification
- POSTSend order ready notification
- POSTSend sweep assigned notification
- POSTSend pick list ready notification
- POSTSend operations alert
- POSTSend equipment alert
- POSTSend low inventory alert
- GETGet notification preferences
- PUTUpdate notification preferences
- GETGet notification tokens
- DELDeactivate notification token
- POSTMark notification as read
- POSTDismiss notification
- GETGet staff notification preferences
- PUTUpdate staff notification preferences
- POSTSend notification to staff
- DELDeactivate staff notification token
Staff
Retailers
Deputy Sync
- POSTSync employees from Deputy
- GETList Deputy operational units
- POSTSync operational units from Deputy
- PUTUpdate staff operational units
- POSTPush all staff operational units to Deputy
- POSTGenerate PINs for staff without one
- POSTSync employees from Deputy
- GETList Deputy operational units
- POSTSync operational units from Deputy
- PUTUpdate staff operational units
- POSTPush all staff operational units to Deputy
- POSTGenerate PINs for staff without one
Nodes
Roles
Customers
- GETList customers with analytics
- GETGet customer by ID
- GETGet customer orders
- GETGet frequently purchased products
- GETGet category analytics
- GETGet retailer sourcing
- POSTRefresh customer analytics
- POSTBulk refresh analytics
- GETList customers with analytics
- GETGet customer by ID
- GETGet customer orders
- GETGet frequently purchased products
- GETGet category analytics
- GETGet retailer sourcing
- POSTRefresh customer analytics
- POSTBulk refresh analytics
Settings
Scrapers
- GETList all scrapers
- GETGet schedule presets
- GETGet recent runs across all scrapers
- GETList cookie records
- POSTUpload cookies for a retailer
- DELInvalidate cookies
- POSTExtract and upload cookies from HAR file
- PATCHBulk update scraper schedules
- PATCHBulk update scraper configuration
- POSTBulk enable scrapers
- POSTBulk disable scrapers
- GETGet scraper details
- GETGet scraper run history
- GETGet single run details
- GETGet run logs
- GETGet real-time scraper status
- POSTTrigger scraper run
- PATCHUpdate scraper configuration
- POSTCancel running scraper
- GETList all scrapers
- GETGet schedule presets
- GETGet recent runs across all scrapers
- GETList cookie records
- POSTUpload cookies for a retailer
- DELInvalidate cookies
- POSTExtract and upload cookies from HAR file
- PATCHBulk update scraper schedules
- PATCHBulk update scraper configuration
- POSTBulk enable scrapers
- POSTBulk disable scrapers
- GETGet scraper details
- GETGet scraper run history
- GETGet single run details
- GETGet run logs
- GETGet real-time scraper status
- POSTTrigger scraper run
- PATCHUpdate scraper configuration
- POSTCancel running scraper
Availability
- GETList products with availability
- GETGet product availability
- POSTRecalculate availability scores
- GETGet availability events
- GETGet per-location availability scores
- POSTBackfill aggregated scores
- POSTProcess availability score queue
- GETList products with availability
- GETGet product availability
- POSTRecalculate availability scores
- GETGet availability events
- GETGet per-location availability scores
- POSTBackfill aggregated scores
- POSTProcess availability score queue
API Keys
Admin - Partners
- GETList partner brands
- POSTCreate a partner brand
- GETGet partner statistics
- GETSearch brands for linking
- GETGet partner brand details
- GETGet partner brand detail with products and sales
- POSTApprove a partner brand
- POSTReject a partner brand
- POSTSuspend a partner brand
- POSTReactivate a suspended partner brand
- POSTCreate a product for partner brand
- POSTLink partner brand to existing brand
- POSTUnlink partner brand from brand
- GETGet all products for a linked brand
Admin - Partner Products
- GETList products pending approval
- GETList product requests (claims, edits, conversions)
- GETGet partner product detail
- PATCHUpdate a partner product
- POSTApprove a partner product
- POSTReject a partner product
- POSTApprove a product request
- POSTReject a product request
- POSTConvert a retailer-sourced product to a partner product
- POSTDeactivate a partner product
Admin - Reorder Requests
Admin - Partner Manifests
Admin - Partner Payouts
Products
- GETList products with filtering and pagination
- GETGet product count statistics
- GETGet product by barcode
- GETGet product details
- PATCHUpdate product details
- GETGet product demand data
- GETGet product order activity
- POSTCreate/publish a sellable product
- PATCHActivate a product
- POSTRelocate all inventory items for a product to a new slot
- POSTAdjust inventory quantity for a product at a specific slot
Scraped Products
- GETList scraped products
- GETGet scraped product statistics
- GETGet category hierarchy
- GETGet scraped product details
- PATCHUpdate scraped product
- POSTPublish scraped product
- POSTBulk publish scraped products
- POSTBulk publish by criteria
- POSTBulk deactivate sellable products
- POSTBulk activate sellable products
- POSTBulk activate scraped products
- POSTBulk deactivate scraped products
- POSTBulk unpublish
Sellable Products
Categories
Performance
Partner
Partner Products
- GETList partner products
- POSTSubmit a new product
- GETList products from linked brand
- GETList product requests
- GETGet product details
- PATCHUpdate product
- POSTGet signed URL for image upload
- POSTClaim an existing product
- POSTRequest an edit to a claimed product
- POSTRequest to supply a product directly
- POSTImport product data from Shopify URL
- GETGet Shopify sync configuration for a product
- POSTCreate Shopify sync configuration for a product
- DELDelete Shopify sync configuration
- PATCHUpdate Shopify sync preferences
- POSTManually trigger sync for a product
Partner Categories
Partner Manifests
Partner Reorder Requests
Partner Sales
{
"preferences": null
}Notifications
Update notification preferences
Updates notification preferences for a user.
PUT
/
v1
/
admin
/
notifications
/
preferences
/
{userId}
{
"preferences": null
}Documentation Index
Fetch the complete documentation index at: https://docs.switchyard.run/llms.txt
Use this file to discover all available pages before exploring further.
⌘I