ShipBob (Personal Access Token)

Deletes a bundle product by ID. Delete operation not allowed for non-bundles.

This endpoint deletes a webhook subscription.

Retrieves a paginated list of channels that the authenticated user has access to based on the provided access token.

Returns a list of ShipBob fulfillment centers where inventory can be received.

Retrieves a paginated list of all inventory items. Supports filtering by active status, tags, and various product attributes. Use query parameters to search and filter results.

Retrieves detailed information about a specific inventory item by its ID, including product details, variant information, and associated metadata.

Retrieves current inventory levels across all locations. Returns available, on-hand, committed, and other quantity types. Supports filtering by inventory IDs and product attributes.

Retrieves the aggregated inventory levels for a specific inventory item across all locations, including available, on-hand, committed, and other quantity types.

Retrieves inventory levels for a specific inventory item broken down by fulfillment center location. Shows quantity breakdowns for each location where the inventory is stored.

Retrieves inventory levels for a specific inventory item broken down by lot number. Useful for tracking inventory by manufacturing lot, expiration date, or batch information.

Retrieves inventory levels for all inventory items grouped by fulfillment center location. Supports filtering by location type, location ID, and various product attributes.

Retrieves inventory levels for all inventory items grouped by lot number. Enables tracking of inventory across multiple lots, including expiration dates and manufacturing batch information.

Gets a paginated list of invoices, optionally filtered by invoice types and date range

The unique identifier of the invoice whose transactions are to be retrieved

Retrieves physical locations across ShipBob's fulfillment network. An active location (`is_active=true`) is operational for fulfillment processes, including receiving inventory and processing returns. Access to locations varies: some are available to all merchants by default, while others require special approval. Use the `access_granted` parameter to determine if a location is available to the authenticated user, and `receiving_enabled` to confirm if the location accepts inventory.

Retrieves a paginated list of orders from your ShipBob account with optional filters. All filter parameters use AND logic, meaning orders must match all provided criteria to be returned.

Retrieve the IDs of orders and their associated shipments that have been fully cancelled, meaning all shipments within the order are in a cancelled state.

Retrieves detailed information about a specific order by its order ID, including order status, shipments, products, and recipient details.

Retrieves all shipments associated with a specific order, including shipment status, tracking information, and product details.

Retrieves detailed shipment information for a specific order and shipment combination, including shipment status, tracking information, fulfillment center location, and contained products.

Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.

Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.

Retrieves the original store order data associated with the order in JSON format, preserving custom fields and metadata from the order source.

Retrieves all available packaging requirements that can be assigned to a product.

Retrieves a paginated list of products. Supports filtering by search term, barcode, SKU, status, and other criteria.

Retrieves a product with all its variants and details.

Retrieves all variants for a specific product.

Returns a list of warehouse receiving orders with optional filtering by status, fulfillment center, purchase order number, and date range.

Returns details of a specific warehouse receiving order by ID.

Returns the boxes and their contents for a specific warehouse receiving order.

Retrieves the distribution details for a specific receiving order within ShipBob's Inventory Placement Program (IPP). <Warning>This endpoint is available only to accounts enrolled in ShipBob's Inventory Placement Program (IPP).</Warning>

Returns a PDF containing box labels for a specific warehouse receiving order.

Retrieves a paginated list of return orders with optional filters for IDs, statuses, dates, and other criteria. Use this to track all returns across your ShipBob account.

Retrieves the complete details of a specific return order by its unique ID. Use this to view return status, inventory items, transactions, and processing history.

Retrieves detailed information about a specific shipment by shipment ID, including shipment status, tracking information, fulfillment center location, and contained products.

Retrieves the current line items for a specific shipment, including product variant details, lot information, committed quantities, and serial numbers. Use this endpoint to get the current state before calling updateLineItems, which requires the full item list.

Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.

Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.

Retrieves tracking information for one or more shipments by their ShipBob shipment Ids. Returns the current status, carrier details, estimated delivery time, and full tracking history for each shipment. Accepts between 1 and 25 shipment Ids per request.

Retrieves all available shipping methods configured for your merchant account.

Retrieves all available product taxonomies for categorizing products.

Retrieves a specific taxonomy node and its details by taxonomy ID.

Retrieves the parent taxonomy node for a given taxonomy ID.

Retrieves tracking information for one or more shipments by their carrier tracking IDs. Returns the current status, carrier details, estimated delivery time, and full tracking history for each tracking ID. Intended for platform-level consumers that reference shipments by carrier tracking number rather than ShipBob shipment ID.

