Can I use ShipEngine as a CLI?

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

Can I expose ShipEngine through MCP?

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

Where are ShipEngine credentials stored?

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

Can I deny write access for ShipEngine MCP tools?

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

data

ShipEngine CLI for AI Agents

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

ShipEngine CLI Setup

ShipEngine can be configured headlessly with `kosmokrator integrations:configure shipengine`.

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 shipengine --enable --read allow --write ask --json
kosmokrator integrations:doctor shipengine --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 shipengine.shipengine_list_account_settings '{}' --json

Provider shortcut

kosmo integrations:shipengine shipengine_list_account_settings '{}' --json

Discovery

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

Discovery commands

kosmo integrations:docs shipengine --json
kosmo integrations:docs shipengine.shipengine_list_account_settings --json
kosmo integrations:schema shipengine.shipengine_list_account_settings --json
kosmo integrations:search "ShipEngine" --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.

`shipengine.shipengine_list_account_settings`

List Account Settings Official ShipEngine endpoint: GET /v1/account/settings.

Read read

Parameters: none

Generic call

kosmo integrations:call shipengine.shipengine_list_account_settings '{}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_account_settings '{}' --json

`shipengine.shipengine_list_account_images`

List Account Images Official ShipEngine endpoint: GET /v1/account/settings/images.

Read read

Parameters: none

Generic call

kosmo integrations:call shipengine.shipengine_list_account_images '{}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_account_images '{}' --json

`shipengine.shipengine_create_account_image`

Create an Account Image Official ShipEngine endpoint: POST /v1/account/settings/images.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_create_account_image '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_account_image '{"body":"example_body"}' --json

`shipengine.shipengine_get_account_settings_images_by_id`

Get Account Image By ID Official ShipEngine endpoint: GET /v1/account/settings/images/{label_image_id}.

Read read

Parameters: label_image_id

Generic call

kosmo integrations:call shipengine.shipengine_get_account_settings_images_by_id '{"label_image_id":"example_label_image_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_account_settings_images_by_id '{"label_image_id":"example_label_image_id"}' --json

`shipengine.shipengine_update_account_settings_images_by_id`

Update Account Image By ID Official ShipEngine endpoint: PUT /v1/account/settings/images/{label_image_id}.

Write write

Parameters: label_image_id, body

Generic call

kosmo integrations:call shipengine.shipengine_update_account_settings_images_by_id '{"label_image_id":"example_label_image_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_update_account_settings_images_by_id '{"label_image_id":"example_label_image_id","body":"example_body"}' --json

`shipengine.shipengine_delete_account_image_by_id`

Delete Account Image By Id Official ShipEngine endpoint: DELETE /v1/account/settings/images/{label_image_id}.

Write write

Parameters: label_image_id

Generic call

kosmo integrations:call shipengine.shipengine_delete_account_image_by_id '{"label_image_id":"example_label_image_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_delete_account_image_by_id '{"label_image_id":"example_label_image_id"}' --json

`shipengine.shipengine_parse_address`

Parse an address Official ShipEngine endpoint: PUT /v1/addresses/recognize.

Read read

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_parse_address '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_parse_address '{"body":"example_body"}' --json

`shipengine.shipengine_validate_address`

Validate An Address Official ShipEngine endpoint: POST /v1/addresses/validate.

Read read

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_validate_address '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_validate_address '{"body":"example_body"}' --json

`shipengine.shipengine_list_batches`

List Batches Official ShipEngine endpoint: GET /v1/batches.

Read read

Parameters: status, page, page_size, sort_dir, batch_number, created_at_start, created_at_end, processed_at_start, processed_at_end, sort_by

Generic call

kosmo integrations:call shipengine.shipengine_list_batches '{"status":"example_status","page":1,"page_size":1,"sort_dir":"example_sort_dir","batch_number":"example_batch_number","created_at_start":"example_created_at_start","created_at_end":"example_created_at_end","processed_at_start":"example_processed_at_start"}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_batches '{"status":"example_status","page":1,"page_size":1,"sort_dir":"example_sort_dir","batch_number":"example_batch_number","created_at_start":"example_created_at_start","created_at_end":"example_created_at_end","processed_at_start":"example_processed_at_start"}' --json

`shipengine.shipengine_create_batch`

Create A Batch Official ShipEngine endpoint: POST /v1/batches.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_create_batch '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_batch '{"body":"example_body"}' --json

`shipengine.shipengine_get_batch_by_external_id`

Get Batch By External ID Official ShipEngine endpoint: GET /v1/batches/external_batch_id/{external_batch_id}.

Read read

Parameters: external_batch_id

Generic call

kosmo integrations:call shipengine.shipengine_get_batch_by_external_id '{"external_batch_id":"example_external_batch_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_batch_by_external_id '{"external_batch_id":"example_external_batch_id"}' --json

`shipengine.shipengine_delete_batch`

Delete Batch By Id Official ShipEngine endpoint: DELETE /v1/batches/{batch_id}.

Write write

Parameters: batch_id

Generic call

kosmo integrations:call shipengine.shipengine_delete_batch '{"batch_id":"example_batch_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_delete_batch '{"batch_id":"example_batch_id"}' --json

`shipengine.shipengine_get_batch_by_id`

Get Batch By ID Official ShipEngine endpoint: GET /v1/batches/{batch_id}.

Read read

Parameters: batch_id

Generic call

kosmo integrations:call shipengine.shipengine_get_batch_by_id '{"batch_id":"example_batch_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_batch_by_id '{"batch_id":"example_batch_id"}' --json

`shipengine.shipengine_update_batch`

Update Batch By Id Official ShipEngine endpoint: PUT /v1/batches/{batch_id}.

Write write

Parameters: batch_id

Generic call

kosmo integrations:call shipengine.shipengine_update_batch '{"batch_id":"example_batch_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_update_batch '{"batch_id":"example_batch_id"}' --json

`shipengine.shipengine_add_to_batch`

Add to a Batch Official ShipEngine endpoint: POST /v1/batches/{batch_id}/add.

Write write

Parameters: batch_id, body

Generic call

kosmo integrations:call shipengine.shipengine_add_to_batch '{"batch_id":"example_batch_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_add_to_batch '{"batch_id":"example_batch_id","body":"example_body"}' --json

`shipengine.shipengine_list_batch_errors`

Get Batch Errors Official ShipEngine endpoint: GET /v1/batches/{batch_id}/errors.

Read read

Parameters: batch_id, page, pagesize

Generic call

kosmo integrations:call shipengine.shipengine_list_batch_errors '{"batch_id":"example_batch_id","page":1,"pagesize":1}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_batch_errors '{"batch_id":"example_batch_id","page":1,"pagesize":1}' --json

`shipengine.shipengine_process_batch`

Process Batch ID Labels Official ShipEngine endpoint: POST /v1/batches/{batch_id}/process/labels.

Read read

Parameters: batch_id, body

Generic call

kosmo integrations:call shipengine.shipengine_process_batch '{"batch_id":"example_batch_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_process_batch '{"batch_id":"example_batch_id","body":"example_body"}' --json

`shipengine.shipengine_remove_from_batch`

Remove From Batch Official ShipEngine endpoint: POST /v1/batches/{batch_id}/remove.

Write write

Parameters: batch_id, body

Generic call

