Megaventory API v2017a

<back to all web services

ProductCategoryDelete

Deletes a product categoryUses your API Key, the ID of the product category you want to delete (ProductCategoryIDToDelete) and what should happen with the products that belonged in this product category to delete the specified product category if it exists. mvCategoryDeleteAction has three options: replacing the products' product category id with a new one (using "ReplaceWithNewId" as the DeleteAction and NewProductCategoryIDToReplaceDeleted to specify the new id of the products), delete the products that belonged to this category ("DeleteProducts"), or leave them without a category ("LeaveProductsOrphan"). Optionally, you can use mvInsertUpdateDeleteSourceApplication when an external application ( eg Magento ) is the one that triggers the ProductCategoryDelete call.

Examples:



A.

Delete a product category and move its objects to another category.

To begin with, we use ProductCategoryGet to see all of our existing product categories.



We decide to remove the "Double Sided DVDs" from our list of product categories and move the products to the "DVDs in Case" product category. The call was triggered by the WooCommerce application.

Value: 

{
   "ProductCategoryIDToDelete": 14,
   "mvCategoryDeleteAction": "ReplaceWithNewId",
   "NewProductCategoryIDToReplaceDeleted": 11,
   "mvInsertUpdateDeleteSourceApplication": "WooCommerce"
}


Response: 

{
   "result": true,
   "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: ProductCategoryDelete

<?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>

<ProductCategoryDelete xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <APIKEY>String</APIKEY>
  <ProductCategoryIDToDelete>0</ProductCategoryIDToDelete>
  <mvCategoryDeleteAction>ReplaceWithNewId</mvCategoryDeleteAction>
  <NewProductCategoryIDToReplaceDeleted>0</NewProductCategoryIDToReplaceDeleted>
  <mvInsertUpdateDeleteSourceApplication>String</mvInsertUpdateDeleteSourceApplication>
</ProductCategoryDelete>

    </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>

<ProductCategoryDeleteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <result>false</result>
  <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>
</ProductCategoryDeleteResponse>

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