Can I use Shippo as a CLI?

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

Can I expose Shippo through MCP?

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

Where are Shippo credentials stored?

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

Can I deny write access for Shippo MCP tools?

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

data

Shippo CLI for AI Agents

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

Shippo CLI Setup

Shippo can be configured headlessly with `kosmokrator integrations:configure shippo`.

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 shippo --enable --read allow --write ask --json
kosmokrator integrations:doctor shippo --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

No credentials are required.

Command Patterns

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

Generic CLI call

kosmo integrations:call shippo.shippo_list_addresses '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Provider shortcut

kosmo integrations:shippo shippo_list_addresses '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Discovery

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

Discovery commands

kosmo integrations:docs shippo --json
kosmo integrations:docs shippo.shippo_list_addresses --json
kosmo integrations:schema shippo.shippo_list_addresses --json
kosmo integrations:search "Shippo" --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.

`shippo.shippo_list_addresses`

List all addresses Official Shippo endpoint: GET /addresses.

Read read

Parameters: page, results, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_addresses '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_addresses '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_address`

Create a new address Official Shippo endpoint: POST /addresses.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_address '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_address '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_address`

Retrieve an address Official Shippo endpoint: GET /addresses/{AddressId}.

Read read

Parameters: address_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_address '{"address_id":"example_address_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_address '{"address_id":"example_address_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_validate_address`

Validate an address Official Shippo endpoint: GET /addresses/{AddressId}/validate.

Read read

Parameters: address_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_validate_address '{"address_id":"example_address_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_validate_address '{"address_id":"example_address_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_batch`

Create a batch Official Shippo endpoint: POST /batches.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_batch '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_batch '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_batch`

Retrieve a batch Official Shippo endpoint: GET /batches/{BatchId}.

Read read

Parameters: batch_id, page, results, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_batch '{"batch_id":"example_batch_id","page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_batch '{"batch_id":"example_batch_id","page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_add_shipments_to_batch`

Add shipments to a batch Official Shippo endpoint: POST /batches/{BatchId}/add_shipments.

Write write

Parameters: batch_id, shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_add_shipments_to_batch '{"batch_id":"example_batch_id","shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_add_shipments_to_batch '{"batch_id":"example_batch_id","shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_purchase_batch`

Purchase a batch Official Shippo endpoint: POST /batches/{BatchId}/purchase.

Read read

Parameters: batch_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_purchase_batch '{"batch_id":"example_batch_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_purchase_batch '{"batch_id":"example_batch_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_remove_shipments_from_batch`

Remove shipments from a batch Official Shippo endpoint: POST /batches/{BatchId}/remove_shipments.

Write write

Parameters: batch_id, shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_remove_shipments_from_batch '{"batch_id":"example_batch_id","shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_remove_shipments_from_batch '{"batch_id":"example_batch_id","shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_list_carrier_accounts`

List all carrier accounts Official Shippo endpoint: GET /carrier_accounts.

Read read

Parameters: service_levels, carrier, account_id, page, results, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_carrier_accounts '{"service_levels":true,"carrier":"example_carrier","account_id":"example_account_id","page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_carrier_accounts '{"service_levels":true,"carrier":"example_carrier","account_id":"example_account_id","page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_carrier_account`

Create a new carrier account Official Shippo endpoint: POST /carrier_accounts.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_carrier_account '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_carrier_account '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_carrier_account`

Retrieve a carrier account Official Shippo endpoint: GET /carrier_accounts/{CarrierAccountId}.

Read read

Parameters: carrier_account_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_carrier_account '{"carrier_account_id":"example_carrier_account_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_carrier_account '{"carrier_account_id":"example_carrier_account_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_update_carrier_account`

Update a carrier account Official Shippo endpoint: PUT /carrier_accounts/{CarrierAccountId}.

Write write

Parameters: carrier_account_id, shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_update_carrier_account '{"carrier_account_id":"example_carrier_account_id","shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_update_carrier_account '{"carrier_account_id":"example_carrier_account_id","shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_initiate_oauth2_signin`

Connect an existing carrier account using OAuth 2.0 Official Shippo endpoint: GET /carrier_accounts/{CarrierAccountObjectId}/signin/initiate.

Read read

Parameters: carrier_account_object_id, redirect_uri, state, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_initiate_oauth2_signin '{"carrier_account_object_id":"example_carrier_account_object_id","redirect_uri":"example_redirect_uri","state":"example_state","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_initiate_oauth2_signin '{"carrier_account_object_id":"example_carrier_account_object_id","redirect_uri":"example_redirect_uri","state":"example_state","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_register_carrier_account`

Add a Shippo carrier account Official Shippo endpoint: POST /carrier_accounts/register/new.

Read read

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_register_carrier_account '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_register_carrier_account '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_carrier_registration_status`

Get Carrier Registration status Official Shippo endpoint: GET /carrier_accounts/reg-status.

Read read

Parameters: carrier, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_carrier_registration_status '{"carrier":"example_carrier","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_carrier_registration_status '{"carrier":"example_carrier","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_customs_declarations`

List all customs declarations Official Shippo endpoint: GET /customs/declarations.

Read read

Parameters: page, results, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_customs_declarations '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_customs_declarations '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_customs_declaration`

Create a new customs declaration Official Shippo endpoint: POST /customs/declarations.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_customs_declaration '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_customs_declaration '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_customs_declaration`

Retrieve a customs declaration Official Shippo endpoint: GET /customs/declarations/{CustomsDeclarationId}.

Read read

Parameters: customs_declaration_id, page, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_customs_declaration '{"customs_declaration_id":"example_customs_declaration_id","page":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_customs_declaration '{"customs_declaration_id":"example_customs_declaration_id","page":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_customs_items`

List all customs items Official Shippo endpoint: GET /customs/items.

Read read

Parameters: page, results, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_customs_items '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_customs_items '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_customs_item`

Create a new customs item Official Shippo endpoint: POST /customs/items.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_customs_item '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_customs_item '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_customs_item`

Retrieve a customs item Official Shippo endpoint: GET /customs/items/{CustomsItemId}.

Read read

Parameters: customs_item_id, page, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_customs_item '{"customs_item_id":"example_customs_item_id","page":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_customs_item '{"customs_item_id":"example_customs_item_id","page":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_live_rate`

Generate a live rates request Official Shippo endpoint: POST /live-rates.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_live_rate '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_live_rate '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_default_parcel_template`

Show current default parcel template Official Shippo endpoint: GET /live-rates/settings/parcel-template.

Read read

Parameters: shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_default_parcel_template '{"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_default_parcel_template '{"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_update_default_parcel_template`

Update default parcel template Official Shippo endpoint: PUT /live-rates/settings/parcel-template.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_update_default_parcel_template '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_update_default_parcel_template '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_delete_default_parcel_template`

Clear current default parcel template Official Shippo endpoint: DELETE /live-rates/settings/parcel-template.

Write write

Parameters: shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_delete_default_parcel_template '{"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_delete_default_parcel_template '{"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_manifests`

List all manifests Official Shippo endpoint: GET /manifests.

Read read

Parameters: page, results, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_manifests '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_manifests '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_manifest`

Create a new manifest Official Shippo endpoint: POST /manifests.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_manifest '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_manifest '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_manifest`

Retrieve a manifest Official Shippo endpoint: GET /manifests/{ManifestId}.

Read read

Parameters: manifest_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_manifest '{"manifest_id":"example_manifest_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_manifest '{"manifest_id":"example_manifest_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_orders`

List all orders Official Shippo endpoint: GET /orders.

Read read

Parameters: page, results, shippo_api_version, order_status, shop_app, start_date, end_date

Generic call

kosmo integrations:call shippo.shippo_list_orders '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version","order_status":"example_order_status","shop_app":"example_shop_app","start_date":"example_start_date","end_date":"example_end_date"}' --json

Shortcut

kosmo integrations:shippo shippo_list_orders '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version","order_status":"example_order_status","shop_app":"example_shop_app","start_date":"example_start_date","end_date":"example_end_date"}' --json

`shippo.shippo_create_order`

Create a new order Official Shippo endpoint: POST /orders.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_order '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_order '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_order`

Retrieve an order Official Shippo endpoint: GET /orders/{OrderId}.

Read read

Parameters: order_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_order '{"order_id":"example_order_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_order '{"order_id":"example_order_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_carrier_parcel_templates`

List all carrier parcel templates Official Shippo endpoint: GET /parcel-templates.

Read read

Parameters: include, carrier, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_carrier_parcel_templates '{"include":"example_include","carrier":"example_carrier","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_carrier_parcel_templates '{"include":"example_include","carrier":"example_carrier","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_get_carrier_parcel_template`

Retrieve a carrier parcel templates Official Shippo endpoint: GET /parcel-templates/{CarrierParcelTemplateToken}.

Read read

Parameters: carrier_parcel_template_token, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_carrier_parcel_template '{"carrier_parcel_template_token":"example_carrier_parcel_template_token","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_carrier_parcel_template '{"carrier_parcel_template_token":"example_carrier_parcel_template_token","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_parcels`

List all parcels Official Shippo endpoint: GET /parcels.

Read read

Parameters: page, results, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_parcels '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_parcels '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_parcel`

Create a new parcel Official Shippo endpoint: POST /parcels.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_parcel '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_parcel '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_parcel`

Retrieve an existing parcel Official Shippo endpoint: GET /parcels/{ParcelId}.

Read read

Parameters: parcel_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_parcel '{"parcel_id":"example_parcel_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_parcel '{"parcel_id":"example_parcel_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_pickup`

Create a pickup Official Shippo endpoint: POST /pickups.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_pickup '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_pickup '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_rate`

Retrieve a rate Official Shippo endpoint: GET /rates/{RateId}.

Read read

Parameters: rate_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_rate '{"rate_id":"example_rate_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_rate '{"rate_id":"example_rate_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_refund`

Create a refund Official Shippo endpoint: POST /refunds.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_refund '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_refund '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_list_refunds`

List all refunds Official Shippo endpoint: GET /refunds/.

Read read

Parameters: shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_refunds '{"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_refunds '{"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_get_refund`

Retrieve a refund Official Shippo endpoint: GET /refunds/{RefundId}.

Read read

Parameters: refund_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_refund '{"refund_id":"example_refund_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_refund '{"refund_id":"example_refund_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_service_groups`

List all service groups Official Shippo endpoint: GET /service-groups.

Read read

Parameters: shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_service_groups '{"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_service_groups '{"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_service_group`

Create a new service group Official Shippo endpoint: POST /service-groups.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_service_group '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_service_group '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_update_service_group`

Update an existing service group Official Shippo endpoint: PUT /service-groups.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_update_service_group '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_update_service_group '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_delete_service_group`

Delete a service group Official Shippo endpoint: DELETE /service-groups/{ServiceGroupId}.

Write write

Parameters: service_group_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_delete_service_group '{"service_group_id":"example_service_group_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_delete_service_group '{"service_group_id":"example_service_group_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_shipments`

List all shipments Official Shippo endpoint: GET /shipments.

Read read

Parameters: page_token, page, results, object_created_gt, object_created_gte, object_created_lt, object_created_lte, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_shipments '{"page_token":"example_page_token","page":1,"results":1,"object_created_gt":"example_object_created_gt","object_created_gte":"example_object_created_gte","object_created_lt":"example_object_created_lt","object_created_lte":"example_object_created_lte","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_shipments '{"page_token":"example_page_token","page":1,"results":1,"object_created_gt":"example_object_created_gt","object_created_gte":"example_object_created_gte","object_created_lt":"example_object_created_lt","object_created_lte":"example_object_created_lte","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_shipment`

Create a new shipment Official Shippo endpoint: POST /shipments.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_shipment '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_shipment '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_shipment`

Retrieve a shipment Official Shippo endpoint: GET /shipments/{ShipmentId}.

Read read

Parameters: shipment_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_shipment '{"shipment_id":"example_shipment_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_shipment '{"shipment_id":"example_shipment_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_shipment_rates`

Retrieve shipment rates Official Shippo endpoint: GET /shipments/{ShipmentId}/rates.

Read read

Parameters: shipment_id, page, results, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_shipment_rates '{"shipment_id":"example_shipment_id","page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_shipment_rates '{"shipment_id":"example_shipment_id","page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_shipment_rates_by_currency_code`

Retrieve shipment rates in currency Official Shippo endpoint: GET /shipments/{ShipmentId}/rates/{CurrencyCode}.

Read read

Parameters: shipment_id, currency_code, page, results, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_shipment_rates_by_currency_code '{"shipment_id":"example_shipment_id","currency_code":"example_currency_code","page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_shipment_rates_by_currency_code '{"shipment_id":"example_shipment_id","currency_code":"example_currency_code","page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_track`

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_track '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_track '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_track`

Get a tracking status Official Shippo endpoint: GET /tracks/{Carrier}/{TrackingNumber}.

Read read

Parameters: tracking_number, carrier, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_track '{"tracking_number":"example_tracking_number","carrier":"example_carrier","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_track '{"tracking_number":"example_tracking_number","carrier":"example_carrier","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_transactions`

List all shipping labels Official Shippo endpoint: GET /transactions.

Read read

Parameters: rate, object_status, tracking_status, page, results, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_transactions '{"rate":"example_rate","object_status":"example_object_status","tracking_status":"example_tracking_status","page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_transactions '{"rate":"example_rate","object_status":"example_object_status","tracking_status":"example_tracking_status","page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_transaction`

Create a shipping label Official Shippo endpoint: POST /transactions.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_transaction '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_transaction '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_transaction`

Retrieve a shipping label Official Shippo endpoint: GET /transactions/{TransactionId}.

Read read

Parameters: transaction_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_transaction '{"transaction_id":"example_transaction_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_transaction '{"transaction_id":"example_transaction_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_list_user_parcel_templates`

List all user parcel templates Official Shippo endpoint: GET /user-parcel-templates.

Read read

Parameters: shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_user_parcel_templates '{"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_user_parcel_templates '{"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_user_parcel_template`

Create a new user parcel template Official Shippo endpoint: POST /user-parcel-templates.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_user_parcel_template '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_user_parcel_template '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_delete_user_parcel_template`

Delete a user parcel template Official Shippo endpoint: DELETE /user-parcel-templates/{UserParcelTemplateObjectId}.

Write write

Parameters: user_parcel_template_object_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_delete_user_parcel_template '{"user_parcel_template_object_id":"example_user_parcel_template_object_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_delete_user_parcel_template '{"user_parcel_template_object_id":"example_user_parcel_template_object_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_get_user_parcel_template`

Retrieves a user parcel template Official Shippo endpoint: GET /user-parcel-templates/{UserParcelTemplateObjectId}.

Read read

Parameters: user_parcel_template_object_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_user_parcel_template '{"user_parcel_template_object_id":"example_user_parcel_template_object_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_user_parcel_template '{"user_parcel_template_object_id":"example_user_parcel_template_object_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_update_user_parcel_template`

Update an existing user parcel template Official Shippo endpoint: PUT /user-parcel-templates/{UserParcelTemplateObjectId}.

Write write

Parameters: user_parcel_template_object_id, shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_update_user_parcel_template '{"user_parcel_template_object_id":"example_user_parcel_template_object_id","shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_update_user_parcel_template '{"user_parcel_template_object_id":"example_user_parcel_template_object_id","shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_list_shippo_accounts`

List all Shippo Accounts Official Shippo endpoint: GET /shippo-accounts.

Read read

Parameters: page, results, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_list_shippo_accounts '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_list_shippo_accounts '{"page":1,"results":1,"shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_create_shippo_account`

Create a Shippo Account Official Shippo endpoint: POST /shippo-accounts.

Write write

Parameters: shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_create_shippo_account '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_shippo_account '{"shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_get_shippo_account`

Retrieve a Shippo Account Official Shippo endpoint: GET /shippo-accounts/{ShippoAccountId}.

Read read

Parameters: shippo_account_id, shippo_api_version

Generic call

kosmo integrations:call shippo.shippo_get_shippo_account '{"shippo_account_id":"example_shippo_account_id","shippo_api_version":"example_shippo_api_version"}' --json

Shortcut

kosmo integrations:shippo shippo_get_shippo_account '{"shippo_account_id":"example_shippo_account_id","shippo_api_version":"example_shippo_api_version"}' --json

`shippo.shippo_update_shippo_account`

Update a Shippo Account Official Shippo endpoint: PUT /shippo-accounts/{ShippoAccountId}.

Write write

Parameters: shippo_account_id, shippo_api_version, body

Generic call

kosmo integrations:call shippo.shippo_update_shippo_account '{"shippo_account_id":"example_shippo_account_id","shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_update_shippo_account '{"shippo_account_id":"example_shippo_account_id","shippo_api_version":"example_shippo_api_version","body":"example_body"}' --json

`shippo.shippo_create_webhook`

Create a new webhook Official Shippo endpoint: POST /webhooks.

Write write

Parameters: body

Generic call

kosmo integrations:call shippo.shippo_create_webhook '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_create_webhook '{"body":"example_body"}' --json

`shippo.shippo_list_webhooks`

List all webhooks Official Shippo endpoint: GET /webhooks.

Read read

Parameters: none

Generic call

kosmo integrations:call shippo.shippo_list_webhooks '{}' --json

Shortcut

kosmo integrations:shippo shippo_list_webhooks '{}' --json

`shippo.shippo_get_webhook`

Retrieve a specific webhook Official Shippo endpoint: GET /webhooks/{webhookId}.

Read read

Parameters: webhook_id

Generic call

kosmo integrations:call shippo.shippo_get_webhook '{"webhook_id":"example_webhook_id"}' --json

Shortcut

kosmo integrations:shippo shippo_get_webhook '{"webhook_id":"example_webhook_id"}' --json

`shippo.shippo_update_webhook`

Update an existing webhook Official Shippo endpoint: PUT /webhooks/{webhookId}.

Write write

Parameters: webhook_id, body

Generic call

kosmo integrations:call shippo.shippo_update_webhook '{"webhook_id":"example_webhook_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shippo shippo_update_webhook '{"webhook_id":"example_webhook_id","body":"example_body"}' --json

`shippo.shippo_delete_webhook`

Delete a specific webhook Official Shippo endpoint: DELETE /webhooks/{webhookId}.

Write write

Parameters: webhook_id

Generic call

kosmo integrations:call shippo.shippo_delete_webhook '{"webhook_id":"example_webhook_id"}' --json

Shortcut

kosmo integrations:shippo shippo_delete_webhook '{"webhook_id":"example_webhook_id"}' --json

Function Schemas

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

shippo.shippo_list_addresses 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_addresses --json

Parameter	Type	Required	Description
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100, default 5)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_address 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_address --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Address details.

shippo.shippo_get_address 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_address --json

Parameter	Type	Required	Description
`address_id`	string	yes	Object ID of the address
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_validate_address 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_validate_address --json

Parameter	Type	Required	Description
`address_id`	string	yes	Object ID of the address
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_batch 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_batch --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Batch details.

shippo.shippo_get_batch 4 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_batch --json

Parameter	Type	Required	Description
`batch_id`	string	yes	Object ID of the batch
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100, default 5)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_add_shipments_to_batch 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_add_shipments_to_batch --json

Parameter	Type	Required	Description
`batch_id`	string	yes	Object ID of the batch
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Array of shipments to add to the batch

shippo.shippo_purchase_batch 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_purchase_batch --json

Parameter	Type	Required	Description
`batch_id`	string	yes	Object ID of the batch
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_remove_shipments_from_batch 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_remove_shipments_from_batch --json

Parameter	Type	Required	Description
`batch_id`	string	yes	Object ID of the batch
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Array of shipments object ids to remove from the batch

shippo.shippo_list_carrier_accounts 6 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_carrier_accounts --json

Parameter	Type	Required	Description
`service_levels`	boolean	no	Appends the property `service_levels` to each returned carrier account
`carrier`	string	no	Filter the response by the specified carrier
`account_id`	string	no	Filter the response by the specified carrier account Id
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100, default 5)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_carrier_account 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_carrier_account --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Examples.

shippo.shippo_get_carrier_account 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_carrier_account --json

Parameter	Type	Required	Description
`carrier_account_id`	string	yes	Object ID of the carrier account
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_update_carrier_account 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_update_carrier_account --json

Parameter	Type	Required	Description
`carrier_account_id`	string	yes	Object ID of the carrier account
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	no	Examples.

shippo.shippo_initiate_oauth2_signin 4 parameters

Schema command

kosmo integrations:schema shippo.shippo_initiate_oauth2_signin --json

Parameter	Type	Required	Description
`carrier_account_object_id`	string	yes	The carrier account ID (UUID) to start a signin process.
`redirect_uri`	string	yes	Callback URL. The URL that tells the authorization server where to send the user back to after they approve the request.
`state`	string	no	A random string generated by the consuming application and included in the request to prevent CSRF attacks. The consuming application checks that the same value is returned after the user authorizes Shippo.
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_register_carrier_account 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_register_carrier_account --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	The body of the request.

shippo.shippo_get_carrier_registration_status 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_carrier_registration_status --json

Parameter	Type	Required	Description
`carrier`	string	yes	filter by specific carrier
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_customs_declarations 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_customs_declarations --json

Parameter	Type	Required	Description
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100, default 5)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_customs_declaration 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_customs_declaration --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	CustomsDeclaration details.

shippo.shippo_get_customs_declaration 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_customs_declaration --json

Parameter	Type	Required	Description
`customs_declaration_id`	string	yes	Object ID of the customs declaration
`page`	integer	no	The page number you want to select
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_customs_items 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_customs_items --json

Parameter	Type	Required	Description
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_customs_item 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_customs_item --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	CustomsItem details.

shippo.shippo_get_customs_item 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_customs_item --json

Parameter	Type	Required	Description
`customs_item_id`	string	yes	Object ID of the customs item
`page`	integer	no	The page number you want to select
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_live_rate 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_live_rate --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Generate rates at checkout

shippo.shippo_get_default_parcel_template 1 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_default_parcel_template --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_update_default_parcel_template 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_update_default_parcel_template --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	no	JSON request body matching the official Shippo schema for Update default parcel template.

shippo.shippo_delete_default_parcel_template 1 parameters

Schema command

kosmo integrations:schema shippo.shippo_delete_default_parcel_template --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_manifests 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_manifests --json

Parameter	Type	Required	Description
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100, default 5)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_manifest 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_manifest --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Manifest details and contact info.

shippo.shippo_get_manifest 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_manifest --json

Parameter	Type	Required	Description
`manifest_id`	string	yes	Object ID of the manifest to update
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_orders 7 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_orders --json

Parameter	Type	Required	Description
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`order_status`	array	no	Filter orders by order status
`shop_app`	string	no	Filter orders by shop app
`start_date`	string	no	Filter orders created after the input date and time (ISO 8601 UTC format). This is based on the `placed_at` field, meaning when the order has been placed, not when the order object was created.
`end_date`	string	no	Filter orders created before the input date and time (ISO 8601 UTC format). This is based on the `placed_at` field, meaning when the order has been placed, not when the order object was created.

shippo.shippo_create_order 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_order --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Order details.

shippo.shippo_get_order 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_order --json

Parameter	Type	Required	Description
`order_id`	string	yes	Object ID of the order
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_carrier_parcel_templates 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_carrier_parcel_templates --json

Parameter	Type	Required	Description
`include`	string	no	filter by user or enabled
`carrier`	string	no	filter by specific carrier
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_get_carrier_parcel_template 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_carrier_parcel_template --json

Parameter	Type	Required	Description
`carrier_parcel_template_token`	string	yes	The unique string representation of the carrier parcel template
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_parcels 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_parcels --json

Parameter	Type	Required	Description
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_parcel 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_parcel --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Parcel details.

shippo.shippo_get_parcel 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_parcel --json

Parameter	Type	Required	Description
`parcel_id`	string	yes	Object ID of the parcel
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_pickup 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_pickup --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Shippos pickups endpoint allows you to schedule pickups with USPS and DHL Express for eligible shipments that you have already created.

shippo.shippo_get_rate 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_rate --json

Parameter	Type	Required	Description
`rate_id`	string	yes	Object ID of the rate
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_refund 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_refund --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Refund details

shippo.shippo_list_refunds 1 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_refunds --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_get_refund 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_refund --json

Parameter	Type	Required	Description
`refund_id`	string	yes	Object ID of the refund to update
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_service_groups 1 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_service_groups --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_service_group 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_service_group --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	JSON request body matching the official Shippo schema for Create a new service group.

shippo.shippo_update_service_group 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_update_service_group --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	no	JSON request body matching the official Shippo schema for Update an existing service group.

shippo.shippo_delete_service_group 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_delete_service_group --json

Parameter	Type	Required	Description
`service_group_id`	string	yes	Object ID of the service group
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_shipments 8 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_shipments --json

Parameter	Type	Required	Description
`page_token`	string	no	The page token for paginated results
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100)
`object_created_gt`	string	no	Object(s) created greater than a provided date and time.
`object_created_gte`	string	no	Object(s) created greater than or equal to a provided date and time.
`object_created_lt`	string	no	Object(s) created lesser than a provided date and time.
`object_created_lte`	string	no	Object(s) created lesser than or equal to a provided date and time.
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_shipment 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_shipment --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Shipment details and contact info.

shippo.shippo_get_shipment 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_shipment --json

Parameter	Type	Required	Description
`shipment_id`	string	yes	Object ID of the shipment to update
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_shipment_rates 4 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_shipment_rates --json

Parameter	Type	Required	Description
`shipment_id`	string	yes	Object ID of the shipment to update
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_shipment_rates_by_currency_code 5 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_shipment_rates_by_currency_code --json

Parameter	Type	Required	Description
`shipment_id`	string	yes	Object ID of the shipment to update
`currency_code`	string	yes	ISO currency code for the rates
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_track 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_track --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	JSON request body matching the official Shippo schema for Register a tracking webhook.

shippo.shippo_get_track 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_track --json

Parameter	Type	Required	Description
`tracking_number`	string	yes	Tracking number
`carrier`	string	yes	Name of the carrier
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_transactions 6 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_transactions --json

Parameter	Type	Required	Description
`rate`	string	no	Filter by rate ID
`object_status`	string	no	Filter by object status
`tracking_status`	string	no	Filter by tracking status
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_transaction 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_transaction --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	Examples.

shippo.shippo_get_transaction 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_transaction --json

Parameter	Type	Required	Description
`transaction_id`	string	yes	Object ID of the transaction to update
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_list_user_parcel_templates 1 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_user_parcel_templates --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_user_parcel_template 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_user_parcel_template --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	JSON request body matching the official Shippo schema for Create a new user parcel template.

shippo.shippo_delete_user_parcel_template 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_delete_user_parcel_template --json

Parameter	Type	Required	Description
`user_parcel_template_object_id`	string	yes	Object ID of the user parcel template
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_get_user_parcel_template 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_user_parcel_template --json

Parameter	Type	Required	Description
`user_parcel_template_object_id`	string	yes	Object ID of the user parcel template
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_update_user_parcel_template 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_update_user_parcel_template --json

Parameter	Type	Required	Description
`user_parcel_template_object_id`	string	yes	Object ID of the user parcel template
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	no	JSON request body matching the official Shippo schema for Update an existing user parcel template.

shippo.shippo_list_shippo_accounts 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_shippo_accounts --json

Parameter	Type	Required	Description
`page`	integer	no	The page number you want to select
`results`	integer	no	The number of results to return per page (max 100)
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_create_shippo_account 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_shippo_account --json

Parameter	Type	Required	Description
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	yes	JSON request body matching the official Shippo schema for Create a Shippo Account.

shippo.shippo_get_shippo_account 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_shippo_account --json

Parameter	Type	Required	Description
`shippo_account_id`	string	yes	Object ID of the ShippoAccount
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.

shippo.shippo_update_shippo_account 3 parameters

Schema command

kosmo integrations:schema shippo.shippo_update_shippo_account --json

Parameter	Type	Required	Description
`shippo_account_id`	string	yes	Object ID of the ShippoAccount
`shippo_api_version`	string	no	Optional string used to pick a non-default API version to use. See our API version guide.
`body`	object	no	JSON request body matching the official Shippo schema for Update a Shippo Account.

shippo.shippo_create_webhook 1 parameters

Schema command

kosmo integrations:schema shippo.shippo_create_webhook --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official Shippo schema for Create a new webhook.

shippo.shippo_list_webhooks 0 parameters

Schema command

kosmo integrations:schema shippo.shippo_list_webhooks --json

Parameter	Type	Required	Description
No parameters.

shippo.shippo_get_webhook 1 parameters

Schema command

kosmo integrations:schema shippo.shippo_get_webhook --json

Parameter	Type	Required	Description
`webhook_id`	string	yes	Object ID of the webhook to retrieve

shippo.shippo_update_webhook 2 parameters

Schema command

kosmo integrations:schema shippo.shippo_update_webhook --json

Parameter	Type	Required	Description
`webhook_id`	string	yes	Object ID of the webhook to retrieve
`body`	object	yes	JSON request body matching the official Shippo schema for Update an existing webhook.

shippo.shippo_delete_webhook 1 parameters

Schema command

kosmo integrations:schema shippo.shippo_delete_webhook --json

Parameter	Type	Required	Description
`webhook_id`	string	yes	Object ID of the webhook to delete

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.