> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer-dev.shipbob.dev/2026-01/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer-dev.shipbob.dev/_mcp/server. # 2026-01 ## Docs - [Introduction](https://developer-dev.shipbob.dev/2026-01/introduction.md) - [Quickstart](https://developer-dev.shipbob.dev/2026-01/quickstart.md) - [Authentication](https://developer-dev.shipbob.dev/2026-01/auth.md): Learn how to authenticate with ShipBob's API using Personal Access Tokens or OAuth 2.0 - [Rate limit](https://developer-dev.shipbob.dev/2026-01/rate-limit.md) - [Setup Sandbox Account](https://developer-dev.shipbob.dev/2026-01/sandbox/setup.md): Learn how to setup a sandbox account on ShipBob - [Sandbox Simulations](https://developer-dev.shipbob.dev/2026-01/sandbox/simulations.md) - [Checklist](https://developer-dev.shipbob.dev/2026-01/sandbox/checklist.md): Use this checklist as you build your integration - [Demo Engine](https://developer-dev.shipbob.dev/2026-01/sandbox/demo.md) - [Webhooks](https://developer-dev.shipbob.dev/2026-01/webhooks.md) - [Overview](https://developer-dev.shipbob.dev/2026-01/guides/overview.md): Use cases for how to build with the ShipBob API - [Orders](https://developer-dev.shipbob.dev/2026-01/guides/orders.md) - [Build an Orders Integration](https://developer-dev.shipbob.dev/2026-01/guides/build-orders-integration.md): A complete guide to creating and managing orders using the ShipBob API - [Products](https://developer-dev.shipbob.dev/2026-01/guides/products.md): How to create and manage products with the ShipBob API - [Product Catalog](https://developer-dev.shipbob.dev/2026-01/guides/product-catalog.md): API documentation for managing products through the ShipBob product catalog. - [Inventory](https://developer-dev.shipbob.dev/2026-01/guides/inventory.md) - [Inventory History](https://developer-dev.shipbob.dev/2026-01/guides/inventory-history.md): - [Tracking](https://developer-dev.shipbob.dev/2026-01/guides/tracking.md) - [Receiving](https://developer-dev.shipbob.dev/2026-01/guides/receiving.md): How to create and manage warehouse receiving orders using the ShipBob API - [Returns](https://developer-dev.shipbob.dev/2026-01/guides/returns.md): How to create and manage returns using the ShipBob API - [Billing](https://developer-dev.shipbob.dev/2026-01/guides/billing.md): Manage and retrieve billing-related data including invoices, transactions, and transaction fees - [Concepts](https://developer-dev.shipbob.dev/2026-01/concepts.md) - [Status Reference](https://developer-dev.shipbob.dev/2026-01/status-reference.md) - [MCP Server Overview](https://developer-dev.shipbob.dev/2026-01/mcp-server/overview.md): Connect AI assistants like Claude Desktop and VS Code with GitHub Copilot to ShipBob using the Model Context Protocol (MCP). The ShipBob MCP Server is a hosted remote server with built-in OAuth. - [Setup](https://developer-dev.shipbob.dev/2026-01/mcp-server/setup.md): Add the ShipBob MCP Server to your AI assistant. The flow is the same for every client: paste a URL, sign in to ShipBob, grant access. - [Tools & Examples](https://developer-dev.shipbob.dev/2026-01/mcp-server/tools.md): All 89 tools exposed by the ShipBob MCP Server, organized by domain, plus example prompts you can use right away. - [Troubleshooting & FAQ](https://developer-dev.shipbob.dev/2026-01/mcp-server/troubleshooting.md): Security best practices, common issues, frequently asked questions, and support contacts for the ShipBob MCP Server. - [Setup with API Token](https://developer-dev.shipbob.dev/2026-01/mcp-server/setup-with-token.md): Connect to the ShipBob MCP Server by generating an API token from your ShipBob dashboard and pasting it into your AI assistant's configuration. - [Versioning Policy](https://developer-dev.shipbob.dev/2026-01/versioning.md) - [Upgrade to 2025-07](https://developer-dev.shipbob.dev/2026-01/versioning/2025-07.md): Migration Guide for Upgrading from version 2.0 to 2025-07 - [Upgrade to 2026-01](https://developer-dev.shipbob.dev/2026-01/versioning/2026-01.md): Migration guide for upgrading from version 2025-07 to 2026-01 - [Migrate to PKCE](https://developer-dev.shipbob.dev/2026-01/migration/pkce.md): Add PKCE (Proof Key for Code Exchange) to an existing OAuth app's authorization flow. - [Errors](https://developer-dev.shipbob.dev/2026-01/errors.md): - [FAQ](https://developer-dev.shipbob.dev/2026-01/faq.md): Common questions - [Release Notes](https://developer-dev.shipbob.dev/2026-01/release-notes.md): Stay updated with the latest improvements, bug fixes, and new features. ## API Docs - API Reference > Inventory [Get All Inventory Levels](https://developer-dev.shipbob.dev/2026-01/api/inventory/get-all-inventory-levels.md) - API Reference > Inventory [Get Inventory](https://developer-dev.shipbob.dev/2026-01/api/inventory/get-inventory.md) - API Reference > Inventory [Get Inventory Levels Grouped By Fulfillment Center](https://developer-dev.shipbob.dev/2026-01/api/inventory/get-inventory-levels-grouped-by-fulfillment-center.md) - API Reference > Inventory [Get Inventory Levels](https://developer-dev.shipbob.dev/2026-01/api/inventory/get-inventory-levels.md) - API Reference > Inventory [Get Inventory Levels Grouped By Lot](https://developer-dev.shipbob.dev/2026-01/api/inventory/get-inventory-levels-grouped-by-lot.md) - API Reference > Inventory [Get All Inventories](https://developer-dev.shipbob.dev/2026-01/api/inventory/get-all-inventories.md) - API Reference > Inventory [Get All Inventory Levels Grouped By Lot](https://developer-dev.shipbob.dev/2026-01/api/inventory/get-all-inventory-levels-grouped-by-lot.md) - API Reference > Inventory [Get All Inventory Levels Grouped By Fulfillment Center](https://developer-dev.shipbob.dev/2026-01/api/inventory/get-all-inventory-levels-grouped-by-fulfillment-center.md) - API Reference > Returns [Get Return Order ](https://developer-dev.shipbob.dev/2026-01/api/returns/get-return-order.md) - API Reference > Returns [Edit Return Order ](https://developer-dev.shipbob.dev/2026-01/api/returns/edit-return-order.md) - API Reference > Returns [Get Return Orders ](https://developer-dev.shipbob.dev/2026-01/api/returns/get-return-orders.md) - API Reference > Returns [Create Return Order ](https://developer-dev.shipbob.dev/2026-01/api/returns/create-return-order.md) - API Reference > Returns [Cancel Return order ](https://developer-dev.shipbob.dev/2026-01/api/returns/cancel-return-order.md) - API Reference > Channels [Get Channels](https://developer-dev.shipbob.dev/2026-01/api/channels/get-channels.md) - API Reference > Webhooks [Delete Subscription ](https://developer-dev.shipbob.dev/2026-01/api/webhooks/delete-subscription.md) - API Reference > Webhooks [Get Subscriptions ](https://developer-dev.shipbob.dev/2026-01/api/webhooks/get-subscriptions.md) - API Reference > Webhooks [Create Subscription ](https://developer-dev.shipbob.dev/2026-01/api/webhooks/create-subscription.md) - API Reference > Simulations [Simulates Shipment ](https://developer-dev.shipbob.dev/2026-01/api/simulations/simulates-shipment.md) - API Reference > Simulations [Get Simulation Status ](https://developer-dev.shipbob.dev/2026-01/api/simulations/get-simulation-status.md) - API Reference > Products [Move Variants to New Product](https://developer-dev.shipbob.dev/2026-01/api/products/move-variants-to-new-product.md) - API Reference > Products [Merge Variants](https://developer-dev.shipbob.dev/2026-01/api/products/merge-variants.md) - API Reference > Products [Get Packaging Requirement](https://developer-dev.shipbob.dev/2026-01/api/products/get-packaging-requirement.md) - API Reference > Products [Get Product Variants](https://developer-dev.shipbob.dev/2026-01/api/products/get-product-variants.md) - API Reference > Products [Add Product Variants](https://developer-dev.shipbob.dev/2026-01/api/products/add-product-variants.md) - API Reference > Products [Update Product Variants](https://developer-dev.shipbob.dev/2026-01/api/products/update-product-variants.md) - API Reference > Products [Get Taxonomies](https://developer-dev.shipbob.dev/2026-01/api/products/get-taxonomies.md) - API Reference > Products [Get Product](https://developer-dev.shipbob.dev/2026-01/api/products/get-product.md) - API Reference > Products [Delete Product Bundle](https://developer-dev.shipbob.dev/2026-01/api/products/delete-product-bundle.md) - API Reference > Products [Update Product](https://developer-dev.shipbob.dev/2026-01/api/products/update-product.md) - API Reference > Products [Get Taxonomy by ID](https://developer-dev.shipbob.dev/2026-01/api/products/get-taxonomy-by-id.md) - API Reference > Products [Get Products](https://developer-dev.shipbob.dev/2026-01/api/products/get-products.md) - API Reference > Products [Create Product](https://developer-dev.shipbob.dev/2026-01/api/products/create-product.md) - API Reference > Products [Get Taxonomy Parent](https://developer-dev.shipbob.dev/2026-01/api/products/get-taxonomy-parent.md) - API Reference > Products [Convert Variant to Bundle](https://developer-dev.shipbob.dev/2026-01/api/products/convert-variant-to-bundle.md) - API Reference > Products [Move Variants Between Products](https://developer-dev.shipbob.dev/2026-01/api/products/move-variants-between-products.md) - API Reference > Billing [Search Transactions](https://developer-dev.shipbob.dev/2026-01/api/billing/search-transactions.md) - API Reference > Billing [Get Invoices](https://developer-dev.shipbob.dev/2026-01/api/billing/get-invoices.md) - API Reference > Billing [Get Transactions by Invoice ID ](https://developer-dev.shipbob.dev/2026-01/api/billing/get-transactions-by-invoice-id.md) - API Reference > Billing [Get Transaction Fees ](https://developer-dev.shipbob.dev/2026-01/api/billing/get-transaction-fees.md) - API Reference > Orders [Get All Shipments for Order](https://developer-dev.shipbob.dev/2026-01/api/orders/get-all-shipments-for-order.md) - API Reference > Orders [Get Order](https://developer-dev.shipbob.dev/2026-01/api/orders/get-order.md) - API Reference > Orders [Get Shipment Logs by Order ID and Shipment ID](https://developer-dev.shipbob.dev/2026-01/api/orders/get-shipment-logs-by-order-id-and-shipment-id.md) - API Reference > Orders [Get Shipping Methods](https://developer-dev.shipbob.dev/2026-01/api/orders/get-shipping-methods.md) - API Reference > Orders [Get Shipment](https://developer-dev.shipbob.dev/2026-01/api/orders/get-shipment.md) - API Reference > Orders [Cancel Shipment](https://developer-dev.shipbob.dev/2026-01/api/orders/cancel-shipment.md) - API Reference > Orders [Estimate Fulfillment Cost For Order](https://developer-dev.shipbob.dev/2026-01/api/orders/estimate-fulfillment-cost-for-order.md) - API Reference > Orders [Get Order Store Data](https://developer-dev.shipbob.dev/2026-01/api/orders/get-order-store-data.md) - API Reference > Orders [Get Shipment by Order ID and Shipment ID](https://developer-dev.shipbob.dev/2026-01/api/orders/get-shipment-by-order-id-and-shipment-id.md) - API Reference > Orders [Get Orders](https://developer-dev.shipbob.dev/2026-01/api/orders/get-orders.md) - API Reference > Orders [Create Order](https://developer-dev.shipbob.dev/2026-01/api/orders/create-order.md) - API Reference > Orders [Cancel Order](https://developer-dev.shipbob.dev/2026-01/api/orders/cancel-order.md) - API Reference > Orders [Mark Tracking Uploaded](https://developer-dev.shipbob.dev/2026-01/api/orders/mark-tracking-uploaded.md) - API Reference > Orders [Get Shipment Logs](https://developer-dev.shipbob.dev/2026-01/api/orders/get-shipment-logs.md) - API Reference > Orders [Get Shipment Status Timeline by Order ID and Shipment ID](https://developer-dev.shipbob.dev/2026-01/api/orders/get-shipment-status-timeline-by-order-id-and-shipment-id.md) - API Reference > Orders [Batch Cancel Shipments](https://developer-dev.shipbob.dev/2026-01/api/orders/batch-cancel-shipments.md) - API Reference > Orders [Cancel Shipment by Order ID and Shipment ID](https://developer-dev.shipbob.dev/2026-01/api/orders/cancel-shipment-by-order-id-and-shipment-id.md) - API Reference > Orders [Get Shipment Timeline](https://developer-dev.shipbob.dev/2026-01/api/orders/get-shipment-timeline.md) - API Reference > Orders [Get Shipment Line Items ](https://developer-dev.shipbob.dev/2026-01/api/orders/get-shipment-line-items.md) - API Reference > Orders [Bulk Update Shipping Service ](https://developer-dev.shipbob.dev/2026-01/api/orders/bulk-update-shipping-service.md) - API Reference > Orders [Update Shipment Line Items ](https://developer-dev.shipbob.dev/2026-01/api/orders/update-shipment-line-items.md) - API Reference > Orders [Update Shipment Address ](https://developer-dev.shipbob.dev/2026-01/api/orders/update-shipment-address.md) - API Reference > Orders [Get Completely Cancelled Orders](https://developer-dev.shipbob.dev/2026-01/api/orders/get-completely-cancelled-orders.md) - API Reference > Orders [Estimate Delivery Date ](https://developer-dev.shipbob.dev/2026-01/api/orders/estimate-delivery-date.md) - API Reference > Orders [Update Shipment Line Items by SKU ](https://developer-dev.shipbob.dev/2026-01/api/orders/update-shipment-line-items-by-sku.md) - API Reference > Orders [Assign Fulfillment Center ](https://developer-dev.shipbob.dev/2026-01/api/orders/assign-fulfillment-center.md) - API Reference > Orders [Bulk Release Shipments From Hold ](https://developer-dev.shipbob.dev/2026-01/api/orders/bulk-release-shipments-from-hold.md) - API Reference > Orders [Bulk Place Shipments On Hold ](https://developer-dev.shipbob.dev/2026-01/api/orders/bulk-place-shipments-on-hold.md) - API Reference > Orders [Bulk Update Instructions ](https://developer-dev.shipbob.dev/2026-01/api/orders/bulk-update-instructions.md) - API Reference > Locations [Get Locations](https://developer-dev.shipbob.dev/2026-01/api/locations/get-locations.md) - API Reference > Receiving [Get Inventory Distributions by WRO ID](https://developer-dev.shipbob.dev/2026-01/api/receiving/get-inventory-distributions-by-wro-id.md) - API Reference > Receiving [Get Warehouse Receiving Order Boxes ](https://developer-dev.shipbob.dev/2026-01/api/receiving/get-warehouse-receiving-order-boxes.md) - API Reference > Receiving [Set ExternalSync flag for Wros ](https://developer-dev.shipbob.dev/2026-01/api/receiving/set-external-sync-flag-for-wros.md) - API Reference > Receiving [Get Warehouse Receiving Order Box Labels ](https://developer-dev.shipbob.dev/2026-01/api/receiving/get-warehouse-receiving-order-box-labels.md) - API Reference > Receiving [Get Multiple Warehouse Receiving Orders ](https://developer-dev.shipbob.dev/2026-01/api/receiving/get-multiple-warehouse-receiving-orders.md) - API Reference > Receiving [Create Warehouse Receiving Order ](https://developer-dev.shipbob.dev/2026-01/api/receiving/create-warehouse-receiving-order.md) - API Reference > Receiving [Cancel Warehouse Receiving Order ](https://developer-dev.shipbob.dev/2026-01/api/receiving/cancel-warehouse-receiving-order.md) - API Reference > Receiving [Get Fulfillment Centers ](https://developer-dev.shipbob.dev/2026-01/api/receiving/get-fulfillment-centers.md) - API Reference > Receiving [Get Warehouse Receiving Order ](https://developer-dev.shipbob.dev/2026-01/api/receiving/get-warehouse-receiving-order.md) - API Reference > Inventory History [Query Inventory History Events](https://developer-dev.shipbob.dev/2026-01/api/inventory-history/query-inventory-history-events.md) - API Reference > Tracking [Get Tracking by Tracking Ids ](https://developer-dev.shipbob.dev/2026-01/api/tracking/get-tracking-by-tracking-ids.md) - API Reference > Tracking [Get Tracking by Shipment Ids ](https://developer-dev.shipbob.dev/2026-01/api/tracking/get-tracking-by-shipment-ids.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developer-dev.shipbob.dev/openapi.json) - [OpenAPI YAML](https://developer-dev.shipbob.dev/openapi.yaml)