Get available shipping rates

POST 
/store/shipping-zone/shipping-rates

This return available shipping rates for country based on order amount

Request

application/json

application/json

Body

Bodyrequired

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
countrystringrequired
Country code of the customer
Available optionsUSCAAFAXALDZASADAOAIAQAG
addressobject

Address of the customer

amountAvailablestring
it will not calculate the order amount form backend if it is true
Available optionsAFAXALDZASADAOAIAQAGARAM
totalOrderAmountnumberrequired

The amount of the price. ( min: 0.01 )

weightAvailableboolean

Flag to pass when the weight is already calculated and should not calculate again

totalOrderWeightnumberrequired

Estimated weight of the order calculated from the order creation side in kg(s)

sourceobjectrequired

Source of the order

productsobject[]required

An array of price IDs and quantity

couponCodestring

Coupon code

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "country": "US",
  "address": {
    "name": "John Doe",
    "companyName": "ABC Company",
    "addressLine1": "123 Main St.",
    "country": "US",
    "state": "US",
    "city": "New York",
    "zip": "12345",
    "phone": "1234567890",
    "email": "[email protected]"
  },
  "amountAvailable": "US",
  "totalOrderAmount": 99.99,
  "weightAvailable": true,
  "totalOrderWeight": 10,
  "source": {
    "type": "order",
    "subType": "store"
  },
  "products": [
    {
      "id": "string",
      "qty": 0
    }
  ],
  "couponCode": "TEST"
}

application/json

Successful response

application/json

Schema

Schema

statusbooleanrequired

Status of api action

messagestring

Success message

dataobject[]required

Shipping rate data

Example (auto)

{
  "status": true,
  "message": "Successfully created",
  "data": [
    {
      "name": "North zone",
      "description": "Ships next day",
      "currency": "USD",
      "amount": 99.99,
      "isCarrierRate": true,
      "shippingCarrierId": "655b33a82209e60b6adb87a5",
      "percentageOfRateFee": 10.99,
      "shippingCarrierServices": [
        {
          "name": "Priority Mail Express International",
          "value": "PriorityMailExpressInternational"
        }
      ],
      "_id": "655b33a82209e60b6adb87a5",
      "shippingZoneId": "655b33a82209e60b6adb87a5"
    }
  ]
}