Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Shipment → Insert/Update

AI-generated

Summary

Creates or updates a Shipment record in Acumatica via an upsert operation.

Inputs

  • Details — Collection of shipment line details.
  • Orders — Collection of order metadata associated with the shipment.
  • Packages — Collection of package information.
  • ShipToAddressOverride — Boolean flag to override the default ship-to address.
  • ShipToContactOverride — Boolean flag to override the default ship-to contact.
  • Validated — Boolean indicating whether the shipment should be validated.
  • NoteID — Identifier for a note attached to the shipment.
  • AdditionalFields — Additional key-value fields to pass to Acumatica.

Output shape

a single Shipment record

On success the operation returns the created or updated shipment; on failure an error object is returned.

Examples

Example 1: Insert a new shipment with basic line items

Details includes one allocation with Description, Qty, UOM; Orders empty; Packages empty; no overrides.

Example 2: Update an existing shipment by ID

Provide OrderNbr to identify shipment; fill Details and Packages; set ShipToAddressOverride true.

Example 3: Create shipment with additional custom fields

Populate AdditionalFields with CustomerID and FreightPrice; set CreateNewShipmentForEveryOrder true.

Links

Discussion