Megaventory API v2017a

<back to all web services

ShippingProviderGet

Gets 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 .soap11 suffix or ?format=soap11

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: api.megaventory.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: ShippingProviderGet

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<ShippingProviderGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <Filters xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints">
    <Filter>
      <AndOr>And</AndOr>
      <FieldName>String</FieldName>
      <Group>Undefined</Group>
      <SearchOperator>Undefined</SearchOperator>
      <SearchValue>String</SearchValue>
    </Filter>
  </Filters>
  <ReturnTopNRecords xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints">0</ReturnTopNRecords>
  <APIKEY>String</APIKEY>
  <showDeleted>showOnlyUndeleted</showDeleted>
</ShippingProviderGet>

    </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<ShippingProviderGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvShippingProviders xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:mvShippingProvider>
      <d2p1:ShippingProviderId>0</d2p1:ShippingProviderId>
      <d2p1:ShippingProviderName>String</d2p1:ShippingProviderName>
      <d2p1:ShippingProviderTrackingURL>String</d2p1:ShippingProviderTrackingURL>
      <d2p1:ShippingProviderComments>String</d2p1:ShippingProviderComments>
      <d2p1:ShippingProviderServices>
        <d2p1:mvShippingProviderService>
          <d2p1:Id>String</d2p1:Id>
          <d2p1:IsEnabled>false</d2p1:IsEnabled>
          <d2p1:Name>String</d2p1:Name>
        </d2p1:mvShippingProviderService>
      </d2p1:ShippingProviderServices>
      <d2p1:ShippingProviderPackages>
        <d2p1:mvShippingProviderPackage>
          <d2p1:Id>String</d2p1:Id>
          <d2p1:IsEnabled>false</d2p1:IsEnabled>
          <d2p1:Name>String</d2p1:Name>
        </d2p1:mvShippingProviderPackage>
      </d2p1:ShippingProviderPackages>
      <d2p1:ShippingProviderApplication>Undefined</d2p1:ShippingProviderApplication>
    </d2p1:mvShippingProvider>
  </mvShippingProviders>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <InternalErrorCode>String</InternalErrorCode>
</ShippingProviderGetResponse>

    </soap:Body>
</soap:Envelope>