Skip to main content

Overview

V1 API Overview

Sweeps

GET
List sweeps
POST
Create sweep
GET
Get sweep by ID
PATCH
Update sweep
POST
Optimize sweeps
POST
Perform sweep action
PATCH
Update sweep item
GET
Get sweep economics
GET
Get single sweep economics
GET
Get pending items for receiving
POST
Scan barcode for receiving
PATCH
Mark item as received
POST
Confirm cart moved to staging zone

Orders

GET
List orders with filtering and pagination
GET
Get order details
POST
Update order
POST
Mark order as delivered
POST
Complete order fulfillment
GET
List test orders
POST
Create test order
POST
Allocate order items

Products

GET
List products with filtering and pagination
POST
Create/publish a sellable product
GET
Get product count statistics
GET
Get product by barcode
GET
Get product details
PATCH
Update product details
GET
Get product demand data
GET
Get product order activity
PATCH
Activate a product

Staff

GET
List all staff
GET
Get staff by ID
PATCH
Update staff
PATCH
Update staff PIN

Inventory

GET
List inventory groups
GET
Get inventory group
GET
Lookup product by barcode
POST
Scan inventory
GET
Get available slots
POST
Convert multipack inventory

Retailers

GET
List retailers with locations
GET
Get all locations
POST
Create location
GET
Get retailer
GET
Get location detail
PATCH
Update location

Customers

GET
List customers with analytics
GET
Get customer by ID
GET
Get customer orders
GET
Get frequently purchased products
GET
Get category analytics
GET
Get retailer sourcing
POST
Refresh customer analytics
POST
Bulk refresh analytics

Search

GET
Search products
GET
Global search

Nodes

GET
List all nodes
GET
Get current node
GET
Get node by ID
PATCH
Update node
PATCH
Update operating hours
GET
Get formatted operating hours

Roles

GET
List all roles
GET
List all permissions
GET
Get role by ID
PATCH
Update role
PUT
Update role permissions

Scrapers

GET
List all scrapers
GET
Get schedule presets
GET
Get recent runs across all scrapers
GET
List cookie records
POST
Upload cookies for a retailer
DEL
Invalidate cookies
POST
Extract and upload cookies from HAR file
PATCH
Bulk update scraper schedules
PATCH
Bulk update scraper configuration
POST
Bulk enable scrapers
POST
Bulk disable scrapers
GET
Get scraper details
GET
Get scraper run history
GET
Get single run details
GET
Get run logs
GET
Get real-time scraper status
POST
Trigger scraper run
PATCH
Update scraper configuration
POST
Cancel running scraper

Scraped Products

GET
List scraped products
GET
Get scraped product statistics
GET
Get category hierarchy
GET
Get scraped product details
PATCH
Update scraped product
POST
Publish scraped product
POST
Bulk publish scraped products
POST
Bulk publish by criteria
POST
Bulk deactivate sellable products
POST
Bulk activate sellable products
POST
Bulk activate scraped products
POST
Bulk deactivate scraped products
POST
Bulk unpublish

Sellable Products

GET
Get sellable product statistics
GET
Get sellable product categories
POST
Bulk activate sellable products
POST
Bulk deactivate sellable products

Categories

GET
List all categories
POST
Create category
DEL
Delete category
PATCH
Update category
POST
Toggle category active status

Availability

GET
List products with availability
GET
Get product availability
POST
Recalculate availability scores
GET
Get availability events
GET
Get per-location availability scores
POST
Backfill aggregated scores
POST
Process availability score queue

Notifications

GET
List notifications
GET
Get notification by ID
POST
Send notification
POST
Send order confirmed notification
POST
Send order ready notification
POST
Send sweep assigned notification
POST
Send pick list ready notification
POST
Send operations alert
POST
Send equipment alert
POST
Send low inventory alert
GET
Get notification preferences
PUT
Update notification preferences
GET
Get notification tokens
DEL
Deactivate notification token
GET
Get notification analytics
POST
Mark notification as read
POST
Dismiss notification

Settings

GET
Get sweep economics settings
PATCH
Update sweep economics settings
GET
Get sweep economics defaults

RFC Picks

GET
List pick lists
POST
Create pick list
GET
Get pick list by ID
POST
Perform pick list action
PATCH
Update pick list item
POST
Scan barcode for item
POST
Assign cart to pick list
POST
Assign tote to active cart
POST
Mark tote as full
POST
Complete cart and route to destination

Scanner

GET
Get user tasks
GET
Get scan history
POST
Add scan history entries
DEL
Clear scan history

Scanner Actions

POST
Assign tote to cart
POST
Assign tote to robot
POST
Remove tote from cart
GET
Identify barcode

Partner Receiving

GET
List manifests available for receiving
GET
Lookup manifest by taxonomy ID
POST
Receive a manifest item

Reference

GET
Get all brands
GET
Get category tree

API Reference

GET
Get v1dispatch
GET
Get v1dispatch:id
POST
Post v1dispatch:idstart
POST
Post v1dispatch:idassign bag to tote
POST
Post v1dispatch:idverify tote
POST
Post v1dispatch:idcomplete

Performance

GET
Get performance metrics

Equipment

GET
List all carts
POST
Assign cart to order
GET
Get cart by ID
PATCH
Update cart
POST
Scan tote to cart
POST
Release tote from cart
GET
List all robots
GET
Get robot by ID
PATCH
Update robot
GET
List all totes
GET
Get tote by ID
GET
List all bags
GET
Get bag by ID
PATCH
Update bag
POST
Assign bag to slot
POST
Assign bag to tote
POST
Remove bag from tote
POST
Clear bag contents
GET
List all sensors
GET
List cold storage equipment

Scheduling

GET
Get shifts
GET
Get timesheets
POST
Approve timesheet
GET
Get leave requests
POST
Approve leave request
POST
Decline leave request
GET
Get pending approvals
GET
Get workforce insights
GET
Get employee schedule

Deputy Sync

POST
Sync employees from Deputy
GET
List Deputy operational units
POST
Sync operational units from Deputy
PUT
Update staff operational units
POST
Push all staff operational units to Deputy
POST
Generate PINs for staff without one

Auth

GET
Get clock status
POST
Clock in or out
POST
Verify staff PIN
GET
List staff for PIN selection
PATCH
Update staff PIN

Partner

GET
Get partner profile
PATCH
Update partner profile
POST
Register as a partner brand
GET
Get dashboard statistics

Partner Products

GET
List partner products
POST
Submit a new product
GET
Get product details
PATCH
Update product
POST
Get signed URL for image upload
POST
Import product data from Shopify URL
GET
Get Shopify sync configuration for a product
POST
Create Shopify sync configuration for a product
DEL
Delete Shopify sync configuration
PATCH
Update Shopify sync preferences
POST
Manually trigger sync for a product

Partner Categories

GET
List categories
GET
List subcategories

Partner Manifests

GET
List manifests
GET
Get manifest details
PATCH
Update shipping info
POST
Mark manifest as shipped
GET
Get manifest data for printing

Partner Reorder Requests

GET
List reorder requests
GET
Get reorder request details
POST
Accept reorder request
POST
Reject reorder request

Partner Sales

GET
List sales
GET
Get sales summary
GET
List inventory

Switchyard Documentation home page

404

Page Not Found

We couldn't find the page. Maybe you were looking for one of these pages below?

V1 API Overview Scanner API MCP Server Installation

⌘I