Returns the cost by quantity, cost by price or cost by weight when given shippingProfileID and value parameters
Header | Data Type | Valid Values | Required | Description |
---|---|---|---|---|
Content-Type | string | application/json | YES | The format your data will be sent to our site. |
X-DevKey | string | string | YES | The devkey assigned to the developer. |
X-AccessToken | string | string | Optional | The token acquired from a POST to Users/AccessToken. |
NOTE: Variables to place in the query string of the request.
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
shippingProfileID | integer | positive # | ID belonging to the Shipping Profile to look up |
value | decimal | 0 to positive # | Value used to calculate shipping costs, based on profile type Cost By Weight : Value = Total Weight of Items Cost by Quantity : Value = Number of Items Cost by Price : Value = Total Price of Items |
If there are no errors with the input parameters, this call will respond with a 200 OK
and the following data as serialized JSON
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
shippingProfileID | integer | positive # | ID belonging to shipping profile |
name | string | string | Name of the shipping profile |
profileType | string | string | Enum belonging the type of shipping profile |
handlingCost | decimal | positive # | Cost of the handling |
insuranceType | string | string | Enum belonging the type of Insurance |
insuranceCost | decimal | positive # | Cost of the Insurance |
insurancePercentage | decimal | positive # | Precentage of Insurance as it relates to the total cost |
weightUnit | integer | positive # | Weight Unit of the Shipment |
isActive | boolean | loolean | Is the shipping profile active |
rates | Hashtable | string and postive decimal # | Hashtable of calculated rate type and cost |