> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.shipbob.com/2025-07/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.shipbob.com/_mcp/server. # 2025-07 ## Docs - [Introduction](https://developer.shipbob.com/2025-07/introduction.md) - [Quickstart](https://developer.shipbob.com/2025-07/quickstart.md) - [Authentication](https://developer.shipbob.com/2025-07/auth.md): Learn how to authenticate with ShipBob's API using Personal Access Tokens or OAuth 2.0 - [Rate limit](https://developer.shipbob.com/2025-07/rate-limit.md) - [Setup Sandbox Account](https://developer.shipbob.com/2025-07/sandbox/setup.md): Learn how to setup a sandbox account on ShipBob - [Sandbox Simulations](https://developer.shipbob.com/2025-07/sandbox/simulations.md) - [Checklist](https://developer.shipbob.com/2025-07/sandbox/checklist.md): Use this checklist as you build your integration - [Webhooks](https://developer.shipbob.com/2025-07/webhooks.md) - [Overview](https://developer.shipbob.com/2025-07/guides/overview.md): Use cases for how to build with the ShipBob API - [Orders](https://developer.shipbob.com/2025-07/guides/orders.md) - [Build an Orders Integration](https://developer.shipbob.com/2025-07/guides/build-orders-integration.md): A complete guide to creating and managing orders using the ShipBob API - [Products](https://developer.shipbob.com/2025-07/guides/products.md): How to create and manage products with the ShipBob API - [Product Catalog](https://developer.shipbob.com/2025-07/guides/product-catalog.md): API documentation for managing products through the ShipBob product catalog. - [Inventory](https://developer.shipbob.com/2025-07/guides/inventory.md) - [Inventory History](https://developer.shipbob.com/2025-07/guides/inventory-history.md): - [Tracking](https://developer.shipbob.com/2025-07/guides/tracking.md) - [Receiving](https://developer.shipbob.com/2025-07/guides/receiving.md): How to create and manage warehouse receiving orders using the ShipBob API - [Returns](https://developer.shipbob.com/2025-07/guides/returns.md): How to create and manage returns using the ShipBob API - [Billing](https://developer.shipbob.com/2025-07/guides/billing.md): Manage and retrieve billing-related data including invoices, transactions, and transaction fees - [Concepts](https://developer.shipbob.com/2025-07/concepts.md) - [Status Reference](https://developer.shipbob.com/2025-07/status-reference.md) - [MCP Server Overview](https://developer.shipbob.com/2025-07/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.shipbob.com/2025-07/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.shipbob.com/2025-07/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.shipbob.com/2025-07/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.shipbob.com/2025-07/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.shipbob.com/2025-07/versioning.md) - [Upgrade to 2025-07](https://developer.shipbob.com/2025-07/versioning/2025-07.md): Migration guide for upgrading from version 2.0 to 2025-07 - [Upgrade to 2026-01](https://developer.shipbob.com/2025-07/versioning/2026-01.md): Migration guide for upgrading from version 2025-07 to 2026-01 - [Upgrade to 2026-07](https://developer.shipbob.com/2025-07/versioning/2026-07.md): Migration guide for upgrading from version 2026-01 to 2026-07 - [Migrate to PKCE](https://developer.shipbob.com/2025-07/migration/pkce.md): Add PKCE (Proof Key for Code Exchange) to an existing OAuth app's authorization flow. - [Errors](https://developer.shipbob.com/2025-07/errors.md): - [FAQ](https://developer.shipbob.com/2025-07/faq.md): Common questions - [Release Notes](https://developer.shipbob.com/2025-07/release-notes.md): Stay updated with the latest improvements, bug fixes, and new features. ## API Docs - API Reference > Channels [Get channels](https://developer.shipbob.com/2025-07/api/channels/get-channels.md) - API Reference > Orders [Create Order](https://developer.shipbob.com/2025-07/api/orders/create-order.md) - API Reference > Orders [Get Orders](https://developer.shipbob.com/2025-07/api/orders/get-orders.md) - API Reference > Orders [Get Order](https://developer.shipbob.com/2025-07/api/orders/get-order.md) - API Reference > Orders [Get one Shipment by Shipment Id](https://developer.shipbob.com/2025-07/api/orders/get-one-shipment-by-shipment-id.md) - API Reference > Orders [Cancel multiple Shipments by Shipment Id](https://developer.shipbob.com/2025-07/api/orders/cancel-multiple-shipments-by-shipment-id.md) - API Reference > Orders [Update Tracking Uploaded Status for Multiple Shipments by Shipment Id](https://developer.shipbob.com/2025-07/api/orders/update-tracking-uploaded-status-for-multiple-shipments-by-shipment-id.md) - API Reference > Orders > Additional [Get one Shipment's status timeline by Shipment Id](https://developer.shipbob.com/2025-07/api/orders/get-one-shipments-status-timeline-by-shipment-id.md) - API Reference > Orders > Additional [Cancel single Order by Order ID](https://developer.shipbob.com/2025-07/api/orders/cancel-single-order-by-order-id.md) - API Reference > Orders > Additional [Cancel one Shipment by Shipment Id](https://developer.shipbob.com/2025-07/api/orders/cancel-one-shipment-by-shipment-id.md) - API Reference > Orders > Additional [Get shipping methods](https://developer.shipbob.com/2025-07/api/orders/get-shipping-methods.md) - API Reference > Orders > Additional [Get one Shipment's status timeline by Order Id and Shipment Id](https://developer.shipbob.com/2025-07/api/orders/get-one-shipments-status-timeline-by-order-id-and-shipment-id.md) - API Reference > Orders > Additional [Get all Shipments for Order](https://developer.shipbob.com/2025-07/api/orders/get-all-shipments-for-order.md) - API Reference > Orders > Additional [Get logs for one Shipment by Order Id and Shipment Id](https://developer.shipbob.com/2025-07/api/orders/get-logs-for-one-shipment-by-order-id-and-shipment-id.md) - API Reference > Orders > Additional [Cancel one Shipment by Order Id and Shipment Id](https://developer.shipbob.com/2025-07/api/orders/cancel-one-shipment-by-order-id-and-shipment-id.md) - API Reference > Orders > Additional [Get logs for one Shipment by Shipment Id](https://developer.shipbob.com/2025-07/api/orders/get-logs-for-one-shipment-by-shipment-id.md) - API Reference > Orders > Additional [Get one Shipment by Order Id and Shipment Id](https://developer.shipbob.com/2025-07/api/orders/get-one-shipment-by-order-id-and-shipment-id.md) - API Reference > Orders > Additional [Estimate Fulfillment Cost For Order](https://developer.shipbob.com/2025-07/api/orders/estimate-fulfillment-cost-for-order.md) - API Reference > Orders > Additional [Get Order Store Json](https://developer.shipbob.com/2025-07/api/orders/get-order-store-json.md) - API Reference > Orders > Additional [Save the Store Order Json](https://developer.shipbob.com/2025-07/api/orders/save-the-store-order-json.md) - API Reference > Products [Create single product to the store ](https://developer.shipbob.com/2025-07/api/products/create-single-product-to-the-store.md) - API Reference > Products [Retrieves List of Products based on filters provided ](https://developer.shipbob.com/2025-07/api/products/retrieves-list-of-products-based-on-filters-provided.md) - API Reference > Products [ Gets Product by Id ](https://developer.shipbob.com/2025-07/api/products/gets-product-by-id.md) - API Reference > Products [Update a single product with Json Merge Patch functionality ](https://developer.shipbob.com/2025-07/api/products/update-a-single-product-with-json-merge-patch-functionality.md) - API Reference > Products > Variants [Gets multiple product variants ](https://developer.shipbob.com/2025-07/api/products/gets-multiple-product-variants.md) - API Reference > Products > Variants [Adds new product variants to a product ](https://developer.shipbob.com/2025-07/api/products/adds-new-product-variants-to-a-product.md) - API Reference > Products > Variants [Updates multiple product variants ](https://developer.shipbob.com/2025-07/api/products/updates-multiple-product-variants.md) - API Reference > Products > Variants [Used to merge two or more variants together ](https://developer.shipbob.com/2025-07/api/products/used-to-merge-two-or-more-variants-together.md) - API Reference > Products > Variants [Migrates variants to existing product ](https://developer.shipbob.com/2025-07/api/products/migrates-variants-to-existing-product.md) - API Reference > Products > Variants [Migrates existing variants to a new product ](https://developer.shipbob.com/2025-07/api/products/migrates-existing-variants-to-a-new-product.md) - API Reference > Products > Variants [Create a new Channel Metadata Entry for a given Variant ](https://developer.shipbob.com/2025-07/api/products/create-a-new-channel-metadata-entry-for-a-given-variant.md) - API Reference > Products > Variants [Update specific channel metadata record from a variant by channel metadata ID ](https://developer.shipbob.com/2025-07/api/products/update-specific-channel-metadata-record-from-a-variant-by-channel-metadata-id.md) - API Reference > Products > Variants [Used to delete a specific channel metadata record from a variant by channel metadata ID ](https://developer.shipbob.com/2025-07/api/products/used-to-delete-a-specific-channel-metadata-record-from-a-variant-by-channel-metadata-id.md) - API Reference > Products > Additional [Gets Packaging Requirement ](https://developer.shipbob.com/2025-07/api/products/gets-packaging-requirement.md) - API Reference > Products > Additional [ Gets Taxonomy ](https://developer.shipbob.com/2025-07/api/products/gets-taxonomy.md) - API Reference > Products > Additional [ Gets Taxonomy by Id ](https://developer.shipbob.com/2025-07/api/products/gets-taxonomy-by-id.md) - API Reference > Products > Additional [ Gets Taxonomy Parent ](https://developer.shipbob.com/2025-07/api/products/gets-taxonomy-parent.md) - API Reference > Products > Additional [Deletes Bundle and removes associations to related products ](https://developer.shipbob.com/2025-07/api/products/deletes-bundle-and-removes-associations-to-related-products.md) - API Reference > Products > Additional [Add new product variants to a product ](https://developer.shipbob.com/2025-07/api/products/add-new-product-variants-to-a-product.md) - API Reference > Inventory [ Get All Inventory Levels ](https://developer.shipbob.com/2025-07/api/inventory/get-all-inventory-levels.md) - API Reference > Inventory [ Get Inventory Levels ](https://developer.shipbob.com/2025-07/api/inventory/get-inventory-levels.md) - API Reference > Inventory [ Get Inventory ](https://developer.shipbob.com/2025-07/api/inventory/get-inventory.md) - API Reference > Inventory [ Get All Inventories ](https://developer.shipbob.com/2025-07/api/inventory/get-all-inventories.md) - API Reference > Inventory > By Fulfillment Center [ Get All Inventory Levels Grouped By Fulfillment Center ](https://developer.shipbob.com/2025-07/api/inventory/get-all-inventory-levels-grouped-by-fulfillment-center.md) - API Reference > Inventory > By Fulfillment Center [ Get Inventory Levels Grouped By Fulfillment Center ](https://developer.shipbob.com/2025-07/api/inventory/get-inventory-levels-grouped-by-fulfillment-center.md) - API Reference > Inventory > By Lot [ Get All Inventory Levels Grouped By Lot ](https://developer.shipbob.com/2025-07/api/inventory/get-all-inventory-levels-grouped-by-lot.md) - API Reference > Inventory > By Lot [ Get Inventory Levels Grouped By Lot ](https://developer.shipbob.com/2025-07/api/inventory/get-inventory-levels-grouped-by-lot.md) - API Reference > Receiving [Create Warehouse Receiving Order ](https://developer.shipbob.com/2025-07/api/receiving/create-warehouse-receiving-order.md) - API Reference > Receiving [Get Multiple Warehouse Receiving Orders ](https://developer.shipbob.com/2025-07/api/receiving/get-multiple-warehouse-receiving-orders.md) - API Reference > Receiving [Get Warehouse Receiving Order ](https://developer.shipbob.com/2025-07/api/receiving/get-warehouse-receiving-order.md) - API Reference > Receiving [Get Fulfillment Centers ](https://developer.shipbob.com/2025-07/api/receiving/get-fulfillment-centers.md) - API Reference > Receiving [Get Warehouse Receiving Order Boxes ](https://developer.shipbob.com/2025-07/api/receiving/get-warehouse-receiving-order-boxes.md) - API Reference > Receiving [Get Warehouse Receiving Order Box Labels ](https://developer.shipbob.com/2025-07/api/receiving/get-warehouse-receiving-order-box-labels.md) - API Reference > Receiving [Cancel Warehouse Receiving Order ](https://developer.shipbob.com/2025-07/api/receiving/cancel-warehouse-receiving-order.md) - API Reference > Receiving [Set ExternalSync flag for Wros ](https://developer.shipbob.com/2025-07/api/receiving/set-external-sync-flag-for-wros.md) - API Reference > Receiving [Get Inventory Distributions by WRO Id ](https://developer.shipbob.com/2025-07/api/receiving/get-inventory-distributions-by-wro-id.md) - API Reference > Returns [Create a return. ](https://developer.shipbob.com/2025-07/api/returns/create-a-return.md) - API Reference > Returns [Get Return Orders ](https://developer.shipbob.com/2025-07/api/returns/get-return-orders.md) - API Reference > Returns [Get Return Order ](https://developer.shipbob.com/2025-07/api/returns/get-return-order.md) - API Reference > Returns [Modify Return Order ](https://developer.shipbob.com/2025-07/api/returns/modify-return-order.md) - API Reference > Returns [Cancel Return Order ](https://developer.shipbob.com/2025-07/api/returns/cancel-return-order.md) - API Reference > Webhooks [Create Subscription ](https://developer.shipbob.com/2025-07/api/webhooks/create-subscription.md) - API Reference > Webhooks [Get Subscriptions ](https://developer.shipbob.com/2025-07/api/webhooks/get-subscriptions.md) - API Reference > Webhooks [Delete Subscription ](https://developer.shipbob.com/2025-07/api/webhooks/delete-subscription.md) - API Reference > Locations [Get locations ](https://developer.shipbob.com/2025-07/api/locations/get-locations.md) - API Reference > Billing [Get Invoices](https://developer.shipbob.com/2025-07/api/billing/get-invoices.md) - API Reference > Billing [Get transaction fees ](https://developer.shipbob.com/2025-07/api/billing/get-transaction-fees.md) - API Reference > Billing [Get transactions by invoiceid ](https://developer.shipbob.com/2025-07/api/billing/get-transactions-by-invoiceid.md) - API Reference > Billing [Search transactions](https://developer.shipbob.com/2025-07/api/billing/search-transactions.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developer.shipbob.com/openapi.json) - [OpenAPI YAML](https://developer.shipbob.com/openapi.yaml)