Update Shipping Rate

PUT

store

shipping-zone

{shippingZoneId}

shipping-rate

{shippingRateId}

Update Shipping Rate

curl --request PUT \
  --url https://services.leadconnectorhq.com/store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "North zone",
  "description": "Ships next day",
  "currency": "USD",
  "amount": 99.99,
  "conditionType": "price",
  "minCondition": 99.99,
  "maxCondition": 99.99,
  "isCarrierRate": true,
  "shippingCarrierId": "655b33a82209e60b6adb87a5",
  "percentageOfRateFee": 10.99,
  "shippingCarrierServices": [
    {
      "name": "Priority Mail Express International",
      "value": "PriorityMailExpressInternational"
    }
  ]
}
'

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    altId: '6578278e879ad2646715ba9c',
    altType: 'location',
    name: 'North zone',
    description: 'Ships next day',
    currency: 'USD',
    amount: 99.99,
    conditionType: 'price',
    minCondition: 99.99,
    maxCondition: 99.99,
    isCarrierRate: true,
    shippingCarrierId: '655b33a82209e60b6adb87a5',
    percentageOfRateFee: 10.99,
    shippingCarrierServices: [
      {
        name: 'Priority Mail Express International',
        value: 'PriorityMailExpressInternational'
      }
    ]
  })
};

fetch('https://services.leadconnectorhq.com/store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}"

payload = {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "name": "North zone",
    "description": "Ships next day",
    "currency": "USD",
    "amount": 99.99,
    "conditionType": "price",
    "minCondition": 99.99,
    "maxCondition": 99.99,
    "isCarrierRate": True,
    "shippingCarrierId": "655b33a82209e60b6adb87a5",
    "percentageOfRateFee": 10.99,
    "shippingCarrierServices": [
        {
            "name": "Priority Mail Express International",
            "value": "PriorityMailExpressInternational"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{
  "status": true,
  "data": {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "name": "North zone",
    "currency": "USD",
    "amount": 99.99,
    "conditionType": "price",
    "minCondition": 99.99,
    "maxCondition": 99.99,
    "shippingCarrierId": "655b33a82209e60b6adb87a5",
    "_id": "655b33a82209e60b6adb87a5",
    "shippingZoneId": "655b33a82209e60b6adb87a5",
    "createdAt": "2023-12-12T09:27:42.355Z",
    "updatedAt": "2023-12-12T09:27:42.355Z",
    "description": "Ships next day",
    "isCarrierRate": true,
    "percentageOfRateFee": 10.99,
    "shippingCarrierServices": [
      {
        "name": "Priority Mail Express International",
        "value": "PriorityMailExpressInternational"
      }
    ]
  },
  "message": "Successfully created"
}

{
  "statusCode": 400,
  "message": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

Path Parameters

shippingZoneId

string

required

ID of the shipping zone

Example:

"6578278e879ad2646715ba9c"

shippingRateId

string

required

ID of the shipping rate that needs to be returned

Example:

"6578278e879ad2646715ba9c"

Body

application/json

altId

string

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

altType

enum<string>

Available options:

location

name

string

Name of the shipping zone

Example:

"North zone"

description

string

Delivery description

Example:

"Ships next day"

currency

string

The currency of the amount of the rate / handling fee

Example:

"USD"

amount

number

The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee if it is a carrier rate (it will add to the carrier rate).

Example:

99.99

conditionType

enum<string>

Type of condition to provide the conditional pricing

Available options:

none,

price,

weight

Example:

"price"

minCondition

number

Minimum condition for applying this price. set 0 or null if there is no minimum

Example:

99.99

maxCondition

number

Maximum condition for applying this price. set 0 or null if there is no maximum

Example:

99.99

isCarrierRate

boolean

is this a carrier rate

Example:

true

shippingCarrierId

string

Shipping carrier id

Example:

"655b33a82209e60b6adb87a5"

percentageOfRateFee

number

Percentage of rate fee if it is a carrier rate.

Example:

10.99

shippingCarrierServices

object[]

An array of items

Show child attributes

Response

Successful response

status

boolean

required

Status of api action

Example:

true

data

object

required

Show child attributes

message

string

Success message

Example:

"Successfully created"

Last modified on March 8, 2026

Update Shipping Zone

Delete shipping zone

Update Shipping Rate

curl --request PUT \
  --url https://services.leadconnectorhq.com/store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "North zone",
  "description": "Ships next day",
  "currency": "USD",
  "amount": 99.99,
  "conditionType": "price",
  "minCondition": 99.99,
  "maxCondition": 99.99,
  "isCarrierRate": true,
  "shippingCarrierId": "655b33a82209e60b6adb87a5",
  "percentageOfRateFee": 10.99,
  "shippingCarrierServices": [
    {
      "name": "Priority Mail Express International",
      "value": "PriorityMailExpressInternational"
    }
  ]
}
'

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    altId: '6578278e879ad2646715ba9c',
    altType: 'location',
    name: 'North zone',
    description: 'Ships next day',
    currency: 'USD',
    amount: 99.99,
    conditionType: 'price',
    minCondition: 99.99,
    maxCondition: 99.99,
    isCarrierRate: true,
    shippingCarrierId: '655b33a82209e60b6adb87a5',
    percentageOfRateFee: 10.99,
    shippingCarrierServices: [
      {
        name: 'Priority Mail Express International',
        value: 'PriorityMailExpressInternational'
      }
    ]
  })
};

fetch('https://services.leadconnectorhq.com/store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}"

payload = {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "name": "North zone",
    "description": "Ships next day",
    "currency": "USD",
    "amount": 99.99,
    "conditionType": "price",
    "minCondition": 99.99,
    "maxCondition": 99.99,
    "isCarrierRate": True,
    "shippingCarrierId": "655b33a82209e60b6adb87a5",
    "percentageOfRateFee": 10.99,
    "shippingCarrierServices": [
        {
            "name": "Priority Mail Express International",
            "value": "PriorityMailExpressInternational"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{
  "status": true,
  "data": {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "name": "North zone",
    "currency": "USD",
    "amount": 99.99,
    "conditionType": "price",
    "minCondition": 99.99,
    "maxCondition": 99.99,
    "shippingCarrierId": "655b33a82209e60b6adb87a5",
    "_id": "655b33a82209e60b6adb87a5",
    "shippingZoneId": "655b33a82209e60b6adb87a5",
    "createdAt": "2023-12-12T09:27:42.355Z",
    "updatedAt": "2023-12-12T09:27:42.355Z",
    "description": "Ships next day",
    "isCarrierRate": true,
    "percentageOfRateFee": 10.99,
    "shippingCarrierServices": [
      {
        "name": "Priority Mail Express International",
        "value": "PriorityMailExpressInternational"
      }
    ]
  },
  "message": "Successfully created"
}

{
  "statusCode": 400,
  "message": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

Invoices

Payments

Products

Store

Documents & Contracts

Path Parameters

Body

Response