POST: /api/v1/ShipmentRate

This document provides information about the `POST /api/v1/ShipmentRate` endpoint, which allows you to get shipment rate estimates for a given shipment request.

Endpoint

```
POST https://api-qa.kloudship.com:96/api/v1/ShipmentRate
```

Headers

- `transactionId` (required): A unique identifier for the transaction.

Body

The request body should be in JSON format and include the following parameters:

1. `addressFrom` (object, required): The origin address details.
   1. `name` (string, required): Name of the sender or return center.
   2. `company` (string): Company name of the sender.
   3. `street1` (string, required): First line of the sender's address.
   4. `street2` (string): Second line of the sender's address.
   5. `city` (string, required): City of the sender's address.
   6. `state` (string, required): State of the sender's address.
   7. `zip` (string, required): ZIP or postal code of the sender's address.
   8. `country` (string, required): Country code (ISO 3166-1 alpha-2) of the sender's address.
   9. `phone` (string, required): Phone number of the sender.
   10. `email` (string, required): Email address of the sender.
   11. `verify` (boolean): Indicates whether the address needs to be verified.
   12. `latitude` (number): Latitude coordinate of the sender's address.
   13. `longitude` (number): Longitude coordinate of the sender's address.
2. `addressTo` (object, required): The destination address details.
   1. (Same structure as `addressFrom`)
3. `package` (object, required): Package details.
   1. `packageType` (string, required): Type of the package (e.g., "Parcel").
   2. `length`, `width`, `height` (numbers, required): Dimensions of the package in inches.
   3. `weight` (number, required): Weight of the package in pounds.
4. `deliveryType` (string, required): Type of delivery ("SCHEDULED" in this example).
5. `paymentmethod` (string, required): Payment method ("Prepaid" in this example).
6. `valueAmount` (number, required): Value of the shipment.

Response

The response will be in JSON format and will contain the following fields:

1. `rates` (array): An array of rate estimates for different carriers and services.
   1. `carrier` (object): Carrier information.
   2. `carrierAccount` (object): Carrier account information.
   3. `service` (object): Service details.
   4. `ValueCurrency` (string): Currency code for the rates.
   5. `totalFee` (number): Total fee for the shipment.
   6. `finalWeight` (number): Final weight of the shipment.
   7. `finalVolume` (number): Final volume of the shipment.
   8. `fee` (array): Array of fee details.
      1. `packageNumber` (number): Package number.
      2. `cost` (number): Cost value.
      3. `costType` (string): Type of cost (e.g., "Base", "COD", "Delivery").
   9. `FinalWeightUnit` (string): Unit of measurement for the final weight.
   10. `FinalDimensionUnit` (string): Unit of measurement for the final dimensions.
   11. Additional carrier-specific fields as required.
2. `errors` (array): An array of error messages related to carriers.
   1. `source` (string): Source of the error.
   2. `carrierCode` (string): Carrier code.
   3. `carrierAccountId` (string): Carrier account ID.
   4. `carrierAccountName` (string): Carrier account name.
   5. `code` (string): Error code.
   6. `message` (string): Error message.
3. `warnings` (array): An array of warning messages.

Example Request

{
    "addressFrom": {
        "name": "Return Center",
        ...
    },
    "addressTo": {
        "name": "Front Desk",
        ...
    },
    "package": {
        "packageType": "Parcel",
        ...
    },
    ...
}

Example Response

{
    "rates": [
        {
            "carrier": {
                "id": "63ad5ed16cc42987d5e46709",
                ...
            },
            ...
        },
        {
            "carrier": {
                "id": "63ad5d6d694ebc79012d06b2",
                ...
            },
            ...
        }
    ],
    "errors": [
        {
            "source": "KloudShip.CSA",
            ...
        },
        {
            "source": "KloudShip.CSA",
            ...
        }
    ],
    "warnings": []
}
```