Create Shipping Rate

POST 
/store/shipping-zone/:shippingZoneId/shipping-rate

The "Create Shipping Rate" API allows adding a new shipping rate.

Request

shippingZoneId stringrequired

ID of the item that needs to be returned

application/json

application/json

Body

Bodyrequired

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
namestringrequired

Name of the shipping zone

descriptionstring

Delivery description

currencystringrequired

The currency of the amount of the rate / handling fee

amountnumberrequired

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).

conditionTypestringrequired
Type of condition to provide the conditional pricing
Available optionsnonepriceweight
minConditionnumberrequired

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

maxConditionnumberrequired

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

isCarrierRateboolean

is this a carrier rate

shippingCarrierIdstringrequired

Shipping carrier id

percentageOfRateFeenumber

Percentage of rate fee if it is a carrier rate.

shippingCarrierServicesobject[]

An array of items

Example (auto)

{
  "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"
    }
  ]
}

application/json

Successful response

application/json

Schema

Schema

statusbooleanrequired

Status of api action

messagestring

Success message

dataobjectrequired

Shipping zone data

Example (auto)

{
  "status": true,
  "message": "Successfully created",
  "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"
      }
    ],
    "_id": "655b33a82209e60b6adb87a5",
    "shippingZoneId": "655b33a82209e60b6adb87a5",
    "createdAt": "2023-12-12T09:27:42.355Z",
    "updatedAt": "2023-12-12T09:27:42.355Z"
  }
}