Returns search results as a List Response for shipping profiles with the given search parameters for the logged in user
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 | YES | 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 |
---|---|---|---|
Name | string | Any string | Searches for shipping profiles containing this string in the name (case insensitive) |
Active | boolean | boolean | Is the shipping profile active |
Sort | integer |
1 - Shipping Profile ID Asc 2 - Shipping Profile ID Desc 3 - Name Asc 4 - Name Desc 5 - Profile Type Asc 6 - Profile Type Desc 7 - Handling Cost Asc 8 - Handling Cost Desc 9 - Insurance Type Asc 10 - Insurance Type Desc 11 - Insurance Cost Asc 12 - Insurance Cost Desc 13 - Insurance Percentage Asc 14 - Insurance Percentage Desc 15 - Weight Unit Asc 16 - Weight Unit Desc |
The order in which the results are returned. Default = 1 - Shipping Profile ID Asc |
Optional PagingParameters
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 | boolean | Is the shipping profile active |