ecommerce
ShipBob CLI for CI
Use the ShipBob CLI for CI with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 6 read 1 write Bearer token auth
ShipBob CLI for CI
Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status.
Use this shape when a pipeline needs to read or update an external service. The ShipBob CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# ShipBob CLI for CI
kosmokrator integrations:configure shipbob --set access_token="$SHIPBOB_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmo integrations:call shipbob.shipbob_list_orders '{"page":1,"limit":1,"status":"example_status"}' --json Discovery Before Execution
Agents and scripts can inspect ShipBob docs and schemas 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 Useful ShipBob CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
shipbob.shipbob_list_orders | Read | page, limit, status | List fulfillment orders from ShipBob. Supports pagination and filtering by status (e.g. pending, fulfilled, cancelled). |
shipbob.shipbob_get_order | Read | id | Get details for a specific ShipBob order by ID, including line items, shipping address, and fulfillment status. |
shipbob.shipbob_create_order | Write | receiving_note, products, shipping_method | Create a new fulfillment order in ShipBob. Provide product line items, a receiving note, and an optional shipping method. |
shipbob.shipbob_list_products | Read | page, limit | List products in your ShipBob inventory. Supports pagination with page and limit parameters. |
shipbob.shipbob_get_product | Read | id | Get details for a specific ShipBob product by ID, including SKU, inventory levels, and fulfillment info. |
shipbob.shipbob_list_shipments | Read | page, limit | List shipments from ShipBob. Supports pagination with page and limit parameters. |
shipbob.shipbob_get_current_user | Read | none | Get the currently authenticated ShipBob user profile. Useful for verifying connectivity and account details. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.