---
updatedAt: 2026-07-03T14:21:51.000Z
agentTools:
  projectIndex: https://developer.xentral.com/llms.txt
---

# Cancel delivery note V3

This endpoint requires the following scopes: `deliveryNote:cancel`.

Cancel a delivery note. By default restocking the items associated with the delivery note must be handled manually; set `restock` to true to put the picked stock back to its storage locations and clear the picking reservations. Delivery notes in status draft or completed cannot be cancelled.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Xentral Business Documents API v3",
    "description": "The Xentral Business Documents API v3 for working with sales orders, offers, invoices, credit notes, delivery notes, return orders, purchase orders, proforma invoices and productions.\n\nIndividual endpoints marked as *Beta* may still change without prior notice — see the respective endpoint descriptions.\n\nRequest payloads may contain properties that an endpoint does not define; these are ignored rather than rejected. Nothing is stored for them and no error is returned, so check the response body to confirm which values were actually applied.",
    "contact": {
      "name": "API Support",
      "url": "https://xentral.com",
      "email": "api@xentral.com"
    },
    "version": "0.2.0"
  },
  "servers": [
    {
      "url": "https://{xentralId}.xentral.biz",
      "description": "Your xentral instance",
      "variables": {
        "xentralId": {
          "default": "my-company",
          "description": "Your Xentral instance ID"
        }
      }
    },
    {
      "url": "https://{domain}",
      "description": "Xentral with a custom domain",
      "variables": {
        "domain": {
          "default": "demo.xentral.com",
          "description": "Your Xentral custom domain"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "CancelDeliveryNoteData": {
        "properties": {
          "restock": {
            "description": "When true, the picked stock of the delivery note is put back to its storage locations and the picking reservations are cleared. Defaults to false: restocking must be handled manually.",
            "type": "boolean",
            "example": true
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "DeliveryNote",
      "description": "DeliveryNote"
    }
  ],
  "paths": {
    "/api/v3/deliveryNotes/{id}/actions/cancel": {
      "patch": {
        "tags": [
          "DeliveryNote"
        ],
        "summary": "Cancel delivery note V3",
        "description": "This endpoint requires the following scopes: `deliveryNote:cancel`.\n\nCancel a delivery note. By default restocking the items associated with the delivery note must be handled manually; set `restock` to true to put the picked stock back to its storage locations and clear the picking reservations. Delivery notes in status draft or completed cannot be cancelled.",
        "operationId": "PATCH::api-v3-deliverynotes-id-actions-cancel",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CancelDeliveryNoteData"
              }
            }
          }
        },
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Failed validation",
            "content": {
              "application/problem+json": {
                "schema": {
                  "properties": {
                    "type": {
                      "description": "Error messages",
                      "type": "string",
                      "example": "https://api.xentral.biz/problems/request-validation"
                    },
                    "title": {
                      "description": "Error messages",
                      "type": "string",
                      "example": "Request payload validation failed."
                    },
                    "violations": {
                      "description": "Error messages",
                      "type": "object",
                      "example": {
                        "restock": [
                          "The restock field must be true or false."
                        ]
                      }
                    }
                  },
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          },
          "409": {
            "description": "Problem occurred",
            "content": {
              "application/problem+json": {
                "schema": {
                  "properties": {
                    "type": {
                      "description": "A URI reference that identifies the problem type.",
                      "type": "string",
                      "example": "https://api.xentral.biz/problems/invalid-status"
                    },
                    "title": {
                      "description": "A short, human-readable summary of the problem type.",
                      "type": "string",
                      "example": "The resource cannot be modified in its current status."
                    },
                    "detail": {
                      "description": "A human-readable explanation specific to this occurrence of the problem.",
                      "type": "string",
                      "example": "Only a draft BusinessDocument can be deleted."
                    }
                  },
                  "type": "object"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "message": {
                      "description": "Too Many Requests",
                      "type": "string",
                      "example": "Too Many Requests"
                    }
                  },
                  "type": "object"
                }
              }
            }
          }
        },
        "x-scopes": [
          "deliveryNote:cancel"
        ]
      }
    }
  }
}
```