HighLevel: Get Shipping Carrier

← Store operations · Get started

Operation gohighlevel.get_shipping_carriers

Provider route: GET /store/shipping-carrier/{shippingCarrierId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["store"]["getShippingCarriers"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.store.getShippingCarriers(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.store.get_shipping_carriers(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.shippingCarrierId	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.altId	string	Required within parent
query.altType	string	Required within parent	One of: location

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get Shipping Carrier — response body

Referenced models: Get Shipping Carrier — response body

Schemas

Get Shipping Carrier — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Shipping carrier data
data (allOf 1)	Model	All variants apply	Expand List Shipping Carriers — response body — data item
message	string	Optional	Success message
status	boolean	Required within parent	Status of api action

Referenced models: List Shipping Carriers — response body — data item

List Shipping Carriers — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the product.
allowsMultipleServiceSelection	boolean	Optional	The seller can choose multiple services while creating shipping rates if this is true.
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	Known values: location
callbackUrl	string	Required within parent	The URL endpoint that CRM needs to retrieve shipping rates. This must be a public URL.
createdAt	string	Required within parent	created at
marketplaceAppId	string	Required within parent	The unique identifier for the marketplace app.
name	string	Required within parent	Name of the shipping carrier
services	array	Optional	An array of available shipping carrier services
services[]	Model	Each item	Expand Create Shipping Carrier — request body — body services item
updatedAt	string	Required within parent	updated at

Referenced models: Create Shipping Carrier — request body — body services item

Create Shipping Carrier — request body — body services item

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	Name of the shipping carrier service
value	string	Required within parent	Value of the shipping carrier service

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_shipping_carriers. Catalog operation: get-shipping-carriers. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Version": "v3"}

Official provider source