KosmoKrator

data

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.

ShipBob CLI Setup

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

Install, configure, and verify 
# 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 reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

KeyEnv varTypeRequiredLabel
access_token SHIPBOB_ACCESS_TOKEN Secret secret yes Access Token
url SHIPBOB_URL URL url no ShipBob API URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

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

Discovery

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

Discovery commands 
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

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

shipbob.shipbob_list_orders

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

Read read
Parameters
page, limit, status
Generic call 
kosmo integrations:call shipbob.shipbob_list_orders '{"page":1,"limit":1,"status":"example_status"}' --json
Shortcut 
kosmo integrations:shipbob shipbob_list_orders '{"page":1,"limit":1,"status":"example_status"}' --json

shipbob.shipbob_get_order

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

Read read
Parameters
id
Generic call 
kosmo integrations:call shipbob.shipbob_get_order '{"id":1}' --json
Shortcut 
kosmo integrations:shipbob shipbob_get_order '{"id":1}' --json

shipbob.shipbob_create_order

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

Write write
Parameters
receiving_note, products, shipping_method
Generic call 
kosmo integrations:call shipbob.shipbob_create_order '{"receiving_note":"example_receiving_note","products":"example_products","shipping_method":"example_shipping_method"}' --json
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

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

Read read
Parameters
page, limit
Generic call 
kosmo integrations:call shipbob.shipbob_list_products '{"page":1,"limit":1}' --json
Shortcut 
kosmo integrations:shipbob shipbob_list_products '{"page":1,"limit":1}' --json

shipbob.shipbob_get_product

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

Read read
Parameters
id
Generic call 
kosmo integrations:call shipbob.shipbob_get_product '{"id":1}' --json
Shortcut 
kosmo integrations:shipbob shipbob_get_product '{"id":1}' --json

shipbob.shipbob_list_shipments

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

Read read
Parameters
page, limit
Generic call 
kosmo integrations:call shipbob.shipbob_list_shipments '{"page":1,"limit":1}' --json
Shortcut 
kosmo integrations:shipbob shipbob_list_shipments '{"page":1,"limit":1}' --json

shipbob.shipbob_get_current_user

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

Read read
Parameters
none
Generic call 
kosmo integrations:call shipbob.shipbob_get_current_user '{}' --json
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 3 parameters
Schema command 
kosmo integrations:schema shipbob.shipbob_list_orders --json
ParameterTypeRequiredDescription
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 1 parameters
Schema command 
kosmo integrations:schema shipbob.shipbob_get_order --json
ParameterTypeRequiredDescription
id integer yes The ShipBob order ID.
shipbob.shipbob_create_order 3 parameters
Schema command 
kosmo integrations:schema shipbob.shipbob_create_order --json
ParameterTypeRequiredDescription
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 2 parameters
Schema command 
kosmo integrations:schema shipbob.shipbob_list_products --json
ParameterTypeRequiredDescription
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 1 parameters
Schema command 
kosmo integrations:schema shipbob.shipbob_get_product --json
ParameterTypeRequiredDescription
id integer yes The ShipBob product ID.
shipbob.shipbob_list_shipments 2 parameters
Schema command 
kosmo integrations:schema shipbob.shipbob_list_shipments --json
ParameterTypeRequiredDescription
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 0 parameters
Schema command 
kosmo integrations:schema shipbob.shipbob_get_current_user --json
ParameterTypeRequiredDescription
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.