data
Shippo MCP, CLI, and Lua Integration for AI Agents
Shippo integration docs for AI agents: MCP gateway setup, Shippo CLI commands, Lua API reference, credentials, and function schemas.Shippo for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
shippo.shippo_list_addresses | Read read | 3 | List all addresses Official Shippo endpoint: GET /addresses. |
shippo.shippo_create_address | Write write | 2 | Create a new address Official Shippo endpoint: POST /addresses. |
shippo.shippo_get_address | Read read | 2 | Retrieve an address Official Shippo endpoint: GET /addresses/{AddressId}. |
shippo.shippo_validate_address | Read read | 2 | Validate an address Official Shippo endpoint: GET /addresses/{AddressId}/validate. |
shippo.shippo_create_batch | Write write | 2 | Create a batch Official Shippo endpoint: POST /batches. |
shippo.shippo_get_batch | Read read | 4 | Retrieve a batch Official Shippo endpoint: GET /batches/{BatchId}. |
shippo.shippo_add_shipments_to_batch | Write write | 3 | Add shipments to a batch Official Shippo endpoint: POST /batches/{BatchId}/add_shipments. |
shippo.shippo_purchase_batch | Read read | 2 | Purchase a batch Official Shippo endpoint: POST /batches/{BatchId}/purchase. |
shippo.shippo_remove_shipments_from_batch | Write write | 3 | Remove shipments from a batch Official Shippo endpoint: POST /batches/{BatchId}/remove_shipments. |
shippo.shippo_list_carrier_accounts | Read read | 6 | List all carrier accounts Official Shippo endpoint: GET /carrier_accounts. |
shippo.shippo_create_carrier_account | Write write | 2 | Create a new carrier account Official Shippo endpoint: POST /carrier_accounts. |
shippo.shippo_get_carrier_account | Read read | 2 | Retrieve a carrier account Official Shippo endpoint: GET /carrier_accounts/{CarrierAccountId}. |
shippo.shippo_update_carrier_account | Write write | 3 | Update a carrier account Official Shippo endpoint: PUT /carrier_accounts/{CarrierAccountId}. |
shippo.shippo_initiate_oauth2_signin | Read read | 4 | Connect an existing carrier account using OAuth 2.0 Official Shippo endpoint: GET /carrier_accounts/{CarrierAccountObjectId}/signin/initiate. |
shippo.shippo_register_carrier_account | Read read | 2 | Add a Shippo carrier account Official Shippo endpoint: POST /carrier_accounts/register/new. |
shippo.shippo_get_carrier_registration_status | Read read | 2 | Get Carrier Registration status Official Shippo endpoint: GET /carrier_accounts/reg-status. |
shippo.shippo_list_customs_declarations | Read read | 3 | List all customs declarations Official Shippo endpoint: GET /customs/declarations. |
shippo.shippo_create_customs_declaration | Write write | 2 | Create a new customs declaration Official Shippo endpoint: POST /customs/declarations. |
shippo.shippo_get_customs_declaration | Read read | 3 | Retrieve a customs declaration Official Shippo endpoint: GET /customs/declarations/{CustomsDeclarationId}. |
shippo.shippo_list_customs_items | Read read | 3 | List all customs items Official Shippo endpoint: GET /customs/items. |
shippo.shippo_create_customs_item | Write write | 2 | Create a new customs item Official Shippo endpoint: POST /customs/items. |
shippo.shippo_get_customs_item | Read read | 3 | Retrieve a customs item Official Shippo endpoint: GET /customs/items/{CustomsItemId}. |
shippo.shippo_create_live_rate | Write write | 2 | Generate a live rates request Official Shippo endpoint: POST /live-rates. |
shippo.shippo_get_default_parcel_template | Read read | 1 | Show current default parcel template Official Shippo endpoint: GET /live-rates/settings/parcel-template. |
shippo.shippo_update_default_parcel_template | Write write | 2 | Update default parcel template Official Shippo endpoint: PUT /live-rates/settings/parcel-template. |
shippo.shippo_delete_default_parcel_template | Write write | 1 | Clear current default parcel template Official Shippo endpoint: DELETE /live-rates/settings/parcel-template. |
shippo.shippo_list_manifests | Read read | 3 | List all manifests Official Shippo endpoint: GET /manifests. |
shippo.shippo_create_manifest | Write write | 2 | Create a new manifest Official Shippo endpoint: POST /manifests. |
shippo.shippo_get_manifest | Read read | 2 | Retrieve a manifest Official Shippo endpoint: GET /manifests/{ManifestId}. |
shippo.shippo_list_orders | Read read | 7 | List all orders Official Shippo endpoint: GET /orders. |
shippo.shippo_create_order | Write write | 2 | Create a new order Official Shippo endpoint: POST /orders. |
shippo.shippo_get_order | Read read | 2 | Retrieve an order Official Shippo endpoint: GET /orders/{OrderId}. |
shippo.shippo_list_carrier_parcel_templates | Read read | 3 | List all carrier parcel templates Official Shippo endpoint: GET /parcel-templates. |
shippo.shippo_get_carrier_parcel_template | Read read | 2 | Retrieve a carrier parcel templates Official Shippo endpoint: GET /parcel-templates/{CarrierParcelTemplateToken}. |
shippo.shippo_list_parcels | Read read | 3 | List all parcels Official Shippo endpoint: GET /parcels. |
shippo.shippo_create_parcel | Write write | 2 | Create a new parcel Official Shippo endpoint: POST /parcels. |
shippo.shippo_get_parcel | Read read | 2 | Retrieve an existing parcel Official Shippo endpoint: GET /parcels/{ParcelId}. |
shippo.shippo_create_pickup | Write write | 2 | Create a pickup Official Shippo endpoint: POST /pickups. |
shippo.shippo_get_rate | Read read | 2 | Retrieve a rate Official Shippo endpoint: GET /rates/{RateId}. |
shippo.shippo_create_refund | Write write | 2 | Create a refund Official Shippo endpoint: POST /refunds. |
shippo.shippo_list_refunds | Read read | 1 | List all refunds Official Shippo endpoint: GET /refunds/. |
shippo.shippo_get_refund | Read read | 2 | Retrieve a refund Official Shippo endpoint: GET /refunds/{RefundId}. |
shippo.shippo_list_service_groups | Read read | 1 | List all service groups Official Shippo endpoint: GET /service-groups. |
shippo.shippo_create_service_group | Write write | 2 | Create a new service group Official Shippo endpoint: POST /service-groups. |
shippo.shippo_update_service_group | Write write | 2 | Update an existing service group Official Shippo endpoint: PUT /service-groups. |
shippo.shippo_delete_service_group | Write write | 2 | Delete a service group Official Shippo endpoint: DELETE /service-groups/{ServiceGroupId}. |
shippo.shippo_list_shipments | Read read | 8 | List all shipments Official Shippo endpoint: GET /shipments. |
shippo.shippo_create_shipment | Write write | 2 | Create a new shipment Official Shippo endpoint: POST /shipments. |
shippo.shippo_get_shipment | Read read | 2 | Retrieve a shipment Official Shippo endpoint: GET /shipments/{ShipmentId}. |
shippo.shippo_list_shipment_rates | Read read | 4 | Retrieve shipment rates Official Shippo endpoint: GET /shipments/{ShipmentId}/rates. |
shippo.shippo_list_shipment_rates_by_currency_code | Read read | 5 | Retrieve shipment rates in currency Official Shippo endpoint: GET /shipments/{ShipmentId}/rates/{CurrencyCode}. |
shippo.shippo_create_track | Write write | 2 | Register a tracking webhook Official Shippo endpoint: POST /tracks. |
shippo.shippo_get_track | Read read | 3 | Get a tracking status Official Shippo endpoint: GET /tracks/{Carrier}/{TrackingNumber}. |
shippo.shippo_list_transactions | Read read | 6 | List all shipping labels Official Shippo endpoint: GET /transactions. |
shippo.shippo_create_transaction | Write write | 2 | Create a shipping label Official Shippo endpoint: POST /transactions. |
shippo.shippo_get_transaction | Read read | 2 | Retrieve a shipping label Official Shippo endpoint: GET /transactions/{TransactionId}. |
shippo.shippo_list_user_parcel_templates | Read read | 1 | List all user parcel templates Official Shippo endpoint: GET /user-parcel-templates. |
shippo.shippo_create_user_parcel_template | Write write | 2 | Create a new user parcel template Official Shippo endpoint: POST /user-parcel-templates. |
shippo.shippo_delete_user_parcel_template | Write write | 2 | Delete a user parcel template Official Shippo endpoint: DELETE /user-parcel-templates/{UserParcelTemplateObjectId}. |
shippo.shippo_get_user_parcel_template | Read read | 2 | Retrieves a user parcel template Official Shippo endpoint: GET /user-parcel-templates/{UserParcelTemplateObjectId}. |
shippo.shippo_update_user_parcel_template | Write write | 3 | Update an existing user parcel template Official Shippo endpoint: PUT /user-parcel-templates/{UserParcelTemplateObjectId}. |
shippo.shippo_list_shippo_accounts | Read read | 3 | List all Shippo Accounts Official Shippo endpoint: GET /shippo-accounts. |
shippo.shippo_create_shippo_account | Write write | 2 | Create a Shippo Account Official Shippo endpoint: POST /shippo-accounts. |
shippo.shippo_get_shippo_account | Read read | 2 | Retrieve a Shippo Account Official Shippo endpoint: GET /shippo-accounts/{ShippoAccountId}. |
shippo.shippo_update_shippo_account | Write write | 3 | Update a Shippo Account Official Shippo endpoint: PUT /shippo-accounts/{ShippoAccountId}. |
shippo.shippo_create_webhook | Write write | 1 | Create a new webhook Official Shippo endpoint: POST /webhooks. |
shippo.shippo_list_webhooks | Read read | 0 | List all webhooks Official Shippo endpoint: GET /webhooks. |
shippo.shippo_get_webhook | Read read | 1 | Retrieve a specific webhook Official Shippo endpoint: GET /webhooks/{webhookId}. |
shippo.shippo_update_webhook | Write write | 2 | Update an existing webhook Official Shippo endpoint: PUT /webhooks/{webhookId}. |
shippo.shippo_delete_webhook | Write write | 1 | Delete a specific webhook Official Shippo endpoint: DELETE /webhooks/{webhookId}. |