Skip to content

RatesApi.md

Latest commit

 

History

History
233 lines (191 loc) · 8.19 KB

RatesApi.md

File metadata and controls

233 lines (191 loc) · 8.19 KB

Rates Methods

Method Description
CalculateRates Get Shipping Rates
CompareBulkRates Get Bulk Rates
EstimateRates Estimate Rates
GetRateById Get Rate By ID

CalculateRates

CalculateRatesResponseBody CalculateRates (CalculateRatesRequestBody calculateRatesRequestBody, CancellationToken cancellationToken = default)

CalculateRatesResponseBody CalculateRates (HttpClient methodClient, CalculateRatesRequestBody calculateRatesRequestBody, CancellationToken cancellationToken = default)

Get Shipping Rates

It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options!

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class CalculateRatesExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var calculateRatesRequestBody = new CalculateRatesRequestBody();

            try
            {
                // Get Shipping Rates
                CalculateRatesResponseBody result = await shipEngine.CalculateRates(calculateRatesRequestBody);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling RatesApi.CalculateRates: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
calculateRatesRequestBody CalculateRatesRequestBody
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

CalculateRatesResponseBody

CompareBulkRates

List<BulkRate> CompareBulkRates (CompareBulkRatesRequestBody compareBulkRatesRequestBody, CancellationToken cancellationToken = default)

List<BulkRate> CompareBulkRates (HttpClient methodClient, CompareBulkRatesRequestBody compareBulkRatesRequestBody, CancellationToken cancellationToken = default)

Get Bulk Rates

Get Bulk Shipment Rates

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class CompareBulkRatesExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var compareBulkRatesRequestBody = new CompareBulkRatesRequestBody();

            try
            {
                // Get Bulk Rates
                List<BulkRate> result = await shipEngine.CompareBulkRates(compareBulkRatesRequestBody);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling RatesApi.CompareBulkRates: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
compareBulkRatesRequestBody CompareBulkRatesRequestBody
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

List<BulkRate>

EstimateRates

List&lt;RateEstimate&gt; EstimateRates (EstimateRatesRequestBody estimateRatesRequestBody, CancellationToken cancellationToken = default)

List&lt;RateEstimate&gt; EstimateRates (HttpClient methodClient, EstimateRatesRequestBody estimateRatesRequestBody, CancellationToken cancellationToken = default)

Estimate Rates

Get Rate Estimates

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class EstimateRatesExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var estimateRatesRequestBody = new EstimateRatesRequestBody();

            try
            {
                // Estimate Rates
                List<RateEstimate> result = await shipEngine.EstimateRates(estimateRatesRequestBody);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling RatesApi.EstimateRates: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
estimateRatesRequestBody EstimateRatesRequestBody
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

List<RateEstimate>

GetRateById

GetRateByIdResponseBody GetRateById (string rateId, CancellationToken cancellationToken = default)

GetRateByIdResponseBody GetRateById (HttpClient methodClient, string rateId, CancellationToken cancellationToken = default)

Get Rate By ID

Retrieve a previously queried rate by its ID

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class GetRateByIdExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var rateId = "rateId_example";

            try
            {
                // Get Rate By ID
                GetRateByIdResponseBody result = await shipEngine.GetRateById(rateId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling RatesApi.GetRateById: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
rateId string Rate ID
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

GetRateByIdResponseBody