kosmo integrations:call shipengine.shipengine_remove_from_batch '{"batch_id":"example_batch_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_remove_from_batch '{"batch_id":"example_batch_id","body":"example_body"}' --json

`shipengine.shipengine_list_carriers`

List Carriers Official ShipEngine endpoint: GET /v1/carriers.

Read read

Parameters: none

Generic call

kosmo integrations:call shipengine.shipengine_list_carriers '{}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_carriers '{}' --json

`shipengine.shipengine_get_carrier_by_id`

Get Carrier By ID Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}.

Read read

Parameters: carrier_id

Generic call

kosmo integrations:call shipengine.shipengine_get_carrier_by_id '{"carrier_id":"example_carrier_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_carrier_by_id '{"carrier_id":"example_carrier_id"}' --json

`shipengine.shipengine_disconnect_carrier_by_id`

Disconnect Carrier by ID Official ShipEngine endpoint: DELETE /v1/carriers/{carrier_id}.

Read read

Parameters: carrier_id

Generic call

kosmo integrations:call shipengine.shipengine_disconnect_carrier_by_id '{"carrier_id":"example_carrier_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_disconnect_carrier_by_id '{"carrier_id":"example_carrier_id"}' --json

`shipengine.shipengine_add_funds_to_carrier`

Add Funds To Carrier Official ShipEngine endpoint: PUT /v1/carriers/{carrier_id}/add_funds.

Write write

Parameters: carrier_id, body

Generic call

kosmo integrations:call shipengine.shipengine_add_funds_to_carrier '{"carrier_id":"example_carrier_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_add_funds_to_carrier '{"carrier_id":"example_carrier_id","body":"example_body"}' --json

`shipengine.shipengine_get_carrier_options`

Get Carrier Options Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}/options.

Read read

Parameters: carrier_id

Generic call

kosmo integrations:call shipengine.shipengine_get_carrier_options '{"carrier_id":"example_carrier_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_carrier_options '{"carrier_id":"example_carrier_id"}' --json

`shipengine.shipengine_list_carrier_package_types`

List Carrier Package Types Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}/packages.

Read read

Parameters: carrier_id

Generic call

kosmo integrations:call shipengine.shipengine_list_carrier_package_types '{"carrier_id":"example_carrier_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_carrier_package_types '{"carrier_id":"example_carrier_id"}' --json

`shipengine.shipengine_list_carrier_services`

List Carrier Services Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}/services.

Read read

Parameters: carrier_id

Generic call

kosmo integrations:call shipengine.shipengine_list_carrier_services '{"carrier_id":"example_carrier_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_carrier_services '{"carrier_id":"example_carrier_id"}' --json

`shipengine.shipengine_connect_carrier`

Connect a carrier account Official ShipEngine endpoint: POST /v1/connections/carriers/{carrier_name}.

Read read

Parameters: carrier_name, body

Generic call

kosmo integrations:call shipengine.shipengine_connect_carrier '{"carrier_name":"example_carrier_name","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_connect_carrier '{"carrier_name":"example_carrier_name","body":"example_body"}' --json

`shipengine.shipengine_disconnect_carrier`

Disconnect a carrier Official ShipEngine endpoint: DELETE /v1/connections/carriers/{carrier_name}/{carrier_id}.

Read read

Parameters: carrier_name, carrier_id

Generic call

kosmo integrations:call shipengine.shipengine_disconnect_carrier '{"carrier_name":"example_carrier_name","carrier_id":"example_carrier_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_disconnect_carrier '{"carrier_name":"example_carrier_name","carrier_id":"example_carrier_id"}' --json

`shipengine.shipengine_get_carrier_settings`

Get carrier settings Official ShipEngine endpoint: GET /v1/connections/carriers/{carrier_name}/{carrier_id}/settings.

Read read

Parameters: carrier_name, carrier_id

Generic call

kosmo integrations:call shipengine.shipengine_get_carrier_settings '{"carrier_name":"example_carrier_name","carrier_id":"example_carrier_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_carrier_settings '{"carrier_name":"example_carrier_name","carrier_id":"example_carrier_id"}' --json

`shipengine.shipengine_update_carrier_settings`

Update carrier settings Official ShipEngine endpoint: PUT /v1/connections/carriers/{carrier_name}/{carrier_id}/settings.

Write write

Parameters: carrier_name, carrier_id, body

Generic call

kosmo integrations:call shipengine.shipengine_update_carrier_settings '{"carrier_name":"example_carrier_name","carrier_id":"example_carrier_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_update_carrier_settings '{"carrier_name":"example_carrier_name","carrier_id":"example_carrier_id","body":"example_body"}' --json

`shipengine.shipengine_disconnect_insurer`

Disconnect a Shipsurance Account Official ShipEngine endpoint: DELETE /v1/connections/insurance/shipsurance.

Read read

Parameters: none

Generic call

kosmo integrations:call shipengine.shipengine_disconnect_insurer '{}' --json

Shortcut

kosmo integrations:shipengine shipengine_disconnect_insurer '{}' --json

`shipengine.shipengine_connect_insurer`

Connect a Shipsurance Account Official ShipEngine endpoint: POST /v1/connections/insurance/shipsurance.

Read read

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_connect_insurer '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_connect_insurer '{"body":"example_body"}' --json

`shipengine.shipengine_create_combined_label_document`

Created Combined Label Document Official ShipEngine endpoint: POST /v1/documents/combined_labels.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_create_combined_label_document '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_combined_label_document '{"body":"example_body"}' --json

`shipengine.shipengine_download_file`

Download File Official ShipEngine endpoint: GET /v1/downloads/{dir}/{subdir}/{filename}.

Read read

Parameters: subdir, filename, dir, download, rotation

Generic call

kosmo integrations:call shipengine.shipengine_download_file '{"subdir":"example_subdir","filename":"example_filename","dir":"example_dir","download":"example_download","rotation":1}' --json

Shortcut

kosmo integrations:shipengine shipengine_download_file '{"subdir":"example_subdir","filename":"example_filename","dir":"example_dir","download":"example_download","rotation":1}' --json

`shipengine.shipengine_list_webhooks`

List Webhooks Official ShipEngine endpoint: GET /v1/environment/webhooks.

Read read

Parameters: none

Generic call

kosmo integrations:call shipengine.shipengine_list_webhooks '{}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_webhooks '{}' --json

`shipengine.shipengine_create_webhook`

Create a Webhook Official ShipEngine endpoint: POST /v1/environment/webhooks.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_create_webhook '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_webhook '{"body":"example_body"}' --json

`shipengine.shipengine_get_webhook_by_id`

Get Webhook By ID Official ShipEngine endpoint: GET /v1/environment/webhooks/{webhook_id}.

Read read

Parameters: webhook_id

Generic call

kosmo integrations:call shipengine.shipengine_get_webhook_by_id '{"webhook_id":"example_webhook_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_webhook_by_id '{"webhook_id":"example_webhook_id"}' --json

`shipengine.shipengine_update_webhook`

Update a Webhook Official ShipEngine endpoint: PUT /v1/environment/webhooks/{webhook_id}.

Write write

Parameters: webhook_id, body

Generic call

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

Shortcut

kosmo integrations:shipengine shipengine_update_webhook '{"webhook_id":"example_webhook_id","body":"example_body"}' --json

