GET api/carrier

Get a list of all available carriers and their shipping options. An id of a shipping option is required to create an order.

Response Information

Returns a list of all available carriers and their shipping options.

Response body formats

application/json, text/json

Sample:

{
  "Carriers": [
    {
      "Id": "0018dee2-4904-49d3-a63a-016603a50d46",
      "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": "0018dee2-4904-49d3-a63a-016603a50d46",
      "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": "0018dee2-4904-49d3-a63a-016603a50d46",
      "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>0018dee2-4904-49d3-a63a-016603a50d46</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>0018dee2-4904-49d3-a63a-016603a50d46</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>0018dee2-4904-49d3-a63a-016603a50d46</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>