Skip to main content
POST
/
store
/
shipping-carrier
Create Shipping Carrier
curl --request POST \
  --url https://services.leadconnectorhq.com/store/shipping-carrier \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "FedEx",
  "callbackUrl": "https://example.com/get-shipping-rates",
  "services": [
    {
      "name": "Priority Mail Express International",
      "value": "PriorityMailExpressInternational"
    }
  ],
  "allowsMultipleServiceSelection": true
}
'
{
  "status": true,
  "data": {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "name": "FedEx",
    "callbackUrl": "https://example.com/get-shipping-rates",
    "_id": "655b33a82209e60b6adb87a5",
    "marketplaceAppId": "655b33a82209e60b6adb87a5",
    "createdAt": "2023-12-12T09:27:42.355Z",
    "updatedAt": "2023-12-12T09:27:42.355Z",
    "services": [
      {
        "name": "Priority Mail Express International",
        "value": "PriorityMailExpressInternational"
      }
    ],
    "allowsMultipleServiceSelection": true
  },
  "message": "Successfully created"
}

Authorizations

Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Body

application/json
altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>
required
Available options:
location
name
string
required

Name of the shipping carrier

Example:

"FedEx"

callbackUrl
string
required

The URL endpoint that GHL needs to retrieve shipping rates. This must be a public URL.

Example:

"https://example.com/get-shipping-rates"

services
object[]

An array of available shipping carrier services

allowsMultipleServiceSelection
boolean

The seller can choose multiple services while creating shipping rates if this is true.

Example:

true

Response

Successful response

status
boolean
required

Status of api action

Example:

true

data
object
required
message
string

Success message

Example:

"Successfully created"

Last modified on March 4, 2026