Delete Custom Entity (Item)
This operation allows you to delete a specific element belonging to a custom entity
It follows REST principles and aligns with the OData v4.01 standard.
[DELETE] Custom Entity (Item) Endpoint
https://api2.saleslayer.com/rest/Catalog/CustomEntities('{customEntityDenominator}')/Item({itemId})
Making a request
- Use the HTTP method: DELETE.
- Include the API key in the request headers for authentication.
- It does not require a body (request body).
- Required parameters in the route
- CustomEntityDenominator: Identifier name of the custom entity.
- itemId: Unique identifier of the item to be deleted.
Request example:
DELETE /rest/Catalog/CustomEntity('Sales')/Item(507)
Response
🟢 204 No content
The item was successfully updated. No additional content is returned.
🔴 400 Bad Request
Common errors include:
- The provided ID is in an incorrect format (must be numeric).
- Required parameters are missing or invalid.
"The identifier xxxx_id is invalid or not found"
🔴 401 Unauthorized
Missing or invalid API key.
🔴 403 Forbidden
The user does not have permission to perform this operation.
🔴 404 Not Found
The item specified by itemtId does not exist or its status is 'X' (already deleted).
🔴 412 Precondition Failed
System is not in a valid state to perform the operation.
🔴 500 Internal Server Error
Unexpected system failure
Limitations and considerations
- Only one element can be deleted from the custom entity per request.
- Deletion is not supported in environments with multi-table attributes