This endpoint returns a list of transaction fees

This endpoint returns a list of webhook subscriptions.

Updates a product. Supports partial updates - only the fields provided will be updated. When updating variants through this endpoint, you must include the variant ID.

Updates one or more product variants. The request body must be an array of variant objects. Each variant must include the variant ID, and only the fields provided will be updated.

Fetches inventory movement events that change on-hand quantities within the ShipBob network. Returns events such as receiving/stow, order picks, adjustments, restocks, and attribute updates. Filter by inventory IDs, event category, date range, and facility. Supports cursor-based pagination for large result sets.

Creates a new order in ShipBob’s system that will be queued for fulfillment. Orders can be created using either product reference IDs (SKUs) or ShipBob product IDs, with reference IDs being the recommended approach.

This endpoint will provide, where possible, an estimate of pricing and fulfillment center assignment of a potential standard (direct to consumer) order. Keep in mind that there are ways for the merchant to change FC assignment or product configuration after order creation that could invalidate this estimate. Estimates cannot be returned for items that are unknown, out of stock, or too large for fulfillment using standard box sizes. Additional services such as high-pick fees, shipping insurance, auto-splitting or auto-adding items to orders, and signature required are not included in this estimate.

Returns an estimated delivery date for a given destination and set of line items. The destination address must always include `zip_code` and `country`. The flow is auto-detected from the request shape: an address with only `zip_code` and `country` plus exactly one line item is treated as the Product Details Page (PDP) flow; a full address with one or more line items is treated as the Checkout flow.

Cancels an order and all associated shipments. The order must be in a cancellable state to proceed with the cancellation.

Cancels a specific shipment by order ID and shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.

Creates a new product with one or more variants. Requires a product name and at least one variant with a unique SKU.

Creates a new product and moves existing variants from their current products into it. Provide the new product details and variant IDs.

Moves variants from their current product to the target product specified in the path. Provide an array of variant IDs to move.

Adds new variants to an existing product. The request body must be an array of variant objects, each requiring a unique SKU.

Creates a new warehouse receiving order with specified fulfillment center, boxes, and inventory items.

Cancels an existing warehouse receiving order. Only orders in certain statuses can be cancelled.

Sets the external sync flag for one or more warehouse receiving orders to enable or disable external synchronization.

Creates a new return order for a previously shipped order. Specify the original shipment, inventory items to return, and requested return actions.

Cancels a return order for given return ID.

Cancels multiple shipments in a single request. Shipments can only be cancelled if they are in a cancellable state (i.e. not picked, packed, or shipped yet).

Mark tracking information as synced to your external system for multiple shipments. Use this endpoint after syncing tracking data to update the IsTrackingUploaded flag, preventing these shipments from appearing in future GET /order queries with IsTrackingUploaded=false. <Tip>Use this endpoint if you're filtering orders by is_tracking_uploaded. This allows integrations to acknowledge that shipments have been successfully synced to their system.</Tip>

Cancels a specific shipment by shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.

Updates the line items for a specific shipment. The request body must include the complete list of line items as returned by the GET /shipment/{shipmentId}:getLineItems endpoint — partial updates are not supported. Retrieve the current line items first, modify the desired fields, and submit the full payload. **Important:** The `is_manually_assigned_lot` field must be set to the same value for all line items in the request. When set to `true` on any item, ShipBob treats all lot assignments in the shipment as manually reviewed — ShipBob will not auto-assign or re-optimize lots for any item. When set to `false`, ShipBob manages lot selection automatically. Mixing `true` and `false` across items in the same request will result in a validation error. **Note on error handling:** This endpoint returns HTTP 200 for both successful and failed operations. Always check the `is_success` field in the response body to determine the outcome. When `is_success` is `false`, the `error` object contains the error code and message. HTTP 400 is only returned when the request body itself is missing or empty.

Search transactions with filters (date, invoice, fee type, etc.)

Converts an existing product variant into a bundle product. Provide the bundle definition specifying which variants and quantities make up the bundle.

Merges multiple product variants into a target variant. Provide an array of variant IDs to merge into the target variant specified in the path. Inventory from the merged variants will be consolidated into the target variant.

This endpoint creates a new webhook subscription.

Updates an existing return using the provided request body and returns the updated return payload.

Updates the shipping service for multiple shipments in a single request. The `requested_shipping_service_id` corresponds to the `service_level.id` value returned by the [Get Shipping Methods](/api/orders/get-shipping-methods) endpoint.

Updates the shipping address for a specific shipment.