Xentral icon

Xentral

Interact with Xentral ERP API

Actions196

Shipment → Create

AI-generated

Summary

Create a new shipment in Xentral associated with a specified delivery note ID, optionally providing additional shipment details such as parcel count, tracking information, shipping method, weight, and shipment date.

Inputs

  • Delivery Note ID (required) — The ID of the delivery note to which this shipment belongs
  • Parcel Count — Number of parcels included in the shipment (default 1)
  • Send Tracking Mail — Flag to send a tracking email to the customer
  • Sent At — The date and time when the shipment was sent
  • Shipping Method ID — ID of the shipping method used for this shipment (nullable)
  • Tracking Link — URL to track the shipment
  • Tracking Number — Carrier tracking number for the shipment
  • Update Delivery Note Shipping Method — Whether to update the shipping method on the associated delivery note
  • Weight — Weight of the shipment in kilograms (to two decimal places)

Output shape

a single record

Returns the created shipment record object.

Examples

Example 1: Create a shipment with provided delivery note ID and tracking details

Set Delivery Note ID, Tracking Number, Tracking Link, and optionally Parcel Count and Weight.

Links

Discussion