Get Shipping Rate

GET 
/store/shipping-zone/:shippingZoneId/shipping-rate/:shippingRateId

The "List Shipping Rate" API allows to retrieve a paginated list of shipping rate.

Request

shippingZoneId stringrequired

ID of the shipping zone

shippingRateId stringrequired

ID of the shipping rate that needs to be returned

altId stringrequired

Location Id or Agency Id

altType stringrequired

Available optionslocation

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