POST api/Shipping/GetRate

Request Information

URI Parameters

None.

Body Parameters

ShippingRequest
NameDescriptionTypeAdditional information
ShippingAccount

ShippingAccount

Required

OriginAddress

ShippingAddress

Required

DestinationAddress

ShippingAddress

Required

BillingAddress

ShippingAddress

None.

ShippingPackages

Collection of ShippingPackage

Required

ShippingSpeed

ShippingSpeed

Required

Request Formats

application/json, text/json

Sample:
{
  "ShippingAccount": {
    "Username": "sample string 1",
    "Password": "sample string 2"
  },
  "OriginAddress": {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "Address3": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "PostCode": "sample string 6",
    "Country": "sample string 7",
    "IsResidential": true
  },
  "DestinationAddress": {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "Address3": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "PostCode": "sample string 6",
    "Country": "sample string 7",
    "IsResidential": true
  },
  "BillingAddress": {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "Address3": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "PostCode": "sample string 6",
    "Country": "sample string 7",
    "IsResidential": true
  },
  "ShippingPackages": [
    {
      "Description": "sample string 1",
      "Weight": 2.1,
      "Length": 3.0,
      "Width": 4.0,
      "Height": 5.0,
      "PackageType": "sample string 6",
      "SignatureRequired": true
    },
    {
      "Description": "sample string 1",
      "Weight": 2.1,
      "Length": 3.0,
      "Width": 4.0,
      "Height": 5.0,
      "PackageType": "sample string 6",
      "SignatureRequired": true
    }
  ],
  "ShippingSpeed": 0
}

application/xml, text/xml

Sample:
<ShippingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EzytireShippingServices.Models">
  <BillingAddress>
    <Address1>sample string 1</Address1>
    <Address2>sample string 2</Address2>
    <Address3>sample string 3</Address3>
    <City>sample string 4</City>
    <Country>sample string 7</Country>
    <IsResidential>true</IsResidential>
    <PostCode>sample string 6</PostCode>
    <State>sample string 5</State>
  </BillingAddress>
  <DestinationAddress>
    <Address1>sample string 1</Address1>
    <Address2>sample string 2</Address2>
    <Address3>sample string 3</Address3>
    <City>sample string 4</City>
    <Country>sample string 7</Country>
    <IsResidential>true</IsResidential>
    <PostCode>sample string 6</PostCode>
    <State>sample string 5</State>
  </DestinationAddress>
  <OriginAddress>
    <Address1>sample string 1</Address1>
    <Address2>sample string 2</Address2>
    <Address3>sample string 3</Address3>
    <City>sample string 4</City>
    <Country>sample string 7</Country>
    <IsResidential>true</IsResidential>
    <PostCode>sample string 6</PostCode>
    <State>sample string 5</State>
  </OriginAddress>
  <ShippingAccount>
    <Password>sample string 2</Password>
    <Username>sample string 1</Username>
  </ShippingAccount>
  <ShippingPackages>
    <ShippingPackage>
      <Description>sample string 1</Description>
      <Height>5</Height>
      <Length>3</Length>
      <PackageType>sample string 6</PackageType>
      <SignatureRequired>true</SignatureRequired>
      <Weight>2.1</Weight>
      <Width>4</Width>
    </ShippingPackage>
    <ShippingPackage>
      <Description>sample string 1</Description>
      <Height>5</Height>
      <Length>3</Length>
      <PackageType>sample string 6</PackageType>
      <SignatureRequired>true</SignatureRequired>
      <Weight>2.1</Weight>
      <Width>4</Width>
    </ShippingPackage>
  </ShippingPackages>
  <ShippingSpeed>Unspecified</ShippingSpeed>
</ShippingRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ShippingRequest'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.