Acumatica API - Endpoint Default 25 200 001 icon

Acumatica API - Endpoint Default 25 200 001

Interact with Acumatica Endpoint Default/25.200.001

Actions478

Shipment → Insert/Update

AI-generated

Summary

Insert or update a Shipment resource in Acumatica by sending detailed shipment information including shipment lines, orders, packages, shipping settings, and additional shipment properties.

Inputs

  • Details — An array of shipment line details where each detail may include allocations specifying inventory information such as description, expiration date, inventory and location IDs, quantities, order numbers and types, lot serial number, and unit of measure.
  • Orders — An array of order objects associated with the shipment, each with inventory document type, reference numbers, invoice details, shipment number and type, shipped quantities, volume and weight, and optional order note ID.
  • Packages — An array of packages included in the shipment, each package containing identifiers (Box ID), amounts (COD, declared value), confirmed status, descriptions, tracking number, type, weight, dimensions, unit of measure, package contents (inventory IDs, lot serial numbers, quantity, etc.), line number and optional note ID.
  • Shipping Settings — Shipping settings including ship to address and contact information, overrides for address and contact, validation status, and various address components.
  • Note ID — Optional note identifier associated with the shipment.
  • Additional Fields — A collection of additional optional fields for the shipment such as currency, dates, customer ID, flags for shipment creation and package handling, freight pricing, location and warehouse identifiers, shipment date and number, shipping terms, status, and several boolean flags controlling shipment behavior.

Output shape

a single updated or inserted shipment record or an error response

The operation returns the shipment resource as stored in Acumatica, reflecting inserted or updated values. Inputs with default or empty values are stripped before sending to avoid API errors. The operation supports upsert semantics on shipment records.

Links

Discussion