Logistics API: Shipping Rate Quote

Logistics API: Shipping Rate Quote

Resource

https://api.warehousefs.com/public/v1/shipping-rate-quotes

The shipping rate quotes resource represents a collection of estimated pricing for various destinations. Merchants can retrieve a list of rate quotes for the various shipping methods that Shipvine Logistics supports by sending GET requests to this resource.

GET

Request

Query Parameters

The method supports the following query parameters:

Parameter Required? Description
shipping-method Yes One of the Shipvine Logistics shipping method codes .
weight-lb Yes The estimated weight, in pounds, of the parcel. The value is only accurate to tenths of a pound.
postal-code Yes The postal code to where the parcel will be shipped.
country Yes The ISO 3166-1 two-letter code for the country to where the parcel will be shipped.
value-amount Yes The declared value of the parcel, as a decimal value.
value-currency Yes The ISO 4217 three-letter code for the currency that value-amount is specified in. Currently, only USD is accepted.

Example Query String

https://api.warehousefs.com/public/v1/shipping-rate-quotes?shipping-method=INTL-DEFERRED&weight-lb=0.6&postal-code=31500&country=FR&value-amount=26.50&value-currency=USD

Entity Body

No entity body may be specified in the request.

Response

If a rate quote is successfully obtained, the API will return 200 OK as well as a <ShippingRateQuote /> element in the entity body. See the XML schema for details about that element.

If any error occurs, the HTTP status code will not be 200 OK . An <Errors /> element may be present in the entity body.

Example Response Entity Body

<?xml version="1.0" encoding="utf-8"?>
<ShippingRateQuote xmlns="urn:WarehouseFS-1.0">
  <ShippingMethod>INTL-DEFERRED</ShippingMethod>
  <Country>FR</Country>
  <PostalCode>31500</PostalCode>
  <Weight>
    <Magnitude>0.6</Magnitude>
    <Unit>Pounds</Unit>
  </Weight>
  <Value>
    <Amount>26.50</Amount>
    <Currency>USD</Currency>
  </Value>
  <Price>
    <Amount>9.04</Amount> <!-- (1) -->
    <Currency>USD</Currency>
  </Price>
</ShippingRateQuote>
  1. The <Price /> element contains the estimated shipping cost.
    • Related Articles

    • Sample Shipping Rates

      Sample Shipping Rates Shipvine focuses on small lightweight shipping within the United States and worldwide. We offer a large range of services from UPS, FedEx, DHL, and USPS. Below are sample rates from our most popular shipping methods. Note that ...
    • Logistics API: Fulfillment Requests

      Resource #1 https://api.warehousefs.com/public/v1/fulfillment-requests The fulfillment requests resource allows the merchant to search for the Shipvine identifier assigned to requests for a given merchant identifier. GET Request Query Parameters The ...
    • Logistics API: Overview

      Shipvine provides a simple, free, open, public API that allows software developers to write custom integration solutions. (Before you go down this road, though, we recommend checking to see if we've already built an integration for your platform!) ...
    • Logistics API: Item Groups

      Resource https://api.warehousefs.com/public/v1/item-groups/{merchantCode}/{merchantIdentifier} The item groups resource allows the merchant to programmatically enter catalog information into the Shipvine Logistics system. In Shipvine's vocabulary, an ...
    • Logistics API: Tracked Returns

      Resource https://api.warehousefs.com/public/v1/tracked-returns/{merchantCode}/{merchantIdentifier} The tracked returns resource allows the merchant to provide advance notification about returns that are being mailed to Shipvine. POST Request URL ...