Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

General Information


ServiceAPIMethod
multitenant/productDELETE


Data Model: Products

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

Valid Response Sample
{
result": true,
  "data": {
    "n": 1,
    "ok": 1
  }
}


Invalid Response

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



Error Codes



Code
Description
602
Model error: + %model_error%
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

500

This record is locked. You cannot modify or delete it

Example (CURL)

Request

Calling List Products API
 > CURL -X DELETE http://127.0.0.1:4004/product?id=%product_id%

Response

List Products API response
{
   "result": true,
   "data": [
      {
         
      }
   ]
}
  • No labels