Versions Compared

Version Old Version 1 New Version 2
Changes made by

Fadi Nasr (Unlicensed)

Fadi Nasr (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

ServiceAPIMethod
multitenant/productDELETE


Data Model: 

Workflow:

Input

...

Type: application/json


Name
Source
Mandatory
Type
Special Format
Description
idQueryYESStringN/AThe product id
codeQueryYESStringThe Length is 4 - 5The product code


Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{

}


Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[460],
        "details":[
            {
                "code":460,
                "message":"Unable to find products"
            }
        ]
    }
}



Error Codes


Code
Description
426
Invalid Product ID provided
460

Unable to find products

466
You are not allowed to remove the product you are currently logged in with
474
Missing required field: either id or code
475

Unable to remove product record

477

Invalid product code provided

500

This record is locked. You cannot modify or delete it



Example (CURL)

...

Request

Code Block
languagebash
titleCalling List Products API
 > CURL -X DELETE http://127.0.0.1:4004/product?id=%product_id%

Response

Code Block
languagejs
titleList Products API response
{
   "result": true,
   "data": [
      {
         
      }
   ]
}