Can I use ShipBob as a CLI?

Yes. KosmoKrator exposes a ShipBob CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose ShipBob through MCP?

Yes. The KosmoKrator MCP gateway can expose selected ShipBob tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are ShipBob credentials stored?

ShipBob credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for ShipBob MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

ecommerce

ShipBob CLI for AI Agents

Use the ShipBob CLI from KosmoKrator to call ShipBob tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

7 functions 6 read 1 write Bearer token auth

Submit ShipBob feedback View package source

ShipBob CLI Setup

ShipBob can be configured headlessly with `kosmokrator integrations:configure shipbob`.

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure shipbob --set access_token="$SHIPBOB_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor shipbob --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

Key	Env var	Type	Required	Label
`access_token`	`SHIPBOB_ACCESS_TOKEN`	Secret `secret`	yes	Access Token
`url`	`SHIPBOB_URL`	URL `url`	no	ShipBob API URL

Call ShipBob Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call shipbob.shipbob_list_orders '{
  "page": 1,
  "limit": 1,
  "status": "example_status"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:shipbob shipbob_list_orders '{
  "page": 1,
  "limit": 1,
  "status": "example_status"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

kosmo integrations:docs shipbob --json
kosmo integrations:docs shipbob.shipbob_list_orders --json
kosmo integrations:schema shipbob.shipbob_list_orders --json
kosmo integrations:search "ShipBob" --json
kosmo integrations:list --json

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to ShipBob.

`shipbob.shipbob_list_orders`

Read read

List fulfillment orders from ShipBob. Supports pagination and filtering by status (e.g. pending, fulfilled, cancelled).

Parameters: page, limit, status

Generic CLI call

kosmo integrations:call shipbob.shipbob_list_orders '{"page":1,"limit":1,"status":"example_status"}' --json

Provider shortcut

kosmo integrations:shipbob shipbob_list_orders '{"page":1,"limit":1,"status":"example_status"}' --json

`shipbob.shipbob_get_order`

Read read

Get details for a specific ShipBob order by ID, including line items, shipping address, and fulfillment status.

Parameters: id

Generic CLI call

kosmo integrations:call shipbob.shipbob_get_order '{"id":1}' --json

Provider shortcut

kosmo integrations:shipbob shipbob_get_order '{"id":1}' --json

`shipbob.shipbob_create_order`

Write write

Create a new fulfillment order in ShipBob. Provide product line items, a receiving note, and an optional shipping method.

Parameters: receiving_note, products, shipping_method

Generic CLI call

kosmo integrations:call shipbob.shipbob_create_order '{"receiving_note":"example_receiving_note","products":"example_products","shipping_method":"example_shipping_method"}' --json

Provider shortcut

kosmo integrations:shipbob shipbob_create_order '{"receiving_note":"example_receiving_note","products":"example_products","shipping_method":"example_shipping_method"}' --json

`shipbob.shipbob_list_products`

Read read

List products in your ShipBob inventory. Supports pagination with page and limit parameters.

Parameters: page, limit

Generic CLI call

kosmo integrations:call shipbob.shipbob_list_products '{"page":1,"limit":1}' --json

Provider shortcut

kosmo integrations:shipbob shipbob_list_products '{"page":1,"limit":1}' --json

`shipbob.shipbob_get_product`

Read read

Get details for a specific ShipBob product by ID, including SKU, inventory levels, and fulfillment info.

Parameters: id

Generic CLI call

kosmo integrations:call shipbob.shipbob_get_product '{"id":1}' --json

Provider shortcut

kosmo integrations:shipbob shipbob_get_product '{"id":1}' --json

`shipbob.shipbob_list_shipments`

Read read

List shipments from ShipBob. Supports pagination with page and limit parameters.

Parameters: page, limit

Generic CLI call

kosmo integrations:call shipbob.shipbob_list_shipments '{"page":1,"limit":1}' --json

Provider shortcut

kosmo integrations:shipbob shipbob_list_shipments '{"page":1,"limit":1}' --json

`shipbob.shipbob_get_current_user`

Read read

Get the currently authenticated ShipBob user profile. Useful for verifying connectivity and account details.

Parameters: none

Generic CLI call

kosmo integrations:call shipbob.shipbob_get_current_user '{}' --json

Provider shortcut

kosmo integrations:shipbob shipbob_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

`shipbob.shipbob_list_orders`

List fulfillment orders from ShipBob. Supports pagination and filtering by status (e.g. pending, fulfilled, cancelled).

Operation: Read read
Schema command: kosmo integrations:schema shipbob.shipbob_list_orders --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (default: 1).
`limit`	integer	no	Number of orders per page (default: 25, max: 100).
`status`	string	no	Filter by order status. Common values: pending, processing, fulfilled, cancelled.

`shipbob.shipbob_get_order`

Get details for a specific ShipBob order by ID, including line items, shipping address, and fulfillment status.

Operation: Read read
Schema command: kosmo integrations:schema shipbob.shipbob_get_order --json

Parameter	Type	Required	Description
`id`	integer	yes	The ShipBob order ID.

`shipbob.shipbob_create_order`

Create a new fulfillment order in ShipBob. Provide product line items, a receiving note, and an optional shipping method.

Operation: Write write
Schema command: kosmo integrations:schema shipbob.shipbob_create_order --json

Parameter	Type	Required	Description
`receiving_note`	string	yes	A note for the fulfillment center (e.g. "Handle with care" or "Priority shipment").
`products`	array	yes	List of product line items. Each item should include product reference/ID and quantity. Example: [{"id": 123, "quantity": 2}]
`shipping_method`	string	no	Desired shipping method (e.g. "ground", "expedited", "overnight"). Optional — ShipBob selects the best method if omitted.

`shipbob.shipbob_list_products`

List products in your ShipBob inventory. Supports pagination with page and limit parameters.

Operation: Read read
Schema command: kosmo integrations:schema shipbob.shipbob_list_products --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (default: 1).
`limit`	integer	no	Number of products per page (default: 25, max: 100).

`shipbob.shipbob_get_product`

Get details for a specific ShipBob product by ID, including SKU, inventory levels, and fulfillment info.

Operation: Read read
Schema command: kosmo integrations:schema shipbob.shipbob_get_product --json

Parameter	Type	Required	Description
`id`	integer	yes	The ShipBob product ID.

`shipbob.shipbob_list_shipments`

List shipments from ShipBob. Supports pagination with page and limit parameters.

Operation: Read read
Schema command: kosmo integrations:schema shipbob.shipbob_list_shipments --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (default: 1).
`limit`	integer	no	Number of shipments per page (default: 25, max: 100).

`shipbob.shipbob_get_current_user`

Get the currently authenticated ShipBob user profile. Useful for verifying connectivity and account details.

Operation: Read read
Schema command: kosmo integrations:schema shipbob.shipbob_get_current_user --json

Parameter	Type	Required	Description
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.