Xentral icon

Xentral

Interact with Xentral ERP API

Actions196

Return → Create from Delivery Note

AI-generated

Summary

Create a return order in Xentral based on an existing delivery note by specifying the delivery note ID and providing a JSON array of line items to return.

Inputs

  • Delivery Note ID (required) — The ID of the delivery note from which to create the return order.
  • Line Items (JSON) (required) — A JSON array specifying the line items for the return order; each line item must include a product object with an id and a quantity number.
  • Max Pages — When retrieving result lists with returnAll enabled, defines the maximum number of API pages to fetch (each page returns 50-150 records). Defaults to 1000 pages; increase or decrease to control API call volume.

Output shape

The API response JSON object representing the created return order, including details of the return such as its ID, associated delivery note, and line items.

The operation requires specifying both Delivery Note ID and line items explicitly. Max Pages is relevant only when returnAll is true to control pagination limits; otherwise, it does not affect the creation operation.

Links

Discussion