GET api/carrier?destinationCountry={destinationCountry}&destinationState={destinationState}&destinationZip={destinationZip}&weight={weight}&length={length}&width={width}&height={height}

Get a list of carriers and their rates for their shipping options. If the rate is null it means that we were unable to calculate it with the paramters provided.

Request Information

Parameters

Name	Description	Additional information
destinationCountry	The destination country (example: US)	Define this parameter in the request URI.
destinationState	The destination state (example: MI)	Define this parameter in the request URI.
destinationZip	The destination zip code	Define this parameter in the request URI.
weight	The weight in pounds	Define this parameter in the request URI.
length	The length in inches	Define this parameter in the request URI.
width	The width in inches	Define this parameter in the request URI.
height	The height in inches	Define this parameter in the request URI.

Response Information

A list of carriers and their rates for their shipping options. If the rate is null it means that we were unable to calculate it with the paramters provided.

Response body formats

application/json, text/json

Sample:

{
  "Carriers": [
    {
      "Id": "73e49039-2032-4625-b51a-66b83545a05d",
      "Name": "sample string 2",
      "ShippingOptions": [
        {
          "Id": 1,
          "Description": "sample string 2",
          "Rate": 1.0,
          "TransitTimeInDays": 1
        },
        {
          "Id": 1,
          "Description": "sample string 2",
          "Rate": 1.0,
          "TransitTimeInDays": 1
        },
        {
          "Id": 1,
          "Description": "sample string 2",
          "Rate": 1.0,
          "TransitTimeInDays": 1
        }
      ]
    },
    {
      "Id": "73e49039-2032-4625-b51a-66b83545a05d",
      "Name": "sample string 2",
      "ShippingOptions": [
        {
          "Id": 1,
          "Description": "sample string 2",
          "Rate": 1.0,
          "TransitTimeInDays": 1
        },
        {
          "Id": 1,
          "Description": "sample string 2",
          "Rate": 1.0,
          "TransitTimeInDays": 1
        },
        {
          "Id": 1,
          "Description": "sample string 2",
          "Rate": 1.0,
          "TransitTimeInDays": 1
        }
      ]
    },
    {
      "Id": "73e49039-2032-4625-b51a-66b83545a05d",
      "Name": "sample string 2",
      "ShippingOptions": [
        {
          "Id": 1,
          "Description": "sample string 2",
          "Rate": 1.0,
          "TransitTimeInDays": 1
        },
        {
          "Id": 1,
          "Description": "sample string 2",
          "Rate": 1.0,
          "TransitTimeInDays": 1
        },
        {
          "Id": 1,
          "Description": "sample string 2",
          "Rate": 1.0,
          "TransitTimeInDays": 1
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<CarrierResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Carriers>
    <Carrier>
      <Id>73e49039-2032-4625-b51a-66b83545a05d</Id>
      <Name>sample string 2</Name>
      <ShippingOptions>
        <ShippingOptionsDTO>
          <Id>1</Id>
          <Description>sample string 2</Description>
          <Rate>1</Rate>
          <TransitTimeInDays>1</TransitTimeInDays>
        </ShippingOptionsDTO>
        <ShippingOptionsDTO>
          <Id>1</Id>
          <Description>sample string 2</Description>
          <Rate>1</Rate>
          <TransitTimeInDays>1</TransitTimeInDays>
        </ShippingOptionsDTO>
        <ShippingOptionsDTO>
          <Id>1</Id>
          <Description>sample string 2</Description>
          <Rate>1</Rate>
          <TransitTimeInDays>1</TransitTimeInDays>
        </ShippingOptionsDTO>
      </ShippingOptions>
    </Carrier>
    <Carrier>
      <Id>73e49039-2032-4625-b51a-66b83545a05d</Id>
      <Name>sample string 2</Name>
      <ShippingOptions>
        <ShippingOptionsDTO>
          <Id>1</Id>
          <Description>sample string 2</Description>
          <Rate>1</Rate>
          <TransitTimeInDays>1</TransitTimeInDays>
        </ShippingOptionsDTO>
        <ShippingOptionsDTO>
          <Id>1</Id>
          <Description>sample string 2</Description>
          <Rate>1</Rate>
          <TransitTimeInDays>1</TransitTimeInDays>
        </ShippingOptionsDTO>
        <ShippingOptionsDTO>
          <Id>1</Id>
          <Description>sample string 2</Description>
          <Rate>1</Rate>
          <TransitTimeInDays>1</TransitTimeInDays>
        </ShippingOptionsDTO>
      </ShippingOptions>
    </Carrier>
    <Carrier>
      <Id>73e49039-2032-4625-b51a-66b83545a05d</Id>
      <Name>sample string 2</Name>
      <ShippingOptions>
        <ShippingOptionsDTO>
          <Id>1</Id>
          <Description>sample string 2</Description>
          <Rate>1</Rate>
          <TransitTimeInDays>1</TransitTimeInDays>
        </ShippingOptionsDTO>
        <ShippingOptionsDTO>
          <Id>1</Id>
          <Description>sample string 2</Description>
          <Rate>1</Rate>
          <TransitTimeInDays>1</TransitTimeInDays>
        </ShippingOptionsDTO>
        <ShippingOptionsDTO>
          <Id>1</Id>
          <Description>sample string 2</Description>
          <Rate>1</Rate>
          <TransitTimeInDays>1</TransitTimeInDays>
        </ShippingOptionsDTO>
      </ShippingOptions>
    </Carrier>
  </Carriers>
</CarrierResults>