Actions478
- Account Actions
- Account Details For Period Inquiry Actions
- Account Group Actions
- Account Summary Inquiry Actions
- Activity Actions
- Amazon Store Actions
- Appointment Actions
- Attribute Definition Actions
- Big Commerce Stores Actions
- Bill Actions
- Budget Actions
- Business Account Actions
- Carrier Actions
- Case Actions
- Cash Sale Actions
- Cash Transaction Actions
- Change Order Actions
- Change Order Class Actions
- Check Actions
- Companies Structure Actions
- Company Financial Period Actions
- Contact Actions
- Contract Usage Actions
- Cost Code Actions
- Currency Actions
- Customer Actions
- Customer Class Actions
- Customer Location Actions
- Customer Payment Method Actions
- Customer Price Class Actions
- Deduction Benefit Code Actions
- Discount Actions
- Discount Code Actions
- Earning Type Code Actions
- Email Actions
- Email Processing Actions
- Employee Actions
- Employee Payroll Class Actions
- Employee Payroll Settings Actions
- Event Actions
- Expense Claim Actions
- Expense Receipt Actions
- External Commitment Actions
- Financial Period Actions
- Financial Year Actions
- F O B Point Actions
- Inventory Adjustment Actions
- Inventory Allocation Inquiry Actions
- Inventory Issue Actions
- Inventory Quantity Available Actions
- Inventory Receipt Actions
- Inventory Summary Inquiry Actions
- Invoice Actions
- Item Class Actions
- Item Sales Category Actions
- Item Warehouse Actions
- Journal Transaction Actions
- Kit Assembly Actions
- Kit Specification Actions
- Labor Cost Rate Actions
- Lead Actions
- Ledger Actions
- Lot Serial Class Actions
- Non Stock Item Actions
- Opportunity Actions
- Pay Group Actions
- Payment Actions
- Payment Method Actions
- Pay Period Actions
- Payroll Batch Actions
- Payroll Union Local Actions
- Payroll W C C Code Actions
- Physical Inventory Count Actions
- Physical Inventory Review Actions
- Pro Forma Invoice Actions
- Project Actions
- Project Budget Actions
- Project Task Actions
- Project Template Actions
- Project Template Task Actions
- Project Transaction Actions
- P T O Bank Actions
- Purchase Order Actions
- Purchase Receipt Actions
- Sales Invoice Actions
- Sales Order Actions
- Salesperson Actions
- Sales Prices Inquiry Actions
- Sales Price Worksheet Actions
- Service Order Actions
- Shipment Actions
- Shipping Box Actions
- Shipping Term Actions
- Shipping Zones Actions
- Ship Via Actions
- Shopify Store Actions
- Stock Item Actions
- Storage Details By Location Inquiry Actions
- Storage Details Inquiry Actions
- Subaccount Actions
- Subcontract Actions
- Task Actions
- Tax Actions
- Tax Category Actions
- Tax Reporting Settings Actions
- Tax Zone Actions
- Template Items Actions
- Time Entry Actions
- Transfer Order Actions
- Union Local Actions
- Units Of Measure Actions
- Vendor Actions
- Vendor Class Actions
- Vendor Prices Inquiry Actions
- Vendor Price Worksheet Actions
- Warehouse Actions
- Work Calendar Actions
- Work Class Compensation Code Actions
- Work Location Actions
Shipment → Insert/Update
AI-generatedSummary
Insert or update a Shipment record in Acumatica by providing detailed shipment information including shipment lines, allocations, related orders, packages with contents, and shipping settings.
Inputs
- Details — An array of shipment line details, each including fields such as Inventory ID, Description, Quantity, Order Nbr, Location ID, and nested Allocations for inventory allocation details.
- Orders — A collection of related orders for the shipment, specifying order information such as Inventory Doc Type, Order Nbr, Invoice details, Shipment Nbr, and quantities shipped.
- Packages — A collection of shipment packages, each with identifiers like Box ID, weight, dimensions, and nested package contents specifying inventory items and quantities.
- Shipping Settings — Shipping address, contact details, and related shipping overrides and flags controlling how shipment is processed.
- Note ID — An optional note identifier associated with the shipment.
- Additional Fields — Various optional shipment-level fields including shipment number, dates, status, customer ID, warehouse IDs, shipment quantities, shipping terms, hold flags, freight pricing, and other shipment metadata.
Output shape
a single JSON object representing the inserted or updated Shipment record as returned by the Acumatica API.
The operation supports upserting, meaning it will insert a new Shipment if it does not exist or update an existing one based on supplied identifiers. Input fields with default or empty values are stripped before sending. Nested collections such as Details, Orders, Packages, and Shipping Settings allow complex shipment data modeling. If fields are omitted they will not be sent or updated.