Megaventory API v2017a

<back to all web services

ShippingProviderGet

The following routes are available for this service:
GET POST/ShippingProvider/ShippingProviderGetGets information on current shipping providersUses 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.

Examples:



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"
   }
}


To override the Content-type in your clients HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/ShippingProviderGet HTTP/1.1 
Host: api.megaventory.com 
Content-Type: application/json
Content-Length: length

{"Filters":[{"AndOr":"And","Group":"Undefined","FieldName":"String","SearchOperator":"Undefined","SearchValue":"String"}],"ReturnTopNRecords":0,"APIKEY":"String","showDeleted":"showOnlyUndeleted"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"mvShippingProviders":[{"ShippingProviderId":0,"ShippingProviderName":"String","ShippingProviderTrackingURL":"String","ShippingProviderComments":"String","ShippingProviderServices":[{"Id":"String","Name":"String","IsEnabled":false}],"ShippingProviderPackages":[{"Id":"String","Name":"String","IsEnabled":false}],"ShippingProviderApplication":"Undefined"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"InternalErrorCode":"String"}