POST api/Rates

Create updated rate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Description	Additional information
Client	string
ServiceTypes	Collection of string
Carriers	Collection of string
ToAddress	AddressV4
FromAddress	AddressV4
ShipDate	date
Packages	Collection of RatePackageRequestV4

Request Formats

application/json, text/json

Sample:

{
  "Client": "sample string 1",
  "ServiceTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "Carriers": [
    "sample string 1",
    "sample string 2"
  ],
  "ToAddress": {
    "Name": "sample string 1",
    "Company": "sample string 2",
    "Phone": "sample string 3",
    "Email": "sample string 4",
    "IsResidential": true,
    "Description": "sample string 5",
    "Id": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "Address3": "sample string 9",
    "City": "sample string 10",
    "StateProvince": "sample string 11",
    "PostalCode": "sample string 12",
    "Country": "sample string 13",
    "Option": 0
  },
  "FromAddress": {
    "Name": "sample string 1",
    "Company": "sample string 2",
    "Phone": "sample string 3",
    "Email": "sample string 4",
    "IsResidential": true,
    "Description": "sample string 5",
    "Id": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "Address3": "sample string 9",
    "City": "sample string 10",
    "StateProvince": "sample string 11",
    "PostalCode": "sample string 12",
    "Country": "sample string 13",
    "Option": 0
  },
  "ShipDate": "2024-10-13T13:46:05.5661743+00:00",
  "Packages": [
    {
      "Height": 1.0,
      "Length": 1.0,
      "Width": 1.0,
      "DimensionUnit": "sample string 1",
      "Weight": 1.0,
      "WeightUnit": "sample string 2",
      "PackageType": "sample string 3"
    },
    {
      "Height": 1.0,
      "Length": 1.0,
      "Width": 1.0,
      "DimensionUnit": "sample string 1",
      "Weight": 1.0,
      "WeightUnit": "sample string 2",
      "PackageType": "sample string 3"
    }
  ],
  "Options": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<RatesRequestV4 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Client>sample string 1</Client>
  <ServiceTypes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </ServiceTypes>
  <Carriers>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Carriers>
  <ToAddress>
    <IsResidential>true</IsResidential>
    <Description>sample string 5</Description>
    <Id>sample string 6</Id>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <Address3>sample string 9</Address3>
    <City>sample string 10</City>
    <StateProvince>sample string 11</StateProvince>
    <PostalCode>sample string 12</PostalCode>
    <Country>sample string 13</Country>
    <Option>None</Option>
    <Name>sample string 1</Name>
    <Company>sample string 2</Company>
    <Phone>sample string 3</Phone>
    <Email>sample string 4</Email>
  </ToAddress>
  <FromAddress>
    <IsResidential>true</IsResidential>
    <Description>sample string 5</Description>
    <Id>sample string 6</Id>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <Address3>sample string 9</Address3>
    <City>sample string 10</City>
    <StateProvince>sample string 11</StateProvince>
    <PostalCode>sample string 12</PostalCode>
    <Country>sample string 13</Country>
    <Option>None</Option>
    <Name>sample string 1</Name>
    <Company>sample string 2</Company>
    <Phone>sample string 3</Phone>
    <Email>sample string 4</Email>
  </FromAddress>
  <ShipDate>2024-10-13T13:46:05.5661743+00:00</ShipDate>
  <Packages>
    <RatePackageRequestV4>
      <Height>1</Height>
      <Length>1</Length>
      <Width>1</Width>
      <DimensionUnit>sample string 1</DimensionUnit>
      <Weight>1</Weight>
      <WeightUnit>sample string 2</WeightUnit>
      <PackageType>sample string 3</PackageType>
    </RatePackageRequestV4>
    <RatePackageRequestV4>
      <Height>1</Height>
      <Length>1</Length>
      <Width>1</Width>
      <DimensionUnit>sample string 1</DimensionUnit>
      <Weight>1</Weight>
      <WeightUnit>sample string 2</WeightUnit>
      <PackageType>sample string 3</PackageType>
    </RatePackageRequestV4>
  </Packages>
</RatesRequestV4>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.