> ## Documentation Index > Fetch the complete documentation index at: https://docs.stackone.com/llms.txt > Use this file to discover all available pages before exploring further. # Shippo > How to set up the Shippo connector, plus the actions and events that are available. ![Shippo](https://stackone-logos.com/api/shippo/filled/svg) Previewv0.1.0[See changelog](https://docs.stackone.com/connectors/shippo/changelog.md) [71 actions](#actions) · [3 events](#events) · 2 auth methods ## Getting Started **1. Create or Select a Project** Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md). **2. Configure the Connector** Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile). > [card] [Connector Profile · API Key](https://docs.stackone.com/connectors/shippo/guides/connector-profile/api-key.md) > > Uses a Shippo API token sent in the Authorization header with the ShippoToken scheme. Live and test tokens are generated... > [card] [Connector Profile · OAuth 2.0](https://docs.stackone.com/connectors/shippo/guides/connector-profile/oauth-2-0.md) > > OAuth 2.0 authorization-code flow for Shippo platform apps. The access token is non-expiring, so no re-authentication is... **3. Link an Account** Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)). See the guide for the authentication type chosen in the Connector Profile: > [card] [Link Account · API Key](https://docs.stackone.com/connectors/shippo/guides/link-account/api-key.md) > [card] [Link Account · OAuth 2.0](https://docs.stackone.com/connectors/shippo/guides/link-account/oauth-2-0.md) **4. Use Actions** Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md). Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md). ## Actions Authentication type Select all | Clear API Key OAuth 2.0 No auth methods found 71 actions ActionDescription List Addresses`shippo_list_addresses` List the addresses in your Shippo account. Create Address`shippo_create_address` Create a new address in your Shippo account. Get Address`shippo_get_address` Retrieve a single address by its Shippo object ID. Validate Address`shippo_validate_address` Validate an address against carrier databases. Create Batch`shippo_create_batch` Create a new batch in your Shippo account. Get Batch`shippo_get_batch` Retrieve a single batch by its Shippo object ID. Add Shipments To Batch`shippo_add_shipments_to_batch` Add shipments to an existing batch. Remove Shipments From Batch`shippo_remove_shipments_from_batch` Remove shipments from an existing batch. Purchase Batch`shippo_purchase_batch` Purchase all labels in a batch. List Carrier Accounts`shippo_list_carrier_accounts` List the carrier accounts in your Shippo account. Create Carrier Account`shippo_create_carrier_account` Create a new carrier account in your Shippo account. Get Carrier Account`shippo_get_carrier_account` Retrieve a single carrier account by its Shippo object ID. Update Carrier Account`shippo_update_carrier_account` Update an existing carrier account by its Shippo object ID. Register Carrier Account`shippo_register_carrier_account` Register a new carrier account with your own carrier credentials. Get Carrier Registration Status`shippo_get_carrier_registration_status` Check the registration status of a carrier for your account. Initiate Carrier OAuth Sign-in`shippo_initiate_carrier_oauth` Start the OAuth sign-in flow for a carrier account. List Customs Declarations`shippo_list_customs_declarations` List the customs declarations in your Shippo account. Create Customs Declaration`shippo_create_customs_declaration` Create a new customs declaration in your Shippo account. Get Customs Declaration`shippo_get_customs_declaration` Retrieve a single customs declaration by its Shippo object ID. List Customs Items`shippo_list_customs_items` List the customs items in your Shippo account. Create Customs Item`shippo_create_customs_item` Create a new customs item in your Shippo account. Get Customs Item`shippo_get_customs_item` Retrieve a single customs item by its Shippo object ID. Create Embedded Authorization`shippo_create_embedded_authorization` Create a scoped embedded authorization token in your Shippo account. Create Live Rate`shippo_create_live_rate` Fetch live checkout rates for a cart in your Shippo account. Get Default Parcel Template`shippo_get_default_parcel_template` Show the current default parcel template used for live checkout rates. Update Default Parcel Template`shippo_update_default_parcel_template` Set the default parcel template used for live checkout rates. Delete Default Parcel Template`shippo_delete_default_parcel_template` Clear the default parcel template used for live checkout rates. List Manifests`shippo_list_manifests` List the manifests in your Shippo account. Create Manifest`shippo_create_manifest` Create a new manifest in your Shippo account. Get Manifest`shippo_get_manifest` Retrieve a single manifest by its Shippo object ID. List Orders`shippo_list_orders` List the orders in your Shippo account. Create Order`shippo_create_order` Create a new order in your Shippo account. Get Order`shippo_get_order` Retrieve a single order by its Shippo object ID. List Carrier Parcel Templates`shippo_list_carrier_parcel_templates` List the carrier parcel templates available in your Shippo account. Get Carrier Parcel Template`shippo_get_carrier_parcel_template` Retrieve a single carrier parcel template by its token. List Parcels`shippo_list_parcels` List the parcels in your Shippo account. Create Parcel`shippo_create_parcel` Create a new parcel in your Shippo account. Get Parcel`shippo_get_parcel` Retrieve a single parcel by its Shippo object ID. Create Pickup`shippo_create_pickup` Create a new pickup in your Shippo account. List Shipment Rates`shippo_list_shipment_rates` List the rates in your Shippo account. List Shipment Rates By Currency Code`shippo_list_shipment_rates_by_currency_code` List the rates in your Shippo account. Get Rate`shippo_get_rate` Retrieve a single rate by its Shippo object ID. Create Refund`shippo_create_refund` Create a new refund in your Shippo account. List Refunds`shippo_list_refunds` List the refunds in your Shippo account. Get Refund`shippo_get_refund` Retrieve a single refund by its Shippo object ID. List Service Groups`shippo_list_service_groups` List the service groups in your Shippo account. Create Service Group`shippo_create_service_group` Create a new service group in your Shippo account. Update Service Group`shippo_update_service_group` Update an existing service group in your Shippo account. Delete Service Group`shippo_delete_service_group` Delete a service group by its Shippo object ID. List Shipments`shippo_list_shipments` List the shipments in your Shippo account. Create Shipment`shippo_create_shipment` Create a new shipment in your Shippo account. Get Shipment`shippo_get_shipment` Retrieve a single shipment by its Shippo object ID. List Shippo Accounts`shippo_list_shippo_accounts` List the managed Shippo accounts under your platform account. Create Shippo Account`shippo_create_shippo_account` Create a new managed Shippo account under your platform account. Get Shippo Account`shippo_get_shippo_account` Retrieve a single managed Shippo account by its object ID. Update Shippo Account`shippo_update_shippo_account` Update an existing managed Shippo account. Create Track`shippo_create_track` Register a tracking number for status updates. Get Track`shippo_get_track` Get the current tracking status for a shipment. List Transactions`shippo_list_transactions` List the transactions in your Shippo account. Create Transaction`shippo_create_transaction` Create a new transaction (shipping label) in your Shippo account. Get Transaction`shippo_get_transaction` Retrieve a single transaction (shipping label) by its Shippo object ID. List User Parcel Templates`shippo_list_user_parcel_templates` List the saved user parcel templates in your Shippo account. Create User Parcel Template`shippo_create_user_parcel_template` Create a new saved user parcel template in your Shippo account. Get User Parcel Template`shippo_get_user_parcel_template` Retrieve a single user parcel template by its Shippo object ID. Update User Parcel Template`shippo_update_user_parcel_template` Update an existing user parcel template. Delete User Parcel Template`shippo_delete_user_parcel_template` Delete a user parcel template by its Shippo object ID. List Webhooks`shippo_list_webhooks` List the webhook subscriptions in your Shippo account. Create Webhook`shippo_create_webhook` Create a new webhook subscription in your Shippo account. Get Webhook`shippo_get_webhook` Retrieve a single webhook subscription by its object ID. Update Webhook`shippo_update_webhook` Update an existing webhook subscription. Delete Webhook`shippo_delete_webhook` Delete a webhook subscription by its object ID. ## Events Tags Select all | Clear Tracking Transactions Webhooks No tags found 3 events EventDescriptionTags Transaction Created`shippo_webhook_transaction_created` Emitted when a transaction (shipping label) is created in Shippo. Maps to the Shippo webhook event `transaction_created`... TransactionsWebhooks Transaction Updated`shippo_webhook_transaction_updated` Emitted when a transaction (shipping label) is updated in Shippo, for example when an asynchronous label finishes proces... TransactionsWebhooks Track Updated`shippo_webhook_track_updated` Emitted when the tracking status of a shipment changes in Shippo. Maps to the Shippo webhook event `track_updated`. The... TrackingWebhooks This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.