integrating-with-wms

by @rapyuta-robotics in AI & LLM

# Install this skill:

npx skills add rapyuta-robotics/agent-ai --skill "integrating-with-wms"

Install specific skill from multi-skill repository

# Description

Use when integrating with WMS (Warehouse Management System) APIs for containers, orders, inventory, items, audits, ASNs. Dynamically fetches current API structure from source code.

# SKILL.md

name: integrating-with-wms
description: Use when integrating with WMS (Warehouse Management System) APIs for containers, orders, inventory, items, audits, ASNs. Dynamically fetches current API structure from source code.

Integrating with WMS

WMS (Warehouse Management System) handles orders, inventory, containers, items, and shipments - the business logic layer for warehouse operations.

Quick Reference

Entity	Purpose	Key Operations
Containers	Physical storage units	create, mark full, query inventory
Orders	Customer orders	query, cancel, short
OrderLines	Line items in orders	query, allocate
Items	SKU/product master	CRUD operations
Inventories	Inventory by container	query, assign
Audits	Cycle count tasks	create, finalize lines
ASNs	Receiving notices	create, close
MHEs	Material handling equipment	query, inventories

API Base: /api/v1 (mounted at /wms-server/api/v1 in production)
JSON Casing: camelCase

Before Implementing

Always fetch current API structure from source. The API evolves - don't rely on cached knowledge.

Option 1: GitHub MCP Tools (Preferred)

Use GitHub MCP tools to fetch routing and schema files:

Repository: rapyuta-robotics/rapyuta-wms
API Location: rapyuta_wms/api/api_v1/endpoints/

Key files per endpoint:
- {endpoint}/routing.py  → FastAPI routes, HTTP methods, query params
- {endpoint}/schemas.py  → Pydantic request/response models

Example - fetch containers endpoint:

mcp__github__get_file_contents:
  owner: rapyuta-robotics
  repo: rapyuta-wms
  path: rapyuta_wms/api/api_v1/endpoints/containers/routing.py

mcp__github__get_file_contents:
  owner: rapyuta-robotics
  repo: rapyuta-wms
  path: rapyuta_wms/api/api_v1/endpoints/containers/schemas.py

Option 2: Local Files

If you have local access to the repository:

# List all API endpoints
ls rapyuta-wms/rapyuta_wms/api/api_v1/endpoints/

# Read specific endpoint routing
cat rapyuta-wms/rapyuta_wms/api/api_v1/endpoints/containers/routing.py
cat rapyuta-wms/rapyuta_wms/api/api_v1/endpoints/orders/routing.py

Option 3: OpenAPI Spec

If the service is running, fetch the OpenAPI spec:

curl http://localhost:8000/openapi.json

Endpoint Directory

Prefix	Directory	Purpose
`/containers`	`containers/`	Container management
`/containerDescriptors`	`container_descriptors/`	Container type definitions
`/orders`	`orders/`	Order management
`/orderLines`	`order_lines/`	Order line items
`/orderBatches`	`order_batches/`	Order batching
`/items`	`items/`	Item/SKU master
`/inventories/byContainers`	`container_inventories/`	Container inventory
`/inventories/byItemAggregate`	`item_inventories/`	Item-aggregated inventory
`/audits`	`audits/`	Audit tasks
`/auditLines`	`audit_lines/`	Audit line items
`/advancedShippingNotices`	`advanced_shipping_notices/`	ASN receiving
`/materialHandlingEquipments`	`material_handling_equipments/`	MHE/robots
`/owners`	`owners/`	Inventory owners
`/priorities`	`priorities/`	Priority definitions
`/shippers`	`shippers/`	Shipper definitions

Common Patterns

Pagination: All list endpoints return Page[Model] with items, total, page, size

Query Filters:

# Multi-value
?id=uuid1&id=uuid2
?status=NEW&status=PICKING

# Range filters
?partitionFillRate[gt]=0.3&partitionFillRate[lt]=0.9
?item.expirationDate[gt]=2024-01-01

# Sorting
?orderBy=name      # Ascending
?orderBy=-name     # Descending

Async Operations: Long-running operations return 202 with operation ID for polling

Base Schemas: See rapyuta_wms/schemas/base.py for common patterns:
- BaseSchema - camelCase aliasing
- UUIDAuditBaseSchema - id, insertTime, updateTime

Cross-References

@integrating-with-owm - OWM bin/operation/flow APIs
@integrating-backend-services - RTK Query patterns for frontend

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

⚡ Amp 🚀 Antigravity 🤖 Claude Code 🦀 Clawdbot 📝 Codex ▶️ Cursor 🤖 Droid 💎 Gemini CLI 🐙 GitHub Copilot 🪿 Goose 📊 Kilo Code 🔧 Kiro CLI 💻 OpenCode 🦘 Roo Code 🌲 Trae 🏄 Windsurf

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.