`shipengine.shipengine_delete_webhook`

Delete Webhook By ID Official ShipEngine endpoint: DELETE /v1/environment/webhooks/{webhook_id}.

Write write

Parameters: webhook_id

Generic call

kosmo integrations:call shipengine.shipengine_delete_webhook '{"webhook_id":"example_webhook_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_delete_webhook '{"webhook_id":"example_webhook_id"}' --json

`shipengine.shipengine_add_funds_to_insurance`

Add Funds To Insurance Official ShipEngine endpoint: PATCH /v1/insurance/shipsurance/add_funds.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_add_funds_to_insurance '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_add_funds_to_insurance '{"body":"example_body"}' --json

`shipengine.shipengine_get_insurance_balance`

Get Insurance Funds Balance Official ShipEngine endpoint: GET /v1/insurance/shipsurance/balance.

Read read

Parameters: none

Generic call

kosmo integrations:call shipengine.shipengine_get_insurance_balance '{}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_insurance_balance '{}' --json

`shipengine.shipengine_list_labels`

List labels Official ShipEngine endpoint: GET /v1/labels.

Read read

Parameters: label_status, service_code, carrier_id, tracking_number, batch_id, rate_id, shipment_id, warehouse_id, created_at_start, created_at_end, refund_status, page, page_size, sort_dir, sort_by

Generic call

kosmo integrations:call shipengine.shipengine_list_labels '{"label_status":"example_label_status","service_code":"example_service_code","carrier_id":"example_carrier_id","tracking_number":"example_tracking_number","batch_id":"example_batch_id","rate_id":"example_rate_id","shipment_id":"example_shipment_id","warehouse_id":"example_warehouse_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_labels '{"label_status":"example_label_status","service_code":"example_service_code","carrier_id":"example_carrier_id","tracking_number":"example_tracking_number","batch_id":"example_batch_id","rate_id":"example_rate_id","shipment_id":"example_shipment_id","warehouse_id":"example_warehouse_id"}' --json

`shipengine.shipengine_create_label`

Purchase Label Official ShipEngine endpoint: POST /v1/labels.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_create_label '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_label '{"body":"example_body"}' --json

`shipengine.shipengine_get_label_by_external_shipment_id`

Get Label By External Shipment ID Official ShipEngine endpoint: GET /v1/labels/external_shipment_id/{external_shipment_id}.

Read read

Parameters: external_shipment_id, label_download_type

Generic call

kosmo integrations:call shipengine.shipengine_get_label_by_external_shipment_id '{"external_shipment_id":"example_external_shipment_id","label_download_type":"example_label_download_type"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_label_by_external_shipment_id '{"external_shipment_id":"example_external_shipment_id","label_download_type":"example_label_download_type"}' --json

`shipengine.shipengine_create_label_from_rate`

Purchase Label with Rate ID Official ShipEngine endpoint: POST /v1/labels/rates/{rate_id}.

Write write

Parameters: rate_id, body

Generic call

kosmo integrations:call shipengine.shipengine_create_label_from_rate '{"rate_id":"example_rate_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_label_from_rate '{"rate_id":"example_rate_id","body":"example_body"}' --json

`shipengine.shipengine_create_label_from_rate_shopper`

Purchase Label from Rate Shopper Official ShipEngine endpoint: POST /v1/labels/rate_shopper_id/{rate_shopper_id}.

Write write

Parameters: rate_shopper_id, body

Generic call

kosmo integrations:call shipengine.shipengine_create_label_from_rate_shopper '{"rate_shopper_id":"example_rate_shopper_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_label_from_rate_shopper '{"rate_shopper_id":"example_rate_shopper_id","body":"example_body"}' --json

`shipengine.shipengine_create_label_from_shipment`

Purchase Label with Shipment ID Official ShipEngine endpoint: POST /v1/labels/shipment/{shipment_id}.

Write write

Parameters: shipment_id, body

Generic call

kosmo integrations:call shipengine.shipengine_create_label_from_shipment '{"shipment_id":"example_shipment_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_label_from_shipment '{"shipment_id":"example_shipment_id","body":"example_body"}' --json

`shipengine.shipengine_get_label_by_id`

Get Label By ID Official ShipEngine endpoint: GET /v1/labels/{label_id}.

Read read

Parameters: label_id, label_download_type

Generic call

kosmo integrations:call shipengine.shipengine_get_label_by_id '{"label_id":"example_label_id","label_download_type":"example_label_download_type"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_label_by_id '{"label_id":"example_label_id","label_download_type":"example_label_download_type"}' --json

`shipengine.shipengine_create_return_label`

Create a return label Official ShipEngine endpoint: POST /v1/labels/{label_id}/return.

Write write

Parameters: label_id, body

Generic call

kosmo integrations:call shipengine.shipengine_create_return_label '{"label_id":"example_label_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_return_label '{"label_id":"example_label_id","body":"example_body"}' --json

`shipengine.shipengine_get_tracking_log_from_label`

Get Label Tracking Information Official ShipEngine endpoint: GET /v1/labels/{label_id}/track.

Read read

Parameters: label_id

Generic call

kosmo integrations:call shipengine.shipengine_get_tracking_log_from_label '{"label_id":"example_label_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_tracking_log_from_label '{"label_id":"example_label_id"}' --json

`shipengine.shipengine_void_label`

Void a Label By ID Official ShipEngine endpoint: PUT /v1/labels/{label_id}/void.

Read read

Parameters: label_id

Generic call

kosmo integrations:call shipengine.shipengine_void_label '{"label_id":"example_label_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_void_label '{"label_id":"example_label_id"}' --json

`shipengine.shipengine_cancel_label_refund`

Cancel a label refund request Official ShipEngine endpoint: POST /v1/labels/{label_id}/cancel_refund.

Write write

Parameters: label_id

Generic call

kosmo integrations:call shipengine.shipengine_cancel_label_refund '{"label_id":"example_label_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_cancel_label_refund '{"label_id":"example_label_id"}' --json

`shipengine.shipengine_list_manifests`

List Manifests Official ShipEngine endpoint: GET /v1/manifests.

Read read

Parameters: warehouse_id, ship_date_start, ship_date_end, created_at_start, created_at_end, carrier_id, page, page_size, label_ids

Generic call

kosmo integrations:call shipengine.shipengine_list_manifests '{"warehouse_id":"example_warehouse_id","ship_date_start":"example_ship_date_start","ship_date_end":"example_ship_date_end","created_at_start":"example_created_at_start","created_at_end":"example_created_at_end","carrier_id":"example_carrier_id","page":1,"page_size":1}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_manifests '{"warehouse_id":"example_warehouse_id","ship_date_start":"example_ship_date_start","ship_date_end":"example_ship_date_end","created_at_start":"example_created_at_start","created_at_end":"example_created_at_end","carrier_id":"example_carrier_id","page":1,"page_size":1}' --json

`shipengine.shipengine_create_manifest`

Create Manifest Official ShipEngine endpoint: POST /v1/manifests.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_create_manifest '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_manifest '{"body":"example_body"}' --json

`shipengine.shipengine_get_manifest_by_id`

Get Manifest By Id Official ShipEngine endpoint: GET /v1/manifests/{manifest_id}.

Read read

Parameters: manifest_id

Generic call

