Deleting from a resource

To delete a record we submit a DELETE request to the resource record url, ensuring a key is specified.

So to delete order ORD00025 we would submit:

DELETE /API/V3/Order/ORD00025

... and this would delete that order.

Deleting multiple records

To delete multiple records in a single request, you can use a limited amount of the search specification provided when fetching products from a resource.

• Specifying values for one or more fields.
• Multiple values for a field.

Things that don't work:

• Wildcards.
• The _match or _search special configuration parameters.

Deleting related resources

Unfortunately you cannot simply submit a DELETE to a full resource specification and have it automatically delete all related resources mentioned in the specification.

However you can retrieve the resource using a GET, specifying the related resources you are interested in. This returns the XML data with a endpoints for each resource. If you submit a DELETE to each of those endpoints, all the related resources will be deleted.

Response

The response received by a successful DELETE is a follows:

<rsp stat="ok" version="3.0">
  <success>1</success>
</rsp>