Delete a sales order

Permanently deletes a sales order. The deletion will fail if the sales order is currently in use or has any linked transactions that are in use.

delete/quickbooks-desktop/sales-orders/{id}

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the sales order to delete.

Example:123ABC-1234567890

The QuickBooks-assigned unique identifier of the sales order to delete.

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

The ID of the End-User to receive this request.

Response

Returns a confirmation of the deletion with the ID of the deleted sales order.

idstring required

The QuickBooks-assigned unique identifier of the deleted sales order.

objectType'qbd_sales_order' required

The type of object. This value is always "qbd_sales_order".

refNumberstring nullable required

The case-sensitive user-defined reference number of the deleted sales order.

deletedboolean required

Indicates whether the sales order was deleted.

Example response

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_sales_order",
  "refNumber": "SO-1234",
  "deleted": true
}

Changes

Changed in 4 of the 46 revisions of this API.311

    • for the path request parameter id, the maxLength was set to 36

      request-parameter-max-length-set

    • response property refNumber list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

  • 8e0b7df2044d11See the full diff
    • the response property refNumber became nullable for the status 200

      response-property-became-nullable

    • response property refNumber list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property refNumber list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened