ShipBob integration: operations for AI agents
ShipBob connects to Type.com as an integration. This page lists the 79 operations documented for Claude and Codex in Type.com: 48 read, 22 write, 9 destructive.
About ShipBob
ShipBob is an ecommerce fulfillment platform (3PL) whose developer API manages orders, products, inventory, returns, warehouse receiving orders, and fulfillment status across its fulfillment-center network.
Categories: Commerce & Payments
How to connect ShipBob to Type.com
- Connect
- Access token
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
79 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
79 operations listed.
Billing
- Read
Get Invoices
Gets a paginated list of invoices, optionally filtered by invoice types and date range
GET /invoices - Read
Get Transactions by Invoice ID
The unique identifier of the invoice whose transactions are to be retrieved
GET /invoices/{invoiceId}/transactions - Read
Get Transaction Fees
This endpoint returns a list of transaction fees
GET /transaction-fees - Read
Search Transactions
Search transactions with filters (date, invoice, fee type, etc.)
POST /transactions:query
Channels
- Read
Get Channels
Retrieves a paginated list of channels that the authenticated user has access to based on the provided access token.
GET /channel
Inventory
- Read
Get All Inventories
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. Returns the inventory item catalog (item records and their attributes), not stock quantities; for current stock counts use the inventory levels endpoint (GET /inventory-level).
GET /inventory - Read
Get All Inventory Levels
Retrieves current inventory levels across all locations. Returns available, on-hand, committed, and other quantity types. Supports filtering by inventory IDs and product attributes. Use this endpoint for current or real-time stock questions, for example what is in stock or out of stock right now.
GET /inventory-level - Read
Get All Inventory Levels Grouped By Fulfillment Center
Retrieves inventory levels for all inventory items grouped by fulfillment center location. Supports filtering by location type, location ID, and various product attributes. Returns inventory quantities broken down by fulfillment center location; it does not return the list of fulfillment centers. For the physical location list use the Locations API, and for receiving-eligible fulfillment centers use the Receiving API's fulfillment centers endpoint.
GET /inventory-level/locations - Read
Get All Inventory Levels Grouped By Lot
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.
GET /inventory-level/lots - Read
Get Inventory Levels
Retrieves the aggregated inventory levels for a specific inventory item across all locations, including available, on-hand, committed, and other quantity types. Use this endpoint to answer how much stock or how many fulfillable units of an item are available.
GET /inventory-level/{inventoryId} - Read
Get Inventory Levels Grouped By Fulfillment Center
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.
GET /inventory-level/{inventoryId}/locations - Read
Get Inventory Levels Grouped By Lot
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.
GET /inventory-level/{inventoryId}/lots - Read
Get Inventory
Retrieves detailed information about a specific inventory item by its ID, including product details, variant information, and associated metadata. Returns the item record (attributes, variants, and configuration), not stock quantities; for the item's stock quantities (on-hand, committed, fulfillable) use the inventory levels by ID endpoint (GET /inventory-level/{inventoryId}).
GET /inventory/{inventoryId}
Inventory History
- Read
Query Inventory History Events
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.
POST /inventory/history:query
Locations
- Read
Get Locations
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.
GET /location
Orders
- Read
Get Orders
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.
GET /order - Read
Get Completely Cancelled Orders
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.
GET /order/cancelled - Read
Get Order
Retrieves detailed information about a specific order by its order ID, including order status, shipments, products, and recipient details.
GET /order/{orderId} - Read
Get All Shipments for Order
Retrieves all shipments associated with a specific order, including shipment status, tracking information, and product details.
GET /order/{orderId}/shipment - Read
Get Shipment by Order ID and Shipment ID
Retrieves detailed shipment information for a specific order and shipment combination, including shipment status, tracking information, fulfillment center location, and contained products.
GET /order/{orderId}/shipment/{shipmentId} - Read
Get Shipment Logs by Order ID and Shipment ID
Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.
GET /order/{orderId}/shipment/{shipmentId}/logs - Read
Get Shipment Status Timeline by Order ID and Shipment ID
Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.
GET /order/{orderId}/shipment/{shipmentId}/timeline - Read
Get Order Store Data
Retrieves the original store order data associated with the order in JSON format, preserving custom fields and metadata from the order source.
GET /order/{orderId}/store-order-json - Read
Estimate Fulfillment Cost For Order
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.
POST /order:estimate - Read
Estimate Delivery Date
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.
POST /order:estimateDeliveryDate - Read
Get Shipment
Retrieves detailed information about a specific shipment by shipment ID, including shipment status, tracking information, fulfillment center location, and contained products.
GET /shipment/{shipmentId} - Read
Get Shipment Logs
Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.
GET /shipment/{shipmentId}/logs - Read
Get Shipment Timeline
Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.
GET /shipment/{shipmentId}/timeline - Read
Get Shipment Line Items
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.
GET /shipment/{shipmentId}:getLineItems - Read
Get Shipping Methods
Retrieves all available shipping methods configured for your merchant account.
GET /shipping-method - Write
Create Order
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.
POST /order - Write
Assign Fulfillment Center
Assigns a specific fulfillment center to a shipment, overriding the automatically selected one. The caller must have access to the target fulfillment center. **Important — asynchronous inventory re-evaluation:** This action does NOT pre-check inventory availability at the target fulfillment center. The assignment succeeds immediately and inventory allocation re-evaluates the shipment asynchronously; if stock is missing at the target FC the shipment may land in an exception state. It also does not revalidate that the target fulfillment center supports the shipment's current shipping service. Both behaviors mirror the merchant dashboard. **Validation:** The action is rejected when the shipment is already picked, being picked, or sorted by the warehouse; cancelled; shipped or completed; a Kitting shipment; an Automated Amazon FBA shipment; or when the target fulfillment center is inactive or not accessible to the caller. **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; when `is_success` is `false`, the `error` object contains the code and message. HTTP 400 is only returned when the request body itself is missing (null); a missing or non-positive `fulfillment_center_id` is returned as HTTP 200 with `is_success: false`.
POST /shipment/{shipmentId}:assignFulfillmentCenter - Write
Update Shipment Address
Updates the shipping address for a specific shipment.
PUT /shipment/{shipmentId}:updateAddress - Write
Update Shipment Line Items
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.
POST /shipment/{shipmentId}:updateLineItems - Write
Update Shipment Line Items by SKU
Updates the line items for a specific shipment, identifying each item by SKU instead of inventory id. The SKU matches both the ShipBob variant SKU and the channel seller SKU. The request body must include the complete list of line items — partial updates are not supported. Retrieve the current line items first (via GET /shipment/{shipmentId}:getLineItems, which returns each item's `product_variant.sku`), modify the desired fields, and submit the full payload. **SKU resolution:** Resolution is all-or-nothing — if any SKU in the request cannot be resolved, the whole request fails and no update occurs. A SKU that resolves to a bundle or to multiple inventory items is rejected with a per-item error; use the inventory_id-based endpoint (:updateLineItems) for those items. **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.
POST /shipment/{shipmentId}:updateLineItemsBySku - Write
Mark Tracking Uploaded
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>
POST /shipment:batchUpdateTrackingUpload - Write
Bulk Place Shipments On Hold
Places a Manual hold on multiple shipments in a single request. By default the committed inventory stays reserved and an allocation hold is placed; set `reserve_inventory` to `false` to deallocate the committed inventory instead (mirrors the dashboard's "Unreserve" option). **Per-shipment results:** every shipment is evaluated independently and returns its own success/failure in `results`; one shipment failing never fails the whole request. A shipment already on a Manual hold is an idempotent success. Shipments that are picked, being fulfilled, cancelled, shipped, or otherwise ineligible fail individually. HTTP 400 is only returned when the request itself is malformed (empty `shipment_ids` or over the batch cap).
POST /shipment:bulkPlaceOnHold - Write
Bulk Release Shipments From Hold
Releases multiple shipments from hold in a single request. Only the merchant-initiated holds — Manual and Auto Processing Pause — are removed; operational holds (e.g. invalid address, short at pack) are never removed by this action. **Per-shipment results:** each shipment returns its own result in `results`. A shipment moves back to processing only when no hold reasons of any kind remain after the merchant-initiated holds are removed. If the shipment stays held for operational reasons, the release still succeeds and `is_still_on_hold_due_to_other_reasons` is `true`. Releasing a shipment with nothing to release is an idempotent success. HTTP 400 is only returned when the request itself is malformed (empty `shipment_ids` or over the batch cap).
POST /shipment:bulkReleaseHold - Write
Bulk Update Instructions
Sets the packing instructions and/or special SKU instructions on multiple shipments in a single request. Each instruction field is optional, and omitting a field is different from sending an empty one: - **Omit** the field, or send `null`, to leave that instruction unchanged. - Send an **empty string** to clear that instruction. At least one of the two must be provided with a **non-null** value — a request that omits both, or sends `null` for both, is rejected with `400 INVALID_PARAMETER`. `{"packing_instruction": null}` counts as providing nothing. Each value is limited to 500 characters, measured **after** leading and trailing whitespace is removed. Whitespace padding around a 500-character instruction is therefore accepted. `shipment_ids` is de-duplicated before the 250-shipment maximum is applied, and the response contains one result per unique id, in request order. Instructions apply to B2B, SPS B2B, drop ship, kitting and inventory transfer shipments (including Amazon FBA). Direct-to-consumer shipments do not carry packing or SKU instructions. Instructions can only be changed while a shipment is still editable. A shipment whose order type does not support instructions, that has been cancelled, cleanswept, shipped or completed, or that has already been assigned a tracking number, is reported as a per-shipment `BUSINESS_RULE_VIOLATION` rather than failing the whole request. A shipment that does not exist, or that belongs to another merchant, is reported as `NOT_FOUND`. Submitting a value a shipment already has is a successful no-op: nothing is written and no audit entry is recorded.
PUT /shipment:bulkUpdateInstructions - Write
Bulk Update Shipping Service
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.
PUT /shipment:bulkUpdateShippingService - Destructive
Cancel Shipment by Order ID and Shipment ID
Cancels a specific shipment by order ID and shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.
POST /order/{orderId}/shipment/{shipmentId}:cancel - Destructive
Cancel Order
Cancels an order and all associated shipments. The order must be in a cancellable state to proceed with the cancellation.
POST /order/{orderId}:cancel - Destructive
Cancel Shipment
Cancels a specific shipment by shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.
POST /shipment/{shipmentId}:cancel - Destructive
Batch Cancel Shipments
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).
POST /shipment:batchCancel
Products
- Read
Get Packaging Requirement
Retrieves all available packaging requirements that can be assigned to a product.
GET /packaging-requirement - Read
Get Products
Retrieves a paginated list of products. Supports filtering by search term, barcode, SKU, status, and other criteria.
GET /product - Read
Get Product
Retrieves a product with all its variants and details.
GET /product/{productId} - Read
Get Product Variants
Retrieves all variants for a specific product.
GET /product/{productId}/variants - Read
Get Taxonomies
Retrieves all available product taxonomies for categorizing products.
GET /taxonomy - Read
Get Taxonomy by ID
Retrieves a specific taxonomy node and its details by taxonomy ID.
GET /taxonomy/{id} - Read
Get Taxonomy Parent
Retrieves the parent taxonomy node for a given taxonomy ID.
GET /taxonomy/{id}/parent - Write
Create Product
Creates a new product with one or more variants. Requires a product name and at least one variant with a unique SKU.
POST /product - Write
Update Product
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.
PATCH /product/{productId} - Write
Update Product Variants
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.
PATCH /product/{productId}/variants - Write
Add Product Variants
Adds new variants to an existing product. The request body must be an array of variant objects, each requiring a unique SKU.
POST /product/{productId}/variants - Write
Move Variants Between Products
Moves variants from their current product to the target product specified in the path. Provide an array of variant IDs to move.
POST /product/{productId}:moveVariants - Write
Move Variants to New Product
Creates a new product and moves existing variants from their current products into it. Provide the new product details and variant IDs.
POST /product:moveVariants - Write
Convert Variant to Bundle
Converts an existing product variant into a bundle product. Provide the bundle definition specifying which variants and quantities make up the bundle.
POST /variant/{variantId}:convertToBundle - Destructive
Delete Product Bundle
Deletes a bundle product by ID. Delete operation not allowed for non-bundles.
DELETE /product/{productId} - Destructive
Merge Variants
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.
POST /variant/{variantId}:merge
Receiving
- Read
Get Fulfillment Centers
Returns the list of ShipBob fulfillment centers that are enabled for receiving inventory. Use this list to choose the destination fulfillment center when creating a warehouse receiving order (WRO). For the full network of ShipBob physical locations regardless of receiving eligibility, use the Locations API.
GET /fulfillment-center - Read
Get Multiple Warehouse Receiving Orders
Returns a list of warehouse receiving orders with optional filtering by status, fulfillment center, purchase order number, and date range.
GET /receiving - Read
Get Warehouse Receiving Order
Returns details of a specific warehouse receiving order by ID, including its status and the expected, received, and stowed quantities of each SKU in the order. The per-box breakdown of contents is returned by the boxes endpoint.
GET /receiving/{id} - Read
Get Warehouse Receiving Order Boxes
Returns the boxes in a specific warehouse receiving order and the line items in each box, including quantities, lot information, and inventory IDs. Use this endpoint for the per-box breakdown of a receiving order's contents; totals per SKU are returned by the receiving order details endpoint.
GET /receiving/{id}/boxes - Read
Get Inventory Distributions by WRO ID
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>
GET /receiving/{id}/distributions - Read
Get Warehouse Receiving Order Box Labels
Returns a PDF containing box labels for a specific warehouse receiving order.
GET /receiving/{id}/labels - Write
Create Warehouse Receiving Order
Creates a new warehouse receiving order with specified fulfillment center, boxes, and inventory items.
POST /receiving - Write
Set ExternalSync flag for Wros
Sets the external sync flag for one or more warehouse receiving orders to enable or disable external synchronization.
POST /receiving:setExternalSync - Destructive
Cancel Warehouse Receiving Order
Cancels an existing warehouse receiving order. Only orders in certain statuses can be cancelled.
POST /receiving/{id}:cancel
Returns
- Read
Get Return Orders
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.
GET /return - Read
Get Return Order
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.
GET /return/{id} - Write
Create Return Order
Creates a new return order for a previously shipped order. Specify the original shipment, inventory items to return, and requested return actions.
POST /return - Write
Edit Return Order
Updates an existing return using the provided request body and returns the updated return payload.
PUT /return/{id} - Destructive
Cancel Return order
Cancels a return order for given return ID.
POST /return/{id}:cancel
Tracking
- Read
Get Tracking by Shipment Ids
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.
GET /shipments-tracking - Read
Get Tracking by Tracking Ids
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.
GET /tracking
Webhooks
- Read
Get Subscriptions
This endpoint returns a list of webhook subscriptions.
GET /webhook - Write
Create Subscription
This endpoint creates a new webhook subscription.
POST /webhook - Destructive
Delete Subscription
This endpoint deletes a webhook subscription.
DELETE /webhook/{id}
No operations match.
Get started
- Open Space settings → Connections and search for ShipBob.
- Connect your account and add the connection to the Space.
- Ask for what you need in any thread in that Space.
See How connections work for access and permissions, or browse all integrations.