Gets information on current shipping providers | Uses your API Key and some Filters in an array format and returns the search results using the given filters.
Optionally, you can use ReturnTopNRecords to limit the number of the results to the specified number (omit, or add ReturnTopNRecords = -1 to get all the available results). The ReturnTopNRecords chooses the top records in a ShippingProviderId descending order.
A. Return all shipping providers
Value: {}
Response: {
"mvShippingProviders": [
{
"ShippingProviderId": 2018,
"ShippingProviderName": "fed",
"ShippingProviderTrackingURL": "lel",
"ShippingProviderComments": ""
},
{
"ShippingProviderId": 2017,
"ShippingProviderName": "defdex",
"ShippingProviderTrackingURL": "elli",
"ShippingProviderComments": ""
},
{
"ShippingProviderId": 2016,
"ShippingProviderName": "fedex",
"ShippingProviderTrackingURL": "",
"ShippingProviderComments": ""
}
],
"ResponseStatus": {
"ErrorCode": "0"
}
}
We can add two Filters by using the AndOr operator as shown below:
B. Return the first two mvShippingProvider objects with a ShippingProviderId less than 2018. The results will be returned as mvShippingProviders objects.
Value: {
"Filters": [
{
"FieldName": "ShippingProviderId",
"SearchOperator": "LessThan",
"SearchValue": 2018
}
],
"ReturnTopNRecords": 2
}
Response: {
"mvShippingProviders": [
{
"ShippingProviderId": 2017,
"ShippingProviderName": "defdex",
"ShippingProviderTrackingURL": "elli",
"ShippingProviderComments": ""
},
{
"ShippingProviderId": 2016,
"ShippingProviderName": "fedex",
"ShippingProviderTrackingURL": "",
"ShippingProviderComments": ""
}
],
"ResponseStatus": {
"ErrorCode": "0"
}
}
|