Megaventory API v2017a

ShippingProviderUpdate

Inserts a shipping provider or updates a current shipping provider.

Uses your API Key and applies a mvRecordAction value on an mvShippingProvider object. We can insert the mvShippingProvider object we specified using "Insert" as our mvRecordAction. We can update a current shipping provider using "Update", we can insert it if it doesn't already exist, update it if it does using "InsertOrUpdate" and we can insert new fields or update non-empty fields of the currency using "InsertOrUpdateNonEmptyFields". Optionally, you can use mvInsertUpdateDeleteSourceApplication when an external application ( eg Magento ) is the one that triggers the ShippingProviderUpdate call. ShippingProviderId cannot be updated.

Examples:

A.

Insert a new shipping provider to our list of providers.

Value:

{ "mvShippingProvider": { "ShippingProviderName": "The new and improved Courier", "ShippingProviderTrackingURL": "newimporovedurl.jp/new_url", "ShippingProviderComments": "new and improved courier comments" }, "mvRecordAction": "Insert" }

Response:

{ "mvShippingProvider": { "ShippingProviderId": 2019, "ShippingProviderName": "The new and improved Courier", "ShippingProviderTrackingURL": "newimporovedurl.jp/new_url", "ShippingProviderComments": "new and improved courier comments" }, "ResponseStatus": { "ErrorCode": "0" }, "entityID": 2019 }

B.
Update a shipping provider's name, comments and tracking URL.

Value:

{ "mvShippingProvider": { "ShippingProviderId": 4, "ShippingProviderName": "The num1 Courier", "ShippingProviderTrackingURL": "newurl.jp/new_url", "ShippingProviderComments": "new comments" }, "mvRecordAction": "Update" }

Response:

{ "mvShippingProvider": { "ShippingProviderId": 2019, "ShippingProviderName": "The num1 Courier", "ShippingProviderTrackingURL": "newurl.jp/new_url", "ShippingProviderComments": "new comments" }, "ResponseStatus": { "ErrorCode": "0" }, "entityID": 2019 }

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

HTTP + SOAP12

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

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

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

<ShippingProviderUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <APIKEY>String</APIKEY>
  <mvShippingProvider xmlns:d2p1="https://api.megaventory.com/types">
    <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>
  </mvShippingProvider>
  <mvRecordAction>Insert</mvRecordAction>
  <mvInsertUpdateDeleteSourceApplication>String</mvInsertUpdateDeleteSourceApplication>
</ShippingProviderUpdate>

    </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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

<ShippingProviderUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvShippingProvider xmlns:d2p1="https://api.megaventory.com/types">
    <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>
  </mvShippingProvider>
  <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>
  <entityID>0</entityID>
  <InternalErrorCode>String</InternalErrorCode>
</ShippingProviderUpdateResponse>

    </soap12:Body>
</soap12:Envelope>