ShippableItemDTO Object

Overview

The REST API occasionally makes use of the ShippableItemDTO object when working with products.  This article will help you to know the various members of this object.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

There are no tasks needed to get started with understanding this object. 

ShippableItemDTO

The ShippableItemDTO object will contain all of the details of a single instance of shipping details for products in your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the ShippableDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
ExtraShipFee 0.00 If greater than zero, the specified fee should be added to the shipping fee presented to the customer.
Height 0.00 The shippable height of the product in inches.
IsNonShipping False If true, the associated product will not be shipped and therefore should not have shipping logic applied.
Length 0.00 The shippable length of the product in inches.
ShippingSource 1 This defines where the product will be shipped from.  Possible values include:
  • None = 0
  • ShipFromSite = 1
  • ShipFromVendor = 2
  • ShipFromManufacturer = 3
ShippingSourceId (empty string) This ID value should match a vendor or manufacture when that respective ShippingSource is specified.
ShipSeparately False If true, the associated product cannot be shipped with other products.
Weight 0.00 The shippable weight of the product in pounds.
Width 0.00 The shippable width of the product in inches.

 

Example of ShippableItemDTO

{
   "ShippingDetails":{
         "IsNonShipping":false,
         "ExtraShipFee":0,
         "Weight":2,
         "Length":10,
         "Width":8,
         "Height":6,
         "ShippingSource":0,
         "ShippingSourceId":"",
         "ShipSeparately":false
      }
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.