Shipping - POST

Get a shipping quote.

api/{role}/shipping/quote

Request Information

PropertyNoteConstraints
role : string

Model

PropertyNoteConstraints
Value : string

A value that is a box size or sku depending on the value type

Required
ValueType : ShippingQuoteRequestValueType

Determines what "Value" is. Defaults to Box Size.

  • 0 = Box Size
  • 1 = Sku
Zip : string

Zip Code

Required
IsResidential : boolean

Request Formats

application/json, text/json

{
  "value": "test 1",
  "valueType": 0,
  "zip": "test 2",
  "isResidential": true
}

application/xml, text/xml

<ShippingQuoteDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS.Services">
  <IsResidential>true</IsResidential>
  <Value>test 1</Value>
  <ValueType>BoxSize</ValueType>
  <Zip>test 2</Zip>
</ShippingQuoteDto>

Response Information

PropertyNoteConstraints
Sites : Array<ShippingQuoteSite>

A list of facilities that we ship from. Site codes correspond to US State abbreviations
errors : Array<string>

A list of errors
hasErrors : boolean

Determines if errors exist

Response Formats

application/json, text/json

{
  "sites": [
    {
      "site": "test 1",
      "errors": [
        "test 1",
        "test 2"
      ],
      "hasErrors": true,
      "rates": [
        {
          "method": "test 1",
          "cost": 2.0,
          "serviceType": "test 3"
        },
        {
          "method": "test 1",
          "cost": 2.0,
          "serviceType": "test 3"
        }
      ]
    },
    {
      "site": "test 1",
      "errors": [
        "test 1",
        "test 2"
      ],
      "hasErrors": true,
      "rates": [
        {
          "method": "test 1",
          "cost": 2.0,
          "serviceType": "test 3"
        },
        {
          "method": "test 1",
          "cost": 2.0,
          "serviceType": "test 3"
        }
      ]
    }
  ],
  "errors": [
    "test 1",
    "test 2"
  ],
  "hasErrors": true
}

application/xml, text/xml

<ShippingQuoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS.Services">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>test 1</d2p1:string>
    <d2p1:string>test 2</d2p1:string>
  </Errors>
  <Sites>
    <ShippingQuoteSite>
      <Errors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>test 1</d4p1:string>
        <d4p1:string>test 2</d4p1:string>
      </Errors>
      <Rates xmlns:d4p1="http://schemas.datacontract.org/2004/07/">
        <d4p1:FedExRateResponse>
          <d4p1:Cost>2</d4p1:Cost>
          <d4p1:Method>test 1</d4p1:Method>
          <d4p1:ServiceType>test 3</d4p1:ServiceType>
        </d4p1:FedExRateResponse>
        <d4p1:FedExRateResponse>
          <d4p1:Cost>2</d4p1:Cost>
          <d4p1:Method>test 1</d4p1:Method>
          <d4p1:ServiceType>test 3</d4p1:ServiceType>
        </d4p1:FedExRateResponse>
      </Rates>
      <Site>test 1</Site>
    </ShippingQuoteSite>
    <ShippingQuoteSite>
      <Errors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>test 1</d4p1:string>
        <d4p1:string>test 2</d4p1:string>
      </Errors>
      <Rates xmlns:d4p1="http://schemas.datacontract.org/2004/07/">
        <d4p1:FedExRateResponse>
          <d4p1:Cost>2</d4p1:Cost>
          <d4p1:Method>test 1</d4p1:Method>
          <d4p1:ServiceType>test 3</d4p1:ServiceType>
        </d4p1:FedExRateResponse>
        <d4p1:FedExRateResponse>
          <d4p1:Cost>2</d4p1:Cost>
          <d4p1:Method>test 1</d4p1:Method>
          <d4p1:ServiceType>test 3</d4p1:ServiceType>
        </d4p1:FedExRateResponse>
      </Rates>
      <Site>test 1</Site>
    </ShippingQuoteSite>
  </Sites>
</ShippingQuoteResponse>
Back To API Explorer