# Wally And Cody

> Index of the Wally And Cody documentation.

## For Sellers

- [Features](https://docs.wallyandcody.com/features.md): Everything the platform helps sellers do — from syncing products to boosting visibility on Shopee.
- [Seller & Shop Management](https://docs.wallyandcody.com/seller-shop-management.md): Set up your seller account, link your Shopee shop, and authorize access — all from the dashboard.
- [Redemption URLs](https://docs.wallyandcody.com/redemption-urls.md): Configure where buyers go after purchase to receive their product links.
- [Buyer Redemption](https://docs.wallyandcody.com/buyer-redemption.md): What your buyers see when they redeem their purchase — and how to make sure they get their links.
- [Product Boosting](https://docs.wallyandcody.com/product-boosting.md): Boost your product visibility on Shopee directly from the dashboard.

## For Developers

- [Introduction](https://docs.wallyandcody.com/introduction.md): Discover how Wally And Cody automates Shopee product redemption — from order ID to instant delivery with a full-stack platform for sellers and buyers.
- [Quick Start](https://docs.wallyandcody.com/quickstart.md): Deploy the platform with Docker Compose, connect your first Shopee shop, sync products, and test a buyer redemption in under 30 minutes.
- [Architecture](https://docs.wallyandcody.com/architecture.md): Understand the system design of the Shopee Auto Redeemer platform: backend, dashboards, portals, workers, inventory automation, and MCP services.
- [Authentication](https://docs.wallyandcody.com/authentication.md): Authenticate API requests with JWT access and refresh tokens, understand ADMIN and SELLER roles, and configure token lifetimes.
- [Configuration](https://docs.wallyandcody.com/configuration.md): Complete environment variable reference for the backend, admin dashboard, public portal, inventory agent, and MCP server.
- [Deployment](https://docs.wallyandcody.com/deployment.md): Deploy the full platform with Docker Compose — services, ports, volumes, profiles, and production considerations.
- [Product Synchronization](https://docs.wallyandcody.com/product-sync.md): Run incremental and full product syncs from Shopee, poll job status, and understand what data gets imported into PostgreSQL.
- [Inventory Agent](https://docs.wallyandcody.com/inventory-agent.md): Set up the Inventory Agent to automatically match Google Drive files with products lacking redemption URLs using SKU, name, and optional semantic matching.
- [MCP Server](https://docs.wallyandcody.com/mcp-server.md): Set up the Model Context Protocol server for programmatic access to products, redemption URLs, sync, and token health via stdio or HTTP transport.
- [Troubleshooting](https://docs.wallyandcody.com/troubleshooting.md): Resolve common platform issues — Shopee token expiry, product sync failures, redemption errors, rate limiting, CORS, and database connectivity.

## API Reference

- [Authenticate a user](https://docs.wallyandcody.com/api-reference/post-api-login.md): Authenticates a user and returns access and refresh JWT tokens.
- [Refresh an access token](https://docs.wallyandcody.com/api-reference/post-api-refresh.md): Exchanges a valid refresh bearer token for a new access token.
- [Look up an order for redemption](https://docs.wallyandcody.com/api-reference/post-api-redemption.md): Looks up an order and returns the redemption URLs associated with its items and models. This public endpoint is rate limited to 20 requests per minute per IP address.
- [Resolve a model directory](https://docs.wallyandcody.com/api-reference/get-api-redemption-directories-directory_key.md): Resolves a multi-link model directory into an ordered list of redemption URLs.
- [List sellers](https://docs.wallyandcody.com/api-reference/get-api-sellers.md): Returns all sellers. Requires an administrator JWT.
- [Create a seller](https://docs.wallyandcody.com/api-reference/post-api-sellers.md): Creates a seller account. Requires an administrator JWT.
- [Update a seller](https://docs.wallyandcody.com/api-reference/put-api-sellers-id.md): Updates a seller account. Requires an administrator JWT.
- [Delete a seller](https://docs.wallyandcody.com/api-reference/delete-api-sellers-id.md): Deletes a seller account. Requires an administrator JWT.
- [List shops](https://docs.wallyandcody.com/api-reference/get-api-shops.md): Returns all configured Shopee shops. Requires an administrator JWT.
- [Create a shop](https://docs.wallyandcody.com/api-reference/post-api-shops.md): Creates a Shopee shop configuration. Requires an administrator JWT.
- [Get a shop](https://docs.wallyandcody.com/api-reference/get-api-shops-id.md): Returns one Shopee shop. Requires an administrator JWT.
- [Update a shop](https://docs.wallyandcody.com/api-reference/put-api-shops-id.md): Updates a Shopee shop configuration. Requires an administrator JWT.
- [Delete a shop](https://docs.wallyandcody.com/api-reference/delete-api-shops-id.md): Deletes a Shopee shop configuration. Requires an administrator JWT.
- [Create Shopee authorization](https://docs.wallyandcody.com/api-reference/post-api-shops-id-token-create.md): Starts Shopee authorization for a shop and returns its OAuth authorization URL.
- [Refresh a Shopee token](https://docs.wallyandcody.com/api-reference/get-api-shops-id-token-refresh.md): Refreshes the Shopee token associated with a shop.
- [Check token health](https://docs.wallyandcody.com/api-reference/get-api-token-health.md): Returns the token health for a shop accessible to the authenticated user.
- [Get a Shopee authorization URL](https://docs.wallyandcody.com/api-reference/get-api-token-auth-url.md): Returns the Shopee OAuth authorization URL for a shop accessible to the authenticated user.
- [Handle Shopee OAuth callback](https://docs.wallyandcody.com/api-reference/get-api-shopee-token-callback.md): Processes the Shopee OAuth callback and redirects the user after token authorization.
- [Trigger product synchronization](https://docs.wallyandcody.com/api-reference/get-api-sync-products.md): Starts a full or incremental product synchronization for a shop.
- [Get product synchronization status](https://docs.wallyandcody.com/api-reference/get-api-sync-products-status.md): Returns the current product synchronization status for a shop.
- [List products](https://docs.wallyandcody.com/api-reference/get-api-products.md): Returns products for a shop accessible to the authenticated user.
- [Create a product](https://docs.wallyandcody.com/api-reference/post-api-products.md): Creates a product for a shop.
- [Get a product](https://docs.wallyandcody.com/api-reference/get-api-products-product_id.md): Returns one product by its identifier.
- [Set a product redemption URL](https://docs.wallyandcody.com/api-reference/post-api-products-product_id-redeem_url.md): Sets the product-level redemption URL.
- [Set a model redemption URL](https://docs.wallyandcody.com/api-reference/post-api-products-product_id-models-model_id-redeem_url.md): Sets the redemption URL for a specific product model.
- [Replace model redemption URLs](https://docs.wallyandcody.com/api-reference/put-api-products-product_id-models-model_id-redemption_urls.md): Replaces the complete ordered URL list for a product model.
- [List missing redemption targets](https://docs.wallyandcody.com/api-reference/get-api-products-redemption-targets.md): Returns products and models that do not have redemption URLs.
- [Apply batch redemption assignments](https://docs.wallyandcody.com/api-reference/post-api-products-redemption-targets-batch.md): Applies safe batch assignments and reports assignments that were skipped.
- [Update product boost selection](https://docs.wallyandcody.com/api-reference/put-api-products-boost-selection.md): Enables or disables boosting for a set of products.
- [Run product boosting](https://docs.wallyandcody.com/api-reference/post-api-products-boost-run.md): Runs round-robin boosting for the selected products.

## Help Center

- [Help Center](https://docs.wallyandcody.com/help-center.md): Find answers to common questions, troubleshooting guides, and step-by-step tutorials for the Shopee Auto Redeemer platform.
- [How do I get my redeem link?](https://docs.wallyandcody.com/help-center/faq/get-redeem-link.md): Enter your Shopee order ID on the public redemption portal to instantly receive your redemption links — no account required.
- [Redeem Link Not Working](https://docs.wallyandcody.com/help-center/troubleshooting/redeem-link-not-working.md): Troubleshoot common issues when your Shopee order redemption link doesn't appear, is invalid, or shows a CONTACT_SELLER_REQUIRED warning.
- [Link Your Shopee Account](https://docs.wallyandcody.com/help-center/guides/link-shopee-account.md): Connect your Shopee shop to the platform by creating a shop with partner credentials and completing the OAuth authorization flow.

## Changelog

- [Changelog](https://docs.wallyandcody.com/changelog.md): Track platform evolution — from core auto-redeem system through product model support, multi-URL redemption, boosting, inventory agent, and MCP server.