Documentation for GET api/Shipping/ShippingMethod/{shipMethodID}

GET api/Shipping/ShippingMethod/{shipMethodID}

Request Information

URI Parameters

Name	Description	Type	Additional information
shipMethodID		integer	Required

Body Parameters

None.

Response Information

Resource Description

IShippingMethod

Name	Type	Additional information
ID	integer	None.
RealtimeTypeID	integer	None.
OriginZipCode	string	None.
ShipperID	integer	None.
Description	string	None.
Abbreviation	string	None.
Calculated	integer	None.
Priority	integer	None.
IsImmediate	boolean	None.
SortOrder	integer	None.
POBoxAllowed	byte	None.
IsActive	boolean	None.
IsAutoShip	boolean	None.
IsWeb	boolean	None.
AlternateShipMethodID	string	None.
IsInstantDelivery	boolean	None.
IsRealTimeAddSurcharge	boolean	None.
SurchargeBase	decimal number	None.
SurchargePercentage	decimal number	None.
IsHandlingFee_Aware	boolean	None.
HandlingFee_NonVirtual	decimal number	None.
HandlingFee_Virtual	decimal number	None.
HandlingFee_MultiplyQuantity	integer	None.
WarehouseID	integer	None.
IsShipToOverride	boolean	None.
ShipStreet1	string	None.
ShipStreet2	string	None.
ShipCity	string	None.
ShipState	string	None.
ShipPostalCode	string	None.
ShipCountry	string	None.
ShipCounty	string	None.
ShipPriceTypeID	integer	None.
IsPOBoxRestricted	boolean	None.
IsUPSOnline	boolean	None.
MultipleUnit	string	None.
USPS_ServiceTypeID	integer	None.
RealtimeServiceTypeID	integer	None.
IsCashOnDelivery	boolean	None.
ShipDetail1	string	None.
ShipDetail2	string	None.
ShipDetail3	string	None.
CopyScheduleFromShippingMethodID	integer	None.
OriginStreet1	string	None.
OriginStreet2	string	None.
OriginCity	string	None.
OriginState	string	None.
OriginCountry	string	None.
OriginCounty	string	None.

Response Formats

application/xml, text/xml

Sample:

<ShippingMethod>
  <ID>0</ID>
  <Description />
  <Abbreviation />
  <IsActive>False</IsActive>
  <IsWeb>False</IsWeb>
  <IsAutoShip>False</IsAutoShip>
  <MultipleUnit />
  <ShipperID>0</ShipperID>
  <RealtimeTypeID>0</RealtimeTypeID>
  <OriginZipCode />
  <Calculated>0</Calculated>
  <Priority>0</Priority>
  <IsImmediate>False</IsImmediate>
  <SortOrder>0</SortOrder>
  <POBoxAllowed />
  <AlternateShipMethodID />
  <IsInstantDelivery>False</IsInstantDelivery>
  <IsRealTimeAddSurcharge>False</IsRealTimeAddSurcharge>
  <SurchargeBase>0</SurchargeBase>
  <SurchargePercentage>0</SurchargePercentage>
  <IsHandlingFee_Aware>False</IsHandlingFee_Aware>
  <HandlingFee_NonVirtual>0</HandlingFee_NonVirtual>
  <HandlingFee_Virtual>0</HandlingFee_Virtual>
  <HandlingFee_MultiplyQuantity>0</HandlingFee_MultiplyQuantity>
  <WarehouseID />
  <IsShipToOverride>False</IsShipToOverride>
  <ShipStreet1 />
  <ShipStreet2 />
  <ShipCity />
  <ShipState />
  <ShipPostalCode />
  <ShipCountry />
  <ShipCounty />
  <ShipPriceTypeID>0</ShipPriceTypeID>
  <IsPOBoxRestricted>False</IsPOBoxRestricted>
  <IsUPSOnline>False</IsUPSOnline>
  <USPS_ServiceTypeID>0</USPS_ServiceTypeID>
  <RealtimeServiceTypeID />
  <IsCashOnDelivery>False</IsCashOnDelivery>
  <ShipDetail1 />
  <ShipDetail2 />
  <ShipDetail3 />
  <CopyScheduleFromShippingMethodID>0</CopyScheduleFromShippingMethodID>
  <OriginStreet1 />
  <OriginStreet2 />
  <OriginCity />
  <OriginState />
  <OriginCountry />
  <OriginCounty />
  <CreatedBy />
  <DateCreated>01/01/0001 00:00:00</DateCreated>
  <LastModifiedBy />
  <DateLastModified />
</ShippingMethod>

application/json, text/json

Sample:

{
  "ID": 0,
  "IsActive": false,
  "IsWeb": false,
  "IsAutoShip": false,
  "ShipperID": 0,
  "RealtimeTypeID": 0,
  "Calculated": 0,
  "Priority": 0,
  "IsImmediate": false,
  "SortOrder": 0,
  "IsInstantDelivery": false,
  "IsRealTimeAddSurcharge": false,
  "SurchargeBase": 0.0,
  "SurchargePercentage": 0.0,
  "IsHandlingFee_Aware": false,
  "HandlingFee_NonVirtual": 0.0,
  "HandlingFee_Virtual": 0.0,
  "HandlingFee_MultiplyQuantity": 0,
  "IsShipToOverride": false,
  "ShipPriceTypeID": 0,
  "IsPOBoxRestricted": false,
  "IsUPSOnline": false,
  "USPS_ServiceTypeID": 0,
  "IsCashOnDelivery": false,
  "DateCreated": "0001-01-01T00:00:00"
}