> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer-stage.shipbob.dev/experimental/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer-stage.shipbob.dev/_mcp/server. # Experimental ## Docs - [Introduction](https://developer-stage.shipbob.dev/experimental/introduction.md) - [Quickstart](https://developer-stage.shipbob.dev/experimental/quickstart.md) - [Authentication](https://developer-stage.shipbob.dev/experimental/auth.md): Learn how to authenticate with ShipBob's API using Personal Access Tokens or OAuth 2.0 - [Rate limit](https://developer-stage.shipbob.dev/experimental/rate-limit.md) - [Setup Sandbox Account](https://developer-stage.shipbob.dev/experimental/sandbox/setup.md): Learn how to setup a sandbox account on ShipBob - [Sandbox Simulations](https://developer-stage.shipbob.dev/experimental/sandbox/simulations.md) - [Checklist](https://developer-stage.shipbob.dev/experimental/sandbox/checklist.md): Use this checklist as you build your integration - [Webhooks](https://developer-stage.shipbob.dev/experimental/webhooks.md) - [Overview](https://developer-stage.shipbob.dev/experimental/guides/overview.md): Use cases for how to build with the ShipBob API - [Orders](https://developer-stage.shipbob.dev/experimental/guides/orders.md) - [Build an Orders Integration](https://developer-stage.shipbob.dev/experimental/guides/build-orders-integration.md): A complete guide to creating and managing orders using the ShipBob API - [Products](https://developer-stage.shipbob.dev/experimental/guides/products.md): How to create and manage products with the ShipBob API - [Product Catalog](https://developer-stage.shipbob.dev/experimental/guides/product-catalog.md): API documentation for managing products through the ShipBob product catalog. - [Inventory](https://developer-stage.shipbob.dev/experimental/guides/inventory.md) - [Inventory History](https://developer-stage.shipbob.dev/experimental/guides/inventory-history.md): - [Tracking](https://developer-stage.shipbob.dev/experimental/guides/tracking.md) - [Receiving](https://developer-stage.shipbob.dev/experimental/guides/receiving.md): How to create and manage warehouse receiving orders using the ShipBob API - [Returns](https://developer-stage.shipbob.dev/experimental/guides/returns.md): How to create and manage returns using the ShipBob API - [Billing](https://developer-stage.shipbob.dev/experimental/guides/billing.md): Manage and retrieve billing-related data including invoices, transactions, and transaction fees - [Concepts](https://developer-stage.shipbob.dev/experimental/concepts.md) - [Status Reference](https://developer-stage.shipbob.dev/experimental/status-reference.md) - [MCP Server](https://developer-stage.shipbob.dev/experimental/mcp-server.md): The ShipBob MCP (Model Context Protocol) Server enables AI assistants and agents to interact with ShipBob's Developer API through a standardized protocol. Connect claude.ai, ChatGPT, Claude Desktop, or any MCP-compatible client to work with your ShipBob data through conversational commands. - [Versioning Policy](https://developer-stage.shipbob.dev/experimental/versioning/versioning-guide.md) - [Upgrade to 2025-07](https://developer-stage.shipbob.dev/experimental/versioning/2025-07-migration.md): Migration Guide for Upgrading from version 2.0 to 2025-07 - [Upgrade to 2026-01](https://developer-stage.shipbob.dev/experimental/versioning/2026-01-migration.md): Migration guide for upgrading from version 2025-07 to 2026-01 - [Migrate to PKCE](https://developer-stage.shipbob.dev/experimental/migration/pkce.md): Add PKCE (Proof Key for Code Exchange) to an existing OAuth app's authorization flow. - [Errors](https://developer-stage.shipbob.dev/experimental/errors.md): - [FAQ](https://developer-stage.shipbob.dev/experimental/faq.md): Common questions ## API Docs - API Reference > Channels [ Search channels ](https://developer-stage.shipbob.dev/experimental/api/channels/search-channels.md) - API Reference > Receiving [Set ExternalSync flag for Wros ](https://developer-stage.shipbob.dev/experimental/api/receiving/set-external-sync-flag-for-wros.md) - API Reference > Receiving [Create Warehouse Receiving Order ](https://developer-stage.shipbob.dev/experimental/api/receiving/create-warehouse-receiving-order.md) - API Reference > Receiving [Update box tracking for a Warehouse Receiving Order ](https://developer-stage.shipbob.dev/experimental/api/receiving/update-box-tracking-for-a-warehouse-receiving-order.md) - API Reference > Receiving [Update Warehouse Receiving Order ](https://developer-stage.shipbob.dev/experimental/api/receiving/update-warehouse-receiving-order.md) - API Reference > Receiving [Get Purchase Order Warehouse Receiving Orders ](https://developer-stage.shipbob.dev/experimental/api/receiving/get-purchase-order-warehouse-receiving-orders.md) - API Reference > Receiving [List Purchase Orders ](https://developer-stage.shipbob.dev/experimental/api/receiving/list-purchase-orders.md) - API Reference > Receiving [Create Purchase Order ](https://developer-stage.shipbob.dev/experimental/api/receiving/create-purchase-order.md) - API Reference > Receiving [Get Purchase Order ](https://developer-stage.shipbob.dev/experimental/api/receiving/get-purchase-order.md) - API Reference > Receiving [Update Purchase Order ](https://developer-stage.shipbob.dev/experimental/api/receiving/update-purchase-order.md) - API Reference > Receiving [Get Warehouse Receiving Order Purchase Orders ](https://developer-stage.shipbob.dev/experimental/api/receiving/get-warehouse-receiving-order-purchase-orders.md) - API Reference > Receiving [Cancel Purchase Order ](https://developer-stage.shipbob.dev/experimental/api/receiving/cancel-purchase-order.md) - API Reference > Products [Gets multiple product variants ](https://developer-stage.shipbob.dev/experimental/api/products/gets-multiple-product-variants.md) - API Reference > Products [Adds new product variants to a product ](https://developer-stage.shipbob.dev/experimental/api/products/adds-new-product-variants-to-a-product.md) - API Reference > Products [Updates multiple product variants ](https://developer-stage.shipbob.dev/experimental/api/products/updates-multiple-product-variants.md) - API Reference > Products [Create a new Channel Metadata Entry for a given Variant ](https://developer-stage.shipbob.dev/experimental/api/products/create-a-new-channel-metadata-entry-for-a-given-variant.md) - API Reference > Products [ Gets Product by Id ](https://developer-stage.shipbob.dev/experimental/api/products/gets-product-by-id.md) - API Reference > Products [Deletes Bundle and removes associations to related products ](https://developer-stage.shipbob.dev/experimental/api/products/deletes-bundle-and-removes-associations-to-related-products.md) - API Reference > Products [Update a single product with Json Merge Patch functionality ](https://developer-stage.shipbob.dev/experimental/api/products/update-a-single-product-with-json-merge-patch-functionality.md) - API Reference > Products [ Gets Taxonomy by Id ](https://developer-stage.shipbob.dev/experimental/api/products/gets-taxonomy-by-id.md) - API Reference > Products [Retrieves List of Products based on filters provided ](https://developer-stage.shipbob.dev/experimental/api/products/retrieves-list-of-products-based-on-filters-provided.md) - API Reference > Products [Create single product to the store ](https://developer-stage.shipbob.dev/experimental/api/products/create-single-product-to-the-store.md) - API Reference > Products [ Gets Taxonomy ](https://developer-stage.shipbob.dev/experimental/api/products/gets-taxonomy.md) - API Reference > Products [Used to merge two or more variants together ](https://developer-stage.shipbob.dev/experimental/api/products/used-to-merge-two-or-more-variants-together.md) - API Reference > Products [Update specific channel metadata record from a variant by channel metadata ID ](https://developer-stage.shipbob.dev/experimental/api/products/update-specific-channel-metadata-record-from-a-variant-by-channel-metadata-id.md) - API Reference > Products [Used to delete a specific channel metadata record from a variant by channel metadata ID ](https://developer-stage.shipbob.dev/experimental/api/products/used-to-delete-a-specific-channel-metadata-record-from-a-variant-by-channel-metadata-id.md) - API Reference > Products [Migrates variants to existing product ](https://developer-stage.shipbob.dev/experimental/api/products/migrates-variants-to-existing-product.md) - API Reference > Products [ Gets Taxonomy Parent ](https://developer-stage.shipbob.dev/experimental/api/products/gets-taxonomy-parent.md) - API Reference > Products [Migrates existing variants to a new product ](https://developer-stage.shipbob.dev/experimental/api/products/migrates-existing-variants-to-a-new-product.md) - API Reference > Products [Gets Packaging Requirement ](https://developer-stage.shipbob.dev/experimental/api/products/gets-packaging-requirement.md) - API Reference > Products [Add new product variants to a product ](https://developer-stage.shipbob.dev/experimental/api/products/add-new-product-variants-to-a-product.md) - API Reference > Billing [Get Invoices](https://developer-stage.shipbob.dev/experimental/api/billing/get-invoices.md) - API Reference > Billing [Get transactions by invoiceid ](https://developer-stage.shipbob.dev/experimental/api/billing/get-transactions-by-invoiceid.md) - API Reference > Billing [Search transactions](https://developer-stage.shipbob.dev/experimental/api/billing/search-transactions.md) - API Reference > Billing [Get transaction fees ](https://developer-stage.shipbob.dev/experimental/api/billing/get-transaction-fees.md) - API Reference > Inventory [ Get Inventory ](https://developer-stage.shipbob.dev/experimental/api/inventory/get-inventory.md) - API Reference > Inventory [ Get All Inventories ](https://developer-stage.shipbob.dev/experimental/api/inventory/get-all-inventories.md) - API Reference > Inventory [ Get All Inventory Levels ](https://developer-stage.shipbob.dev/experimental/api/inventory/get-all-inventory-levels.md) - API Reference > Inventory [ Get Inventory Levels Grouped By Fulfillment Center ](https://developer-stage.shipbob.dev/experimental/api/inventory/get-inventory-levels-grouped-by-fulfillment-center.md) - API Reference > Inventory [ Get All Inventory Levels Grouped By Fulfillment Center ](https://developer-stage.shipbob.dev/experimental/api/inventory/get-all-inventory-levels-grouped-by-fulfillment-center.md) - API Reference > Inventory [ Get All Inventory Levels Grouped By Lot ](https://developer-stage.shipbob.dev/experimental/api/inventory/get-all-inventory-levels-grouped-by-lot.md) - API Reference > Inventory [ Get Inventory Levels ](https://developer-stage.shipbob.dev/experimental/api/inventory/get-inventory-levels.md) - API Reference > Inventory [ Get Inventory Levels Grouped By Lot ](https://developer-stage.shipbob.dev/experimental/api/inventory/get-inventory-levels-grouped-by-lot.md) - API Reference > Inventory [ Get Lot Exclusions ](https://developer-stage.shipbob.dev/experimental/api/inventory/get-lot-exclusions.md) - API Reference > Inventory [ Create Lot Exclusion ](https://developer-stage.shipbob.dev/experimental/api/inventory/create-lot-exclusion.md) - API Reference > Inventory [ Delete Lot Exclusion ](https://developer-stage.shipbob.dev/experimental/api/inventory/delete-lot-exclusion.md) - API Reference > Inventory [ Restore Lot Exclusion ](https://developer-stage.shipbob.dev/experimental/api/inventory/restore-lot-exclusion.md) - API Reference > Inventory [ Set B2B Reservation Quantity ](https://developer-stage.shipbob.dev/experimental/api/inventory/set-b-2-b-reservation-quantity.md) - API Reference > Inventory [ Get Inventory Levels by Channel ](https://developer-stage.shipbob.dev/experimental/api/inventory/get-inventory-levels-by-channel.md) - API Reference > Inventory [ Get All Inventory Levels by Channel ](https://developer-stage.shipbob.dev/experimental/api/inventory/get-all-inventory-levels-by-channel.md) - API Reference > Kitting [Create Work Order ](https://developer-stage.shipbob.dev/experimental/api/kitting/create-work-order.md) - API Reference > Kitting [Get Action Types ](https://developer-stage.shipbob.dev/experimental/api/kitting/get-action-types.md) - API Reference > Kitting [Upload Attachment ](https://developer-stage.shipbob.dev/experimental/api/kitting/upload-attachment.md) - API Reference > Kitting [Create Work Order from Existing ](https://developer-stage.shipbob.dev/experimental/api/kitting/create-work-order-from-existing.md) - API Reference > Kitting [Get Kitting Work Orders ](https://developer-stage.shipbob.dev/experimental/api/kitting/get-kitting-work-orders.md) - API Reference > Kitting [Set Kitting Work Order External Sync ](https://developer-stage.shipbob.dev/experimental/api/kitting/set-kitting-work-order-external-sync.md) - API Reference > Returns [Create Return Order ](https://developer-stage.shipbob.dev/experimental/api/returns/create-return-order.md) - API Reference > Returns [Create Return Label ](https://developer-stage.shipbob.dev/experimental/api/returns/create-return-label.md) - API Reference > Returns [Search Return Orders ](https://developer-stage.shipbob.dev/experimental/api/returns/search-return-orders.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developer-stage.shipbob.dev/openapi.json) - [OpenAPI YAML](https://developer-stage.shipbob.dev/openapi.yaml)