POST api-token/Shop/FreightQuote

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
rate		RateRequest	None.

Request Formats

application/json, text/json

Sample:

{
  "rate": {
    "origin": {
      "country": "sample string 1",
      "postal_code": "sample string 2",
      "province": "sample string 3",
      "city": "sample string 4",
      "name": "sample string 5",
      "address1": "sample string 6",
      "address2": "sample string 7",
      "address3": "sample string 8",
      "phone": "sample string 9",
      "fax": "sample string 10",
      "email": "sample string 11",
      "address_type": "sample string 12",
      "company_name": "sample string 13"
    },
    "destination": {
      "country": "sample string 1",
      "postal_code": "sample string 2",
      "province": "sample string 3",
      "city": "sample string 4",
      "name": "sample string 5",
      "address1": "sample string 6",
      "address2": "sample string 7",
      "address3": "sample string 8",
      "phone": "sample string 9",
      "fax": "sample string 10",
      "email": "sample string 11",
      "address_type": "sample string 12",
      "company_name": "sample string 13"
    },
    "items": [
      {
        "name": "sample string 1",
        "sku": "sample string 2",
        "quantity": 3,
        "grams": 4,
        "price": 5,
        "vendor": "sample string 6",
        "requires_shipping": true,
        "taxable": true,
        "fulfillment_service": "sample string 9",
        "product_id": 10,
        "variant_id": 11
      },
      {
        "name": "sample string 1",
        "sku": "sample string 2",
        "quantity": 3,
        "grams": 4,
        "price": 5,
        "vendor": "sample string 6",
        "requires_shipping": true,
        "taxable": true,
        "fulfillment_service": "sample string 9",
        "product_id": 10,
        "variant_id": 11
      }
    ],
    "currency": "sample string 1",
    "locale": "sample string 2"
  }
}

text/html

Sample:

{"rate":{"origin":{"country":"sample string 1","postal_code":"sample string 2","province":"sample string 3","city":"sample string 4","name":"sample string 5","address1":"sample string 6","address2":"sample string 7","address3":"sample string 8","phone":"sample string 9","fax":"sample string 10","email":"sample string 11","address_type":"sample string 12","company_name":"sample string 13"},"destination":{"country":"sample string 1","postal_code":"sample string 2","province":"sample string 3","city":"sample string 4","name":"sample string 5","address1":"sample string 6","address2":"sample string 7","address3":"sample string 8","phone":"sample string 9","fax":"sample string 10","email":"sample string 11","address_type":"sample string 12","company_name":"sample string 13"},"items":[{"name":"sample string 1","sku":"sample string 2","quantity":3,"grams":4,"price":5,"vendor":"sample string 6","requires_shipping":true,"taxable":true,"fulfillment_service":"sample string 9","product_id":10,"variant_id":11},{"name":"sample string 1","sku":"sample string 2","quantity":3,"grams":4,"price":5,"vendor":"sample string 6","requires_shipping":true,"taxable":true,"fulfillment_service":"sample string 9","product_id":10,"variant_id":11}],"currency":"sample string 1","locale":"sample string 2"}}

application/xml, text/xml

Sample:

<ShopifyFreightQuoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turbon.Data.Shopify.Models.CarrierService">
  <rate>
    <currency>sample string 1</currency>
    <destination>
      <address1>sample string 6</address1>
      <address2>sample string 7</address2>
      <address3>sample string 8</address3>
      <address_type>sample string 12</address_type>
      <city>sample string 4</city>
      <company_name>sample string 13</company_name>
      <country>sample string 1</country>
      <email>sample string 11</email>
      <fax>sample string 10</fax>
      <name>sample string 5</name>
      <phone>sample string 9</phone>
      <postal_code>sample string 2</postal_code>
      <province>sample string 3</province>
    </destination>
    <items>
      <item>
        <fulfillment_service>sample string 9</fulfillment_service>
        <grams>4</grams>
        <name>sample string 1</name>
        <price>5</price>
        <product_id>10</product_id>
        <quantity>3</quantity>
        <requires_shipping>true</requires_shipping>
        <sku>sample string 2</sku>
        <taxable>true</taxable>
        <variant_id>11</variant_id>
        <vendor>sample string 6</vendor>
      </item>
      <item>
        <fulfillment_service>sample string 9</fulfillment_service>
        <grams>4</grams>
        <name>sample string 1</name>
        <price>5</price>
        <product_id>10</product_id>
        <quantity>3</quantity>
        <requires_shipping>true</requires_shipping>
        <sku>sample string 2</sku>
        <taxable>true</taxable>
        <variant_id>11</variant_id>
        <vendor>sample string 6</vendor>
      </item>
    </items>
    <locale>sample string 2</locale>
    <origin>
      <address1>sample string 6</address1>
      <address2>sample string 7</address2>
      <address3>sample string 8</address3>
      <address_type>sample string 12</address_type>
      <city>sample string 4</city>
      <company_name>sample string 13</company_name>
      <country>sample string 1</country>
      <email>sample string 11</email>
      <fax>sample string 10</fax>
      <name>sample string 5</name>
      <phone>sample string 9</phone>
      <postal_code>sample string 2</postal_code>
      <province>sample string 3</province>
    </origin>
  </rate>
</ShopifyFreightQuoteRequest>

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 'ShopifyFreightQuoteRequest'.

Response Information

Resource Description

ShopifyFreightQuoteResponse

Name	Description	Type	Additional information
rates		Collection of rate	None.

Response Formats

application/json, text/json

Sample:

{
  "rates": [
    {
      "service_name": "sample string 1",
      "service_code": "sample string 2",
      "total_price": "sample string 3",
      "description": "sample string 4",
      "currency": "sample string 5",
      "min_delivery_date": "sample string 6",
      "max_delivery_date": "sample string 7"
    },
    {
      "service_name": "sample string 1",
      "service_code": "sample string 2",
      "total_price": "sample string 3",
      "description": "sample string 4",
      "currency": "sample string 5",
      "min_delivery_date": "sample string 6",
      "max_delivery_date": "sample string 7"
    }
  ]
}

text/html

Sample:

{"rates":[{"service_name":"sample string 1","service_code":"sample string 2","total_price":"sample string 3","description":"sample string 4","currency":"sample string 5","min_delivery_date":"sample string 6","max_delivery_date":"sample string 7"},{"service_name":"sample string 1","service_code":"sample string 2","total_price":"sample string 3","description":"sample string 4","currency":"sample string 5","min_delivery_date":"sample string 6","max_delivery_date":"sample string 7"}]}

application/xml, text/xml

Sample:

<ShopifyFreightQuoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turbon.Data.Shopify.Models.CarrierService">
  <rates>
    <rate>
      <currency>sample string 5</currency>
      <description>sample string 4</description>
      <max_delivery_date>sample string 7</max_delivery_date>
      <min_delivery_date>sample string 6</min_delivery_date>
      <service_code>sample string 2</service_code>
      <service_name>sample string 1</service_name>
      <total_price>sample string 3</total_price>
    </rate>
    <rate>
      <currency>sample string 5</currency>
      <description>sample string 4</description>
      <max_delivery_date>sample string 7</max_delivery_date>
      <min_delivery_date>sample string 6</min_delivery_date>
      <service_code>sample string 2</service_code>
      <service_name>sample string 1</service_name>
      <total_price>sample string 3</total_price>
    </rate>
  </rates>
</ShopifyFreightQuoteResponse>