POST api/Labels/ShippingPrices

Search the shipping prices from available carriers.

Request Information

URI Parameters

None.

Body Parameters

LabelPricesRequest
NameDescriptionTypeAdditional information
location

WAREHOUSE_LOCATION

None.

shipTo

AddressSimple

None.

weight

decimal number

None.

isDiscounted

boolean

None.

isResidential

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "location": "ALL",
  "shipTo": {
    "state": "sample string 1",
    "countryCode": "sample string 2",
    "zip": "sample string 3"
  },
  "weight": 1.0,
  "isDiscounted": true,
  "isResidential": true
}

application/xml, text/xml

Sample:
<LabelPricesRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <location>ALL</location>
  <shipTo>
    <state>sample string 1</state>
    <countryCode>sample string 2</countryCode>
    <zip>sample string 3</zip>
  </shipTo>
  <weight>1</weight>
  <isDiscounted>true</isDiscounted>
  <isResidential>true</isResidential>
</LabelPricesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseApiInfoOfLabelPricesResponse
NameDescriptionTypeAdditional information
data

LabelPricesResponse

None.

UpdateResult

UPDATECODE

None.

isErrorOnRequest

boolean

None.

errorMessage

string

None.

errorMessages

Collection of ErrorInfo

None.

warningMessages

Collection of ErrorInfo

None.

isSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "data": {
    "prices": [
      {
        "shippingCompany": "FEDEX",
        "shippingTypeCode": "USPS_First",
        "carrierDetail1": "sample string 1",
        "carrierDetail2": "sample string 2",
        "carrierDetail3": "sample string 3",
        "isSignature": true,
        "isFlatRate": true,
        "isFreight": true,
        "price": 7.0
      },
      {
        "shippingCompany": "FEDEX",
        "shippingTypeCode": "USPS_First",
        "carrierDetail1": "sample string 1",
        "carrierDetail2": "sample string 2",
        "carrierDetail3": "sample string 3",
        "isSignature": true,
        "isFlatRate": true,
        "isFreight": true,
        "price": 7.0
      }
    ]
  },
  "UpdateResult": "CREATE",
  "isErrorOnRequest": true,
  "errorMessage": null,
  "errorMessages": [],
  "warningMessages": []
}

application/xml, text/xml

Sample:
<xml xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isSuccess>true</isSuccess>
  <UpdateResult>CREATE</UpdateResult>
  <isErrorOnRequest>true</isErrorOnRequest>
  <errorMessages />
  <warningMessages />
  <data>
    <prices>
      <ShippingPriceInfo>
        <shippingCompany>FEDEX</shippingCompany>
        <shippingTypeCode>USPS_First</shippingTypeCode>
        <carrierDetail1>sample string 1</carrierDetail1>
        <carrierDetail2>sample string 2</carrierDetail2>
        <carrierDetail3>sample string 3</carrierDetail3>
        <isSignature>true</isSignature>
        <isFlatRate>true</isFlatRate>
        <isFreight>true</isFreight>
        <price>7</price>
      </ShippingPriceInfo>
      <ShippingPriceInfo>
        <shippingCompany>FEDEX</shippingCompany>
        <shippingTypeCode>USPS_First</shippingTypeCode>
        <carrierDetail1>sample string 1</carrierDetail1>
        <carrierDetail2>sample string 2</carrierDetail2>
        <carrierDetail3>sample string 3</carrierDetail3>
        <isSignature>true</isSignature>
        <isFlatRate>true</isFlatRate>
        <isFreight>true</isFreight>
        <price>7</price>
      </ShippingPriceInfo>
    </prices>
  </data>
</xml>