kosmo integrations:call shipengine.shipengine_get_manifest_by_id '{"manifest_id":"example_manifest_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_manifest_by_id '{"manifest_id":"example_manifest_id"}' --json

`shipengine.shipengine_get_manifest_request_by_id`

Get Manifest Request By Id Official ShipEngine endpoint: GET /v1/manifests/requests/{manifest_request_id}.

Read read

Parameters: manifest_request_id

Generic call

kosmo integrations:call shipengine.shipengine_get_manifest_request_by_id '{"manifest_request_id":"example_manifest_request_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_manifest_request_by_id '{"manifest_request_id":"example_manifest_request_id"}' --json

`shipengine.shipengine_list_package_types`

List Custom Package Types Official ShipEngine endpoint: GET /v1/packages.

Read read

Parameters: none

Generic call

kosmo integrations:call shipengine.shipengine_list_package_types '{}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_package_types '{}' --json

`shipengine.shipengine_create_package_type`

Create Custom Package Type Official ShipEngine endpoint: POST /v1/packages.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_create_package_type '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_package_type '{"body":"example_body"}' --json

`shipengine.shipengine_get_package_type_by_id`

Get Custom Package Type By ID Official ShipEngine endpoint: GET /v1/packages/{package_id}.

Read read

Parameters: package_id

Generic call

kosmo integrations:call shipengine.shipengine_get_package_type_by_id '{"package_id":"example_package_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_package_type_by_id '{"package_id":"example_package_id"}' --json

`shipengine.shipengine_update_package_type`

Update Custom Package Type By ID Official ShipEngine endpoint: PUT /v1/packages/{package_id}.

Write write

Parameters: package_id, body

Generic call

kosmo integrations:call shipengine.shipengine_update_package_type '{"package_id":"example_package_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_update_package_type '{"package_id":"example_package_id","body":"example_body"}' --json

`shipengine.shipengine_delete_package_type`

Delete A Custom Package By ID Official ShipEngine endpoint: DELETE /v1/packages/{package_id}.

Write write

Parameters: package_id

Generic call

kosmo integrations:call shipengine.shipengine_delete_package_type '{"package_id":"example_package_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_delete_package_type '{"package_id":"example_package_id"}' --json

`shipengine.shipengine_list_scheduled_pickups`

List Scheduled Pickups Official ShipEngine endpoint: GET /v1/pickups.

Read read

Parameters: carrier_id, warehouse_id, created_at_start, created_at_end, page, page_size

Generic call

kosmo integrations:call shipengine.shipengine_list_scheduled_pickups '{"carrier_id":"example_carrier_id","warehouse_id":"example_warehouse_id","created_at_start":"example_created_at_start","created_at_end":"example_created_at_end","page":1,"page_size":1}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_scheduled_pickups '{"carrier_id":"example_carrier_id","warehouse_id":"example_warehouse_id","created_at_start":"example_created_at_start","created_at_end":"example_created_at_end","page":1,"page_size":1}' --json

`shipengine.shipengine_schedule_pickup`

Schedule a Pickup Official ShipEngine endpoint: POST /v1/pickups.

Read read

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_schedule_pickup '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_schedule_pickup '{"body":"example_body"}' --json

`shipengine.shipengine_get_pickup_by_id`

Get Pickup By ID Official ShipEngine endpoint: GET /v1/pickups/{pickup_id}.

Read read

Parameters: pickup_id

Generic call

kosmo integrations:call shipengine.shipengine_get_pickup_by_id '{"pickup_id":"example_pickup_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_pickup_by_id '{"pickup_id":"example_pickup_id"}' --json

`shipengine.shipengine_delete_scheduled_pickup`

Delete a Scheduled Pickup Official ShipEngine endpoint: DELETE /v1/pickups/{pickup_id}.

Write write

Parameters: pickup_id

Generic call

kosmo integrations:call shipengine.shipengine_delete_scheduled_pickup '{"pickup_id":"example_pickup_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_delete_scheduled_pickup '{"pickup_id":"example_pickup_id"}' --json

`shipengine.shipengine_calculate_rates`

Get Shipping Rates Official ShipEngine endpoint: POST /v1/rates.

Read read

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_calculate_rates '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_calculate_rates '{"body":"example_body"}' --json

`shipengine.shipengine_compare_bulk_rates`

Get Bulk Rates Official ShipEngine endpoint: POST /v1/rates/bulk.

Read read

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_compare_bulk_rates '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_compare_bulk_rates '{"body":"example_body"}' --json

`shipengine.shipengine_estimate_rates`

Estimate Rates Official ShipEngine endpoint: POST /v1/rates/estimate.

Read read

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_estimate_rates '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_estimate_rates '{"body":"example_body"}' --json

`shipengine.shipengine_get_rate_by_id`

Get Rate By ID Official ShipEngine endpoint: GET /v1/rates/{rate_id}.

Read read

Parameters: rate_id

Generic call

kosmo integrations:call shipengine.shipengine_get_rate_by_id '{"rate_id":"example_rate_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_rate_by_id '{"rate_id":"example_rate_id"}' --json

`shipengine.shipengine_service_points_list`

List Service Points Official ShipEngine endpoint: POST /v1/service_points/list.

Read read

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_service_points_list '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_service_points_list '{"body":"example_body"}' --json

`shipengine.shipengine_service_points_get_by_id`

Get Service Point By ID Official ShipEngine endpoint: GET /v1/service_points/{carrier_code}/{country_code}/{service_point_id}.

Read read

Parameters: carrier_code, country_code, service_point_id

Generic call

kosmo integrations:call shipengine.shipengine_service_points_get_by_id '{"carrier_code":"example_carrier_code","country_code":"example_country_code","service_point_id":"example_service_point_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_service_points_get_by_id '{"carrier_code":"example_carrier_code","country_code":"example_country_code","service_point_id":"example_service_point_id"}' --json

`shipengine.shipengine_list_shipments`

List Shipments Official ShipEngine endpoint: GET /v1/shipments.

Read read

Parameters: shipment_status, batch_id, tag, created_at_start, created_at_end, modified_at_start, modified_at_end, page, page_size, sales_order_id, sort_dir, sort_by

Generic call

kosmo integrations:call shipengine.shipengine_list_shipments '{"shipment_status":"example_shipment_status","batch_id":"example_batch_id","tag":"example_tag","created_at_start":"example_created_at_start","created_at_end":"example_created_at_end","modified_at_start":"example_modified_at_start","modified_at_end":"example_modified_at_end","page":1}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_shipments '{"shipment_status":"example_shipment_status","batch_id":"example_batch_id","tag":"example_tag","created_at_start":"example_created_at_start","created_at_end":"example_created_at_end","modified_at_start":"example_modified_at_start","modified_at_end":"example_modified_at_end","page":1}' --json

`shipengine.shipengine_create_shipments`

Create Shipments Official ShipEngine endpoint: POST /v1/shipments.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_create_shipments '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_shipments '{"body":"example_body"}' --json

`shipengine.shipengine_get_shipment_by_external_id`

Get Shipment By External ID Official ShipEngine endpoint: GET /v1/shipments/external_shipment_id/{external_shipment_id}.

Read read

Parameters: external_shipment_id

Generic call

kosmo integrations:call shipengine.shipengine_get_shipment_by_external_id '{"external_shipment_id":"example_external_shipment_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_shipment_by_external_id '{"external_shipment_id":"example_external_shipment_id"}' --json

`shipengine.shipengine_parse_shipment`

Parse shipping info Official ShipEngine endpoint: PUT /v1/shipments/recognize.

Read read

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_parse_shipment '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_parse_shipment '{"body":"example_body"}' --json

`shipengine.shipengine_get_shipment_by_id`

Get Shipment By ID Official ShipEngine endpoint: GET /v1/shipments/{shipment_id}.

Read read

Parameters: shipment_id

Generic call

kosmo integrations:call shipengine.shipengine_get_shipment_by_id '{"shipment_id":"example_shipment_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_shipment_by_id '{"shipment_id":"example_shipment_id"}' --json

`shipengine.shipengine_update_shipment`

Update Shipment By ID Official ShipEngine endpoint: PUT /v1/shipments/{shipment_id}.

Write write

Parameters: shipment_id, body

Generic call

kosmo integrations:call shipengine.shipengine_update_shipment '{"shipment_id":"example_shipment_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_update_shipment '{"shipment_id":"example_shipment_id","body":"example_body"}' --json

`shipengine.shipengine_cancel_shipments`

Cancel a Shipment Official ShipEngine endpoint: PUT /v1/shipments/{shipment_id}/cancel.

Write write

Parameters: shipment_id

Generic call

kosmo integrations:call shipengine.shipengine_cancel_shipments '{"shipment_id":"example_shipment_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_cancel_shipments '{"shipment_id":"example_shipment_id"}' --json

`shipengine.shipengine_list_shipment_rates`

Get Shipment Rates Official ShipEngine endpoint: GET /v1/shipments/{shipment_id}/rates.

Read read

Parameters: shipment_id, created_at_start

Generic call

kosmo integrations:call shipengine.shipengine_list_shipment_rates '{"shipment_id":"example_shipment_id","created_at_start":"example_created_at_start"}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_shipment_rates '{"shipment_id":"example_shipment_id","created_at_start":"example_created_at_start"}' --json

`shipengine.shipengine_shipments_update_tags`

Update Shipments Tags Official ShipEngine endpoint: PUT /v1/shipments/tags.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_shipments_update_tags '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_shipments_update_tags '{"body":"example_body"}' --json

`shipengine.shipengine_shipments_list_tags`

Get Shipment Tags Official ShipEngine endpoint: GET /v1/shipments/{shipment_id}/tags.

Read read

Parameters: shipment_id

Generic call

kosmo integrations:call shipengine.shipengine_shipments_list_tags '{"shipment_id":"example_shipment_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_shipments_list_tags '{"shipment_id":"example_shipment_id"}' --json

`shipengine.shipengine_tag_shipment`

Add Tag to Shipment Official ShipEngine endpoint: POST /v1/shipments/{shipment_id}/tags/{tag_name}.

Read read

Parameters: shipment_id, tag_name

Generic call

kosmo integrations:call shipengine.shipengine_tag_shipment '{"shipment_id":"example_shipment_id","tag_name":"example_tag_name"}' --json

Shortcut

kosmo integrations:shipengine shipengine_tag_shipment '{"shipment_id":"example_shipment_id","tag_name":"example_tag_name"}' --json

`shipengine.shipengine_untag_shipment`

Remove Tag from Shipment Official ShipEngine endpoint: DELETE /v1/shipments/{shipment_id}/tags/{tag_name}.

Read read

Parameters: shipment_id, tag_name

Generic call

kosmo integrations:call shipengine.shipengine_untag_shipment '{"shipment_id":"example_shipment_id","tag_name":"example_tag_name"}' --json

Shortcut

kosmo integrations:shipengine shipengine_untag_shipment '{"shipment_id":"example_shipment_id","tag_name":"example_tag_name"}' --json

`shipengine.shipengine_list_tags`

Get Tags Official ShipEngine endpoint: GET /v1/tags.

Read read

Parameters: none

Generic call

kosmo integrations:call shipengine.shipengine_list_tags '{}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_tags '{}' --json

`shipengine.shipengine_create_tag`

Create a New Tag Official ShipEngine endpoint: POST /v1/tags.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_create_tag '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_tag '{"body":"example_body"}' --json

`shipengine.shipengine_create_tag_2`

Create a New Tag Official ShipEngine endpoint: POST /v1/tags/{tag_name}.

Write write

Parameters: tag_name

Generic call

kosmo integrations:call shipengine.shipengine_create_tag_2 '{"tag_name":"example_tag_name"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_tag_2 '{"tag_name":"example_tag_name"}' --json

`shipengine.shipengine_delete_tag`

Delete Tag Official ShipEngine endpoint: DELETE /v1/tags/{tag_name}.

Write write

Parameters: tag_name

Generic call

kosmo integrations:call shipengine.shipengine_delete_tag '{"tag_name":"example_tag_name"}' --json

Shortcut

kosmo integrations:shipengine shipengine_delete_tag '{"tag_name":"example_tag_name"}' --json

`shipengine.shipengine_rename_tag`

Update Tag Name Official ShipEngine endpoint: PUT /v1/tags/{tag_name}/{new_tag_name}.

Read read

Parameters: tag_name, new_tag_name

Generic call

kosmo integrations:call shipengine.shipengine_rename_tag '{"tag_name":"example_tag_name","new_tag_name":"example_new_tag_name"}' --json

Shortcut

kosmo integrations:shipengine shipengine_rename_tag '{"tag_name":"example_tag_name","new_tag_name":"example_new_tag_name"}' --json

`shipengine.shipengine_tokens_get_ephemeral_token`

Get Ephemeral Token Official ShipEngine endpoint: POST /v1/tokens/ephemeral.

Read read

Parameters: redirect

Generic call

kosmo integrations:call shipengine.shipengine_tokens_get_ephemeral_token '{"redirect":"example_redirect"}' --json

Shortcut

kosmo integrations:shipengine shipengine_tokens_get_ephemeral_token '{"redirect":"example_redirect"}' --json

`shipengine.shipengine_get_tracking_log`

Get Tracking Information Official ShipEngine endpoint: GET /v1/tracking.

Read read

Parameters: carrier_code, tracking_number, carrier_id

Generic call

kosmo integrations:call shipengine.shipengine_get_tracking_log '{"carrier_code":"example_carrier_code","tracking_number":"example_tracking_number","carrier_id":"example_carrier_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_tracking_log '{"carrier_code":"example_carrier_code","tracking_number":"example_tracking_number","carrier_id":"example_carrier_id"}' --json

`shipengine.shipengine_start_tracking`

Start Tracking a Package Official ShipEngine endpoint: POST /v1/tracking/start.

Read read

Parameters: carrier_code, tracking_number, carrier_id

Generic call

kosmo integrations:call shipengine.shipengine_start_tracking '{"carrier_code":"example_carrier_code","tracking_number":"example_tracking_number","carrier_id":"example_carrier_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_start_tracking '{"carrier_code":"example_carrier_code","tracking_number":"example_tracking_number","carrier_id":"example_carrier_id"}' --json

`shipengine.shipengine_stop_tracking`

Stop Tracking a Package Official ShipEngine endpoint: POST /v1/tracking/stop.

Read read

Parameters: carrier_code, tracking_number, carrier_id

Generic call

kosmo integrations:call shipengine.shipengine_stop_tracking '{"carrier_code":"example_carrier_code","tracking_number":"example_tracking_number","carrier_id":"example_carrier_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_stop_tracking '{"carrier_code":"example_carrier_code","tracking_number":"example_tracking_number","carrier_id":"example_carrier_id"}' --json

`shipengine.shipengine_list_warehouses`

List Warehouses Official ShipEngine endpoint: GET /v1/warehouses.

Read read

Parameters: none

Generic call

kosmo integrations:call shipengine.shipengine_list_warehouses '{}' --json

Shortcut

kosmo integrations:shipengine shipengine_list_warehouses '{}' --json

`shipengine.shipengine_create_warehouse`

Create Warehouse Official ShipEngine endpoint: POST /v1/warehouses.

Write write

Parameters: body

Generic call

kosmo integrations:call shipengine.shipengine_create_warehouse '{"body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_create_warehouse '{"body":"example_body"}' --json

`shipengine.shipengine_get_warehouse_by_id`

Get Warehouse By Id Official ShipEngine endpoint: GET /v1/warehouses/{warehouse_id}.

Read read

Parameters: warehouse_id

Generic call

kosmo integrations:call shipengine.shipengine_get_warehouse_by_id '{"warehouse_id":"example_warehouse_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_get_warehouse_by_id '{"warehouse_id":"example_warehouse_id"}' --json

`shipengine.shipengine_update_warehouse`

Update Warehouse By Id Official ShipEngine endpoint: PUT /v1/warehouses/{warehouse_id}.

Write write

Parameters: warehouse_id, body

Generic call

kosmo integrations:call shipengine.shipengine_update_warehouse '{"warehouse_id":"example_warehouse_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_update_warehouse '{"warehouse_id":"example_warehouse_id","body":"example_body"}' --json

`shipengine.shipengine_delete_warehouse`

Delete Warehouse By ID Official ShipEngine endpoint: DELETE /v1/warehouses/{warehouse_id}.

Write write

Parameters: warehouse_id

Generic call

kosmo integrations:call shipengine.shipengine_delete_warehouse '{"warehouse_id":"example_warehouse_id"}' --json

Shortcut

kosmo integrations:shipengine shipengine_delete_warehouse '{"warehouse_id":"example_warehouse_id"}' --json

`shipengine.shipengine_update_warehouse_settings`

Update Warehouse Settings Official ShipEngine endpoint: PUT /v1/warehouses/{warehouse_id}/settings.

Write write

Parameters: warehouse_id, body

Generic call

kosmo integrations:call shipengine.shipengine_update_warehouse_settings '{"warehouse_id":"example_warehouse_id","body":"example_body"}' --json

Shortcut

kosmo integrations:shipengine shipengine_update_warehouse_settings '{"warehouse_id":"example_warehouse_id","body":"example_body"}' --json

Function Schemas

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

shipengine.shipengine_list_account_settings 0 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_account_settings --json

Parameter	Type	Required	Description
No parameters.

shipengine.shipengine_list_account_images 0 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_account_images --json

Parameter	Type	Required	Description
No parameters.

shipengine.shipengine_create_account_image 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_account_image --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Create an Account Image.

shipengine.shipengine_get_account_settings_images_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_account_settings_images_by_id --json

Parameter	Type	Required	Description
`label_image_id`	string	yes	Label Image Id

shipengine.shipengine_update_account_settings_images_by_id 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_update_account_settings_images_by_id --json

Parameter	Type	Required	Description
`label_image_id`	string	yes	Label Image Id
`body`	object	yes	JSON request body matching the official ShipEngine schema for Update Account Image By ID.

shipengine.shipengine_delete_account_image_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_delete_account_image_by_id --json

Parameter	Type	Required	Description
`label_image_id`	string	yes	Label Image Id

shipengine.shipengine_parse_address 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_parse_address --json

Parameter	Type	Required	Description
`body`	object	yes	The only required field is text, which is the text to be parsed. You can optionally also provide an address containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.

shipengine.shipengine_validate_address 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_validate_address --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Validate An Address.

shipengine.shipengine_list_batches 10 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_batches --json

Parameter	Type	Required	Description
`status`	string	no	The possible batch status values
`page`	integer	no	Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
`page_size`	integer	no	The number of results to return per response.
`sort_dir`	string	no	Controls the sort order of the query.
`batch_number`	string	no	Batch Number
`created_at_start`	string	no	Only return batches that were created on or after a specific date/time
`created_at_end`	string	no	Only return batches that were created on or before a specific date/time
`processed_at_start`	string	no	Only return batches that were processed on or after a specific date/time
`processed_at_end`	string	no	Only return batches that were processed on or before a specific date/time
`sort_by`	string	no	The possible batches sort by values

shipengine.shipengine_create_batch 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_batch --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Create A Batch.

shipengine.shipengine_get_batch_by_external_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_batch_by_external_id --json

Parameter	Type	Required	Description
`external_batch_id`	string	yes	path parameter `external_batch_id`.

shipengine.shipengine_delete_batch 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_delete_batch --json

Parameter	Type	Required	Description
`batch_id`	string	yes	Batch ID

shipengine.shipengine_get_batch_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_batch_by_id --json

Parameter	Type	Required	Description
`batch_id`	string	yes	Batch ID

shipengine.shipengine_update_batch 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_update_batch --json

Parameter	Type	Required	Description
`batch_id`	string	yes	Batch ID

shipengine.shipengine_add_to_batch 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_add_to_batch --json

Parameter	Type	Required	Description
`batch_id`	string	yes	Batch ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Add to a Batch.

shipengine.shipengine_list_batch_errors 3 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_batch_errors --json

Parameter	Type	Required	Description
`batch_id`	string	yes	Batch ID
`page`	integer	no	Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
`pagesize`	integer	no	query parameter `pagesize`.

shipengine.shipengine_process_batch 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_process_batch --json

Parameter	Type	Required	Description
`batch_id`	string	yes	Batch ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Process Batch ID Labels.

shipengine.shipengine_remove_from_batch 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_remove_from_batch --json

Parameter	Type	Required	Description
`batch_id`	string	yes	Batch ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Remove From Batch.

shipengine.shipengine_list_carriers 0 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_carriers --json

Parameter	Type	Required	Description
No parameters.

shipengine.shipengine_get_carrier_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_carrier_by_id --json

Parameter	Type	Required	Description
`carrier_id`	string	yes	Carrier ID

shipengine.shipengine_disconnect_carrier_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_disconnect_carrier_by_id --json

Parameter	Type	Required	Description
`carrier_id`	string	yes	Carrier ID

shipengine.shipengine_add_funds_to_carrier 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_add_funds_to_carrier --json

Parameter	Type	Required	Description
`carrier_id`	string	yes	Carrier ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Add Funds To Carrier.

shipengine.shipengine_get_carrier_options 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_carrier_options --json

Parameter	Type	Required	Description
`carrier_id`	string	yes	Carrier ID

shipengine.shipengine_list_carrier_package_types 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_carrier_package_types --json

Parameter	Type	Required	Description
`carrier_id`	string	yes	Carrier ID

shipengine.shipengine_list_carrier_services 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_carrier_services --json

Parameter	Type	Required	Description
`carrier_id`	string	yes	Carrier ID

shipengine.shipengine_connect_carrier 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_connect_carrier --json

Parameter	Type	Required	Description
`carrier_name`	string	yes	The carrier name, such as stamps_com, ups, fedex, or dhl_express.
`body`	object	yes	JSON request body matching the official ShipEngine schema for Connect a carrier account.

shipengine.shipengine_disconnect_carrier 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_disconnect_carrier --json

Parameter	Type	Required	Description
`carrier_name`	string	yes	The carrier name, such as stamps_com, ups, fedex, or dhl_express.
`carrier_id`	string	yes	Carrier ID

shipengine.shipengine_get_carrier_settings 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_carrier_settings --json

Parameter	Type	Required	Description
`carrier_name`	string	yes	The carrier name, such as ups, fedex, or dhl_express.
`carrier_id`	string	yes	Carrier ID

shipengine.shipengine_update_carrier_settings 3 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_update_carrier_settings --json

Parameter	Type	Required	Description
`carrier_name`	string	yes	The carrier name, such as ups, fedex, or dhl_express.
`carrier_id`	string	yes	Carrier ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Update carrier settings.

shipengine.shipengine_disconnect_insurer 0 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_disconnect_insurer --json

Parameter	Type	Required	Description
No parameters.

shipengine.shipengine_connect_insurer 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_connect_insurer --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Connect a Shipsurance Account.

shipengine.shipengine_create_combined_label_document 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_combined_label_document --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Created Combined Label Document.

shipengine.shipengine_download_file 5 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_download_file --json

Parameter	Type	Required	Description
`subdir`	string	yes	path parameter `subdir`.
`filename`	string	yes	path parameter `filename`.
`dir`	string	yes	path parameter `dir`.
`download`	string	no	query parameter `download`.
`rotation`	integer	no	query parameter `rotation`.

shipengine.shipengine_list_webhooks 0 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_webhooks --json

Parameter	Type	Required	Description
No parameters.

shipengine.shipengine_create_webhook 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_webhook --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Create a Webhook.

shipengine.shipengine_get_webhook_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_webhook_by_id --json

Parameter	Type	Required	Description
`webhook_id`	string	yes	Webhook ID

shipengine.shipengine_update_webhook 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_update_webhook --json

Parameter	Type	Required	Description
`webhook_id`	string	yes	Webhook ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Update a Webhook.

shipengine.shipengine_delete_webhook 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_delete_webhook --json

Parameter	Type	Required	Description
`webhook_id`	string	yes	Webhook ID

shipengine.shipengine_add_funds_to_insurance 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_add_funds_to_insurance --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Add Funds To Insurance.

shipengine.shipengine_get_insurance_balance 0 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_insurance_balance --json

Parameter	Type	Required	Description
No parameters.

shipengine.shipengine_list_labels 15 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_labels --json

Parameter	Type	Required	Description
`label_status`	string	no	Only return labels that are currently in the specified status
`service_code`	string	no	Only return labels for a specific
`carrier_id`	string	no	Only return labels for a specific
`tracking_number`	string	no	Only return labels with a specific tracking number
`batch_id`	string	no	Only return labels that were created in a specific
`rate_id`	string	no	Rate ID
`shipment_id`	string	no	Shipment ID
`warehouse_id`	string	no	Only return labels that originate from a specific
`created_at_start`	string	no	Only return labels that were created on or after a specific date/time
`created_at_end`	string	no	Only return labels that were created on or before a specific date/time
`refund_status`	array	no	Only return labels with specific refund status/es.
`page`	integer	no	Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
`page_size`	integer	no	The number of results to return per response.
`sort_dir`	string	no	Controls the sort order of the query.
`sort_by`	string	no	Controls which field the query is sorted by.

shipengine.shipengine_create_label 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_label --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Purchase Label.

shipengine.shipengine_get_label_by_external_shipment_id 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_label_by_external_shipment_id --json

Parameter	Type	Required	Description
`external_shipment_id`	string	yes	path parameter `external_shipment_id`.
`label_download_type`	string	no	There are two different ways to : Label Download Type Description -------------------------------------------------- url You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. inline You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.

shipengine.shipengine_create_label_from_rate 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_label_from_rate --json

Parameter	Type	Required	Description
`rate_id`	string	yes	Rate ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Purchase Label with Rate ID.

shipengine.shipengine_create_label_from_rate_shopper 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_label_from_rate_shopper --json

Parameter	Type	Required	Description
`rate_shopper_id`	string	yes	The rate selection strategy for the Rate Shopper. This determines which carrier and service will be automatically selected from your wallet carriers based on the rates returned for the shipment.
`body`	object	yes	Label creation details with inline shipment

shipengine.shipengine_create_label_from_shipment 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_label_from_shipment --json

Parameter	Type	Required	Description
`shipment_id`	string	yes	Shipment ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Purchase Label with Shipment ID.

shipengine.shipengine_get_label_by_id 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_label_by_id --json

Parameter	Type	Required	Description
`label_id`	string	yes	Label ID
`label_download_type`	string	no	There are two different ways to : Label Download Type Description -------------------------------------------------- url You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. inline You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.

shipengine.shipengine_create_return_label 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_return_label --json

Parameter	Type	Required	Description
`label_id`	string	yes	Label ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Create a return label.

shipengine.shipengine_get_tracking_log_from_label 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_tracking_log_from_label --json

Parameter	Type	Required	Description
`label_id`	string	yes	Label ID

shipengine.shipengine_void_label 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_void_label --json

Parameter	Type	Required	Description
`label_id`	string	yes	Label ID

shipengine.shipengine_cancel_label_refund 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_cancel_label_refund --json

Parameter	Type	Required	Description
`label_id`	string	yes	Label ID

shipengine.shipengine_list_manifests 9 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_manifests --json

Parameter	Type	Required	Description
`warehouse_id`	string	no	Warehouse ID
`ship_date_start`	string	no	ship date start range
`ship_date_end`	string	no	ship date end range
`created_at_start`	string	no	Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
`created_at_end`	string	no	Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
`carrier_id`	string	no	Carrier ID
`page`	integer	no	Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
`page_size`	integer	no	The number of results to return per response.
`label_ids`	array	no	Array of label ids

shipengine.shipengine_create_manifest 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_manifest --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Create Manifest.

shipengine.shipengine_get_manifest_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_manifest_by_id --json

Parameter	Type	Required	Description
`manifest_id`	string	yes	The Manifest Id

shipengine.shipengine_get_manifest_request_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_manifest_request_by_id --json

Parameter	Type	Required	Description
`manifest_request_id`	string	yes	The Manifest Request Id

shipengine.shipengine_list_package_types 0 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_package_types --json

Parameter	Type	Required	Description
No parameters.

shipengine.shipengine_create_package_type 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_package_type --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Create Custom Package Type.

shipengine.shipengine_get_package_type_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_package_type_by_id --json

Parameter	Type	Required	Description
`package_id`	string	yes	Package ID

shipengine.shipengine_update_package_type 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_update_package_type --json

Parameter	Type	Required	Description
`package_id`	string	yes	Package ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Update Custom Package Type By ID.

shipengine.shipengine_delete_package_type 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_delete_package_type --json

Parameter	Type	Required	Description
`package_id`	string	yes	Package ID

shipengine.shipengine_list_scheduled_pickups 6 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_scheduled_pickups --json

Parameter	Type	Required	Description
`carrier_id`	string	no	Carrier ID
`warehouse_id`	string	no	Warehouse ID
`created_at_start`	string	no	Only return scheduled pickups that were created on or after a specific date/time
`created_at_end`	string	no	Only return scheduled pickups that were created on or before a specific date/time
`page`	integer	no	Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
`page_size`	integer	no	The number of results to return per response.

shipengine.shipengine_schedule_pickup 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_schedule_pickup --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Schedule a Pickup.

shipengine.shipengine_get_pickup_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_pickup_by_id --json

Parameter	Type	Required	Description
`pickup_id`	string	yes	Pickup Resource ID

shipengine.shipengine_delete_scheduled_pickup 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_delete_scheduled_pickup --json

Parameter	Type	Required	Description
`pickup_id`	string	yes	Pickup Resource ID

shipengine.shipengine_calculate_rates 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_calculate_rates --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Get Shipping Rates.

shipengine.shipengine_compare_bulk_rates 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_compare_bulk_rates --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Get Bulk Rates.

shipengine.shipengine_estimate_rates 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_estimate_rates --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Estimate Rates.

shipengine.shipengine_get_rate_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_rate_by_id --json

Parameter	Type	Required	Description
`rate_id`	string	yes	Rate ID

shipengine.shipengine_service_points_list 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_service_points_list --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for List Service Points.

shipengine.shipengine_service_points_get_by_id 3 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_service_points_get_by_id --json

Parameter	Type	Required	Description
`carrier_code`	string	yes	Carrier code
`country_code`	string	yes	A two-letter
`service_point_id`	string	yes	path parameter `service_point_id`.

shipengine.shipengine_list_shipments 12 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_shipments --json

Parameter	Type	Required	Description
`shipment_status`	string	no	The possible shipment status values
`batch_id`	string	no	Batch ID
`tag`	string	no	Search for shipments based on the custom tag added to the shipment object
`created_at_start`	string	no	Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
`created_at_end`	string	no	Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
`modified_at_start`	string	no	Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)
`modified_at_end`	string	no	Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)
`page`	integer	no	Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
`page_size`	integer	no	The number of results to return per response.
`sales_order_id`	string	no	Sales Order ID
`sort_dir`	string	no	Controls the sort order of the query.
`sort_by`	string	no	The possible shipments sort by values

shipengine.shipengine_create_shipments 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_shipments --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Create Shipments.

shipengine.shipengine_get_shipment_by_external_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_shipment_by_external_id --json

Parameter	Type	Required	Description
`external_shipment_id`	string	yes	path parameter `external_shipment_id`.

shipengine.shipengine_parse_shipment 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_parse_shipment --json

Parameter	Type	Required	Description
`body`	object	yes	The only required field is text, which is the text to be parsed. You can optionally also provide a shipment containing any already-known values. For example, you probably already know the ship_from address, and you may also already know what carrier and service you want to use.

shipengine.shipengine_get_shipment_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_shipment_by_id --json

Parameter	Type	Required	Description
`shipment_id`	string	yes	Shipment ID

shipengine.shipengine_update_shipment 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_update_shipment --json

Parameter	Type	Required	Description
`shipment_id`	string	yes	Shipment ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Update Shipment By ID.

shipengine.shipengine_cancel_shipments 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_cancel_shipments --json

Parameter	Type	Required	Description
`shipment_id`	string	yes	Shipment ID

shipengine.shipengine_list_shipment_rates 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_shipment_rates --json

Parameter	Type	Required	Description
`shipment_id`	string	yes	Shipment ID
`created_at_start`	string	no	Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)

shipengine.shipengine_shipments_update_tags 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_shipments_update_tags --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Update Shipments Tags.

shipengine.shipengine_shipments_list_tags 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_shipments_list_tags --json

Parameter	Type	Required	Description
`shipment_id`	string	yes	Shipment ID

shipengine.shipengine_tag_shipment 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_tag_shipment --json

Parameter	Type	Required	Description
`shipment_id`	string	yes	Shipment ID
`tag_name`	string	yes	Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.

shipengine.shipengine_untag_shipment 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_untag_shipment --json

Parameter	Type	Required	Description
`shipment_id`	string	yes	Shipment ID
`tag_name`	string	yes	Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.

shipengine.shipengine_list_tags 0 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_tags --json

Parameter	Type	Required	Description
No parameters.

shipengine.shipengine_create_tag 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_tag --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Create a New Tag.

shipengine.shipengine_create_tag_2 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_tag_2 --json

Parameter	Type	Required	Description
`tag_name`	string	yes	Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.

shipengine.shipengine_delete_tag 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_delete_tag --json

Parameter	Type	Required	Description
`tag_name`	string	yes	Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.

shipengine.shipengine_rename_tag 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_rename_tag --json

Parameter	Type	Required	Description
`tag_name`	string	yes	Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.
`new_tag_name`	string	yes	Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.

shipengine.shipengine_tokens_get_ephemeral_token 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_tokens_get_ephemeral_token --json

Parameter	Type	Required	Description
`redirect`	string	no	Include a redirect url to the application formatted with the ephemeral token.

shipengine.shipengine_get_tracking_log 3 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_tracking_log --json

Parameter	Type	Required	Description
`carrier_code`	string	no	A , such as fedex, dhl_express, stamps_com, etc.
`tracking_number`	string	no	The tracking number associated with a shipment
`carrier_id`	string	no	Carrier ID

shipengine.shipengine_start_tracking 3 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_start_tracking --json

Parameter	Type	Required	Description
`carrier_code`	string	no	A , such as fedex, dhl_express, stamps_com, etc.
`tracking_number`	string	no	The tracking number associated with a shipment
`carrier_id`	string	no	Carrier ID

shipengine.shipengine_stop_tracking 3 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_stop_tracking --json

Parameter	Type	Required	Description
`carrier_code`	string	no	A , such as fedex, dhl_express, stamps_com, etc.
`tracking_number`	string	no	The tracking number associated with a shipment
`carrier_id`	string	no	Carrier ID

shipengine.shipengine_list_warehouses 0 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_list_warehouses --json

Parameter	Type	Required	Description
No parameters.

shipengine.shipengine_create_warehouse 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_create_warehouse --json

Parameter	Type	Required	Description
`body`	object	yes	JSON request body matching the official ShipEngine schema for Create Warehouse.

shipengine.shipengine_get_warehouse_by_id 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_get_warehouse_by_id --json

Parameter	Type	Required	Description
`warehouse_id`	string	yes	Warehouse ID

shipengine.shipengine_update_warehouse 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_update_warehouse --json

Parameter	Type	Required	Description
`warehouse_id`	string	yes	Warehouse ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Update Warehouse By Id.

shipengine.shipengine_delete_warehouse 1 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_delete_warehouse --json

Parameter	Type	Required	Description
`warehouse_id`	string	yes	Warehouse ID

shipengine.shipengine_update_warehouse_settings 2 parameters

Schema command

kosmo integrations:schema shipengine.shipengine_update_warehouse_settings --json

Parameter	Type	Required	Description
`warehouse_id`	string	yes	Warehouse ID
`body`	object	yes	JSON request body matching the official ShipEngine schema for Update Warehouse Settings.

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.