Deletes a current suplier or clientPOSTpostSupplierClientSupplierClientDeleteUses your API Key and the ID of the supplier/client you want to delete (SupplierClientIDToDelete) and deletes the specified supplier/client, if the specified supplier/client exists in Megaventory. You can specify the kind of delete action you want to implement using SupplierClientDeleteAction. In particular, you can replace them with a new Id (exclusively for Suppliers and only if the new Id provided is another Supplier's Id), you can delete all the products associated with this Supplier/Client or use the default option to just delete the Supplier/Client. Optionally, you can use mvInsertUpdateDeleteSourceApplication when an external application ( eg Magento ) is the one that triggers the SupplierClientDelete call. <br />
<p class="exampleHeader"> Examples: </p> <br />
<br/>
<p class="exampleBullets">A.</p> Replace a supplier's Id with 7. Call was triggered by Magento.
<br/><br/>
<p class="valueClass"> Value: </p> <pre class="mvResponse">{
"SupplierClientIDToDelete": "20",
"SupplierClientDeleteAction": "ReplaceWithNewId",
"NewSupplierClientIDToReplaceDeleted": "7",
"mvInsertUpdateDeleteSourceApplication": "Magento"
}</pre><br />
<br />
<p class="responseClass"> Response: </p> <pre class="mvResponse">{
"result": true,
"ResponseStatus": {
"ErrorCode": "0"
}
} </pre> <br/>
falseSupplierClientDeletebodyfalseDeletes a current suplier or client/SupplierClient/SupplierClientDeleteGets information on
existing suppliers and clients.GETgetSupplierClientSupplierClientGetUses your API Key and some Filters in an array format and returns
the search results using 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 SupplierClientId descending order. <br /><br />
<p class="exampleHeader"> Examples: </p> <br />
<br/>
<p class="exampleBullets">A.</p> Return all the clients whose billing address contains CA. The results are returned as mvSupplierClients objects.
<br />
We can add two Filters by using the AndOr operator as shown below: <br/><br/>
<p class="valueClass"> Value: </p> <pre class = "mvResponse"> {
"Filters": [
{
"FieldName": "SupplierClientType",
"SearchOperator": "Equals",
"SearchValue": "Client"
},
{
"AndOr": "And",
"FieldName": "SupplierClientBillingAddress",
"SearchOperator": "Contains",
"SearchValue": "CA"
}
]
} </pre>
<p class="responseClass"> Response: </p> <pre class="mvResponse"> {
"mvSupplierClients": [
{
"SupplierClientID": 9,
"SupplierClientType": "Client",
"SupplierClientName": "Retail Client",
"mvContacts": [],
"SupplierClientBillingAddress": "1 Infinite Loop Cupertino CA 95014",
"SupplierClientShippingAddress1": "1600 Amphitheatre Parkway Mountain View CA",
"SupplierClientShippingAddress2": "",
"SupplierClientPhone1": "+1234567890",
"SupplierClientPhone2": "+0987654321",
"SupplierClientFax": "",
"SupplierClientIM": "",
"SupplierClientEmail": "first@client.com",
"SupplierClientTaxID": "client taxid",
"SupplierClientComments": "",
"SupplierClientCustomField1": "",
"SupplierClientCustomField2": "",
"SupplierClientCustomField3": "",
"SupplierClientCustomField4": "",
"SupplierClientCustomField5": "",
"SupplierClientCustomField6": "",
"SupplierClientCustomField7": "",
"SupplierClientCustomField8": "",
"SupplierClientCustomField9": "",
"SupplierClientCustomField10": "",
"SupplierClientOption1": "",
"SupplierClientOption2": "",
"SupplierClientOption3": "",
"SupplierClientOption4": "",
"SupplierClientOption5": "",
"SupplierClientOption6": "",
"SupplierClientOption7": "",
"SupplierClientOption8": "",
"SupplierClientOption9": "",
"SupplierClientOption10": "",
"SupplierClientCreationDate": "/Date(1499856477997-0000)/"
}
],
"ResponseStatus": {
"ErrorCode": "0"
}
}
</pre>
Gets information on
existing suppliers and clients.POSTpostSupplierClientSupplierClientGetUses your API Key and some Filters in an array format and returns
the search results using 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 SupplierClientId descending order. <br /><br />
<p class="exampleHeader"> Examples: </p> <br />
<br/>
<p class="exampleBullets">A.</p> Return all the clients whose billing address contains CA. The results are returned as mvSupplierClients objects.
<br />
We can add two Filters by using the AndOr operator as shown below: <br/><br/>
<p class="valueClass"> Value: </p> <pre class = "mvResponse"> {
"Filters": [
{
"FieldName": "SupplierClientType",
"SearchOperator": "Equals",
"SearchValue": "Client"
},
{
"AndOr": "And",
"FieldName": "SupplierClientBillingAddress",
"SearchOperator": "Contains",
"SearchValue": "CA"
}
]
} </pre>
<p class="responseClass"> Response: </p> <pre class="mvResponse"> {
"mvSupplierClients": [
{
"SupplierClientID": 9,
"SupplierClientType": "Client",
"SupplierClientName": "Retail Client",
"mvContacts": [],
"SupplierClientBillingAddress": "1 Infinite Loop Cupertino CA 95014",
"SupplierClientShippingAddress1": "1600 Amphitheatre Parkway Mountain View CA",
"SupplierClientShippingAddress2": "",
"SupplierClientPhone1": "+1234567890",
"SupplierClientPhone2": "+0987654321",
"SupplierClientFax": "",
"SupplierClientIM": "",
"SupplierClientEmail": "first@client.com",
"SupplierClientTaxID": "client taxid",
"SupplierClientComments": "",
"SupplierClientCustomField1": "",
"SupplierClientCustomField2": "",
"SupplierClientCustomField3": "",
"SupplierClientCustomField4": "",
"SupplierClientCustomField5": "",
"SupplierClientCustomField6": "",
"SupplierClientCustomField7": "",
"SupplierClientCustomField8": "",
"SupplierClientCustomField9": "",
"SupplierClientCustomField10": "",
"SupplierClientOption1": "",
"SupplierClientOption2": "",
"SupplierClientOption3": "",
"SupplierClientOption4": "",
"SupplierClientOption5": "",
"SupplierClientOption6": "",
"SupplierClientOption7": "",
"SupplierClientOption8": "",
"SupplierClientOption9": "",
"SupplierClientOption10": "",
"SupplierClientCreationDate": "/Date(1499856477997-0000)/"
}
],
"ResponseStatus": {
"ErrorCode": "0"
}
}
</pre>
falseSupplierClientGetbodyfalseGets information on
existing suppliers and clients./SupplierClient/SupplierClientGetUndeletes a current suplier or clientPOSTpostSupplierClientSupplierClientUndeleteUses your API Key and the ID of the supplier/client you want to undelete (SupplierClientIDToUndelete) and undeletes the specified supplier/client if it exists. <br />
<p class="exampleHeader"> Examples: </p> <br />
<br/>
<p class="exampleBullets">A.</p> Undelete a supplier.
<br/><br/>
<p class="valueClass"> Value: </p> <pre class="mvResponse">{
"SupplierClientIDToUndelete": "20"
}</pre><br />
<br />
<p class="responseClass"> Response: </p> <pre class="mvResponse">{
"result": true,
"ResponseStatus": {
"ErrorCode": "0"
}
} </pre> <br/>
falseSupplierClientUndeletebodyfalseUndeletes a current suplier or client/SupplierClient/SupplierClientUndeleteInserts a
supplier/client or updates an existing one.POSTpostSupplierClientSupplierClientUpdateUses your API Key and applies a mvRecordAction
value on an mvSupplierClient object. We can insert the mvSupplierClient we specified using "Insert"
as our mvRecordAction. We can update a current one 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 object using "InsertOrUpdateNonEmptyFields". Optionally, you can use
mvInsertUpdateDeleteSourceApplication when an external application ( eg WooCommerce )
is the one that triggers the SupplierClientUpdate call. SupplierClientId cannot be updated.
<br /><br />
<p class="exampleHeader"> Examples: </p> <br />
<br/>
<p class="exampleBullets">A.</p> Insert a new supplier who has 2 contacts. The SupplierClientUpdate call was triggered by Magento.
<br/><br/>
<p class="valueClass"> Value:</p> <pre class="mvResponse"> {
"mvSupplierClient": {
"SupplierClientType": "Supplier",
"SupplierClientName": "A4 Paper Supplier",
"mvContacts": [
{
"ContactName": "Andrew Stevens",
"ContactDepartment": "A4 Papers/Printing",
"ContactEmail": "andrew@a4printing.jp",
"ContantIsPrimary": "true"
},
{
"ContactName": "Maria Weems",
"ContactDepartment": "A4 Papers/Pictures"
}
],
"SupplierClientBillingAddress": "41st Trueroad , Inglewood CA",
"SupplierClientShippingAddress": "93rd Kiwi Street, Las Vegas, Nevada"
},
"mvGrantPermissionsToAllUser": "true",
"mvRecordAction": "Insert",
"mvInsertUpdateDeleteSourceApplication": "Magento"
} </pre><br />
<br />
<p class="responseClass"> Response: </p> <pre class="mvResponse"> {
"mvSupplierClient": {
"SupplierClientID": 23,
"SupplierClientType": "Supplier",
"SupplierClientName": "A4 Paper Supplier",
"mvContacts": [
{
"ContactName": "Andrew Stevens",
"ContactDepartment": "A4 Papers/Printing",
"ContactEmail": "andrew@a4printing.jp",
"ContactIsPrimary": false
},
{
"ContactName": "Maria Weems",
"ContactDepartment": "A4 Papers/Pictures",
"ContactIsPrimary": false
}
],
"SupplierClientBillingAddress": "41st Trueroad , Inglewood CA",
"SupplierClientShippingAddress1": "",
"SupplierClientShippingAddress2": "",
"SupplierClientPhone1": "",
"SupplierClientPhone2": "",
"SupplierClientFax": "",
"SupplierClientIM": "",
"SupplierClientEmail": "",
"SupplierClientTaxID": "",
"SupplierClientComments": "",
"SupplierClientCustomField1": "",
"SupplierClientCustomField2": "",
"SupplierClientCustomField3": "",
"SupplierClientCustomField4": "",
"SupplierClientCustomField5": "",
"SupplierClientCustomField6": "",
"SupplierClientCustomField7": "",
"SupplierClientCustomField8": "",
"SupplierClientCustomField9": "",
"SupplierClientCustomField10": "",
"SupplierClientOption1": "",
"SupplierClientOption2": "",
"SupplierClientOption3": "",
"SupplierClientOption4": "",
"SupplierClientOption5": "",
"SupplierClientOption6": "",
"SupplierClientOption7": "",
"SupplierClientOption8": "",
"SupplierClientOption9": "",
"SupplierClientOption10": "",
"SupplierClientCreationDate": "/Date(1507628895856+0300)/"
},
"ResponseStatus": {
"ErrorCode": "0"
},
"entityID": 23
}</pre>
<p class="exampleBullets">B.</p>
<br/> <br/> Updates the above supplier by changing his billing address, adding a second shipping address, a phone and an IM contact. <br/>
<p class="valueClass"> Value: </p> <pre class="mvResponse"> {
"mvSupplierClient": {
"SupplierClientId": "23",
"SupplierClientName": "A4 Paper Supplier",
"SupplierClientBillingAddress": "47th Trueroad , Inglewood CA",
"SupplierClientShippingAddress2": "11th Trueside Boulevard, Jacksonville, FL",
"SupplierClientPhone1": "+113236237323232",
"SupplierClientIM": "@andrewstevens2017"
},
"mvRecordAction": "Update"
} </pre><br />
<br />
<p class="responseClass"> Response: </p> <pre class="mvResponse"> {
"mvSupplierClient": {
"SupplierClientID": 23,
"SupplierClientType": "Supplier",
"SupplierClientName": "A4 Paper Supplier",
"mvContacts": [],
"SupplierClientBillingAddress": "47th Trueroad , Inglewood CA",
"SupplierClientShippingAddress1": "",
"SupplierClientShippingAddress2": "11th Trueside Boulevard, Jacksonville, FL",
"SupplierClientPhone1": "+113236237323232",
"SupplierClientPhone2": "",
"SupplierClientFax": "",
"SupplierClientIM": "@andrewstevens2017",
"SupplierClientEmail": "",
"SupplierClientTaxID": "",
"SupplierClientCustomField1": "",
"SupplierClientCustomField2": "",
"SupplierClientCustomField3": "",
"SupplierClientCustomField4": "",
"SupplierClientCustomField5": "",
"SupplierClientCustomField6": "",
"SupplierClientCustomField7": "",
"SupplierClientCustomField8": "",
"SupplierClientCustomField9": "",
"SupplierClientCustomField10": "",
"SupplierClientOption1": "",
"SupplierClientOption2": "",
"SupplierClientOption3": "",
"SupplierClientOption4": "",
"SupplierClientOption5": "",
"SupplierClientOption6": "",
"SupplierClientOption7": "",
"SupplierClientOption8": "",
"SupplierClientOption9": "",
"SupplierClientOption10": "",
"SupplierClientCreationDate": "/Date(1507628895857-0000)/"
},
"ResponseStatus": {
"ErrorCode": "0"
},
"entityID": 23
}</pre> <br/>
falseSupplierClientUpdatebodyfalseInserts a
supplier/client or updates an existing one./SupplierClient/SupplierClientUpdatehttps://api.megaventory.com/v2017aSupplierClientGetSupplierClientGetAPIKEYtruestringshowDeletedLISTshowOnlyUndeletedshowOnlyDeletedshowAllDeletedAndUndeletedfalsestringFilters$refFilterfalseArrayReturnTopNRecordsfalseintFilterFilterAndOrLISTAndOrtruestringGroupLISTUndefinedNoGroupStartGroupEndGrouptruestringFieldNametruestringSearchOperatorLISTUndefinedEqualsNotEqualsBeginsWithEndsWithContainsGreaterThanLessThantruestringSearchValuetruestringSupplierClientUpdateSupplierClientUpdateAPIKEYtruestringmvSupplierClienttruemvSupplierClientmvRecordActionLISTInsertUpdateInsertOrUpdateInsertOrUpdateNonEmptyFieldstruestringmvGrantPermissionsToAllUsersfalsebooleanmvInsertUpdateDeleteSourceApplicationfalsestringmvSupplierClientmvSupplierClientSupplierClientIDfalseintSupplierClientTypeLISTBothSupplierClientSupplierOrClientOrBothfalsestringSupplierClientNametruestringSupplierClientBillingAddressfalsestringSupplierClientShippingAddress1falsestringSupplierClientShippingAddress2falsestringSupplierClientAddresses$refmvAddressfalseArraySupplierClientPhone1falsestringSupplierClientPhone2falsestringSupplierClientFaxfalsestringSupplierClientIMfalsestringSupplierClientEmailfalsestringSupplierClientTaxIDfalsestringSupplierClientCurrencyfalsestringSupplierClientPaymentTermsEnumLISTNoneDueOnReceiptNet10Net15Net30Net60Net90CustomPaymentTerms1CustomPaymentTerms2OtherPaymentTermsfalsestringSupplierClientPaymentMethodEnumLISTNoneCashCreditCheckBankTransferCustomPaymentMethod1CustomPaymentMethod2CustomPaymentMethod3OtherfalsestringSupplierClientCommentsfalsestringSupplierClientCustomField1falsestringSupplierClientCustomField2falsestringSupplierClientCustomField3falsestringSupplierClientCustomField4falsestringSupplierClientCustomField5falsestringSupplierClientCustomField6falsestringSupplierClientCustomField7falsestringSupplierClientCustomField8falsestringSupplierClientCustomField9falsestringSupplierClientCustomField10falsestringSupplierClientOption1falsebooleanSupplierClientOption2falsebooleanSupplierClientOption3falsebooleanSupplierClientOption4falsebooleanSupplierClientOption5falsebooleanSupplierClientOption6falsebooleanSupplierClientOption7falsebooleanSupplierClientOption8falsebooleanSupplierClientOption9falsebooleanSupplierClientOption10falsebooleanSupplierClientCreationDatefalseDatemvContacts$refmvContactPersonfalseArraymvAddressmvAddressAddressTypeLISTGeneralBillingShipping1Shipping2truestringAddressLine1falsestringAddressLine2falsestringAddressLine3falsestringNamefalsestringPhonefalsestringEmailfalsestringTaxIdNumberfalsestringOrganizationfalsestringCityfalsestringStatefalsestringCountryLISTNONEADAEAFAGAIALAMANAOAQARASATSSZWAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSTSVSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMfalsestringCountryNamefalsestringLongitudefalsestringLatitudefalsestringZipCodefalsestringNullable`1Nullable`1HasValuetruebooleanValuetruebooleanmvContactPersonmvContactPersonContactIdtrueintContactNametruestringContactDepartmenttruestringContactAddresstruestringContactFullAddresstruemvAddressContactEmailtruestringContactPhone1truestringContactPhone2truestringContactFaxtruestringContactIMtruestringContactCustomField1truestringContactCustomField2truestringContactIsPrimarytruebooleanmvSuppliersClients$refmvSupplierClientfalseArraySupplierClientDeleteSupplierClientDeleteAPIKEYtruestringSupplierClientIDToDeletetrueintSupplierClientDeleteActionLISTReplaceWithNewIdDeleteProductsDefaultActiontruestringNewSupplierClientIDToReplaceDeletedfalseintmvInsertUpdateDeleteSourceApplicationfalsestringSupplierClientUndeleteSupplierClientUndeleteAPIKEYtruestringSupplierClientIDToUndeletetrueint/SupplierClient