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 → Get List
AI-generatedSummary
Retrieve a list of Shipment records from the Acumatica API, applying optional filters to refine the results.
Inputs
- Base Currency ID Filter — Filter shipments by Base Currency ID using operators like equals, contains, or starts with.
- Control Qty Filter — Filter shipments by Control Qty with comparison operators (equals, greater than, less than, etc.).
- Created Date Time Filter — Filter shipments by Created Date Time using date comparisons (equals, before, after, etc.).
- Currency Rate Filter — Filter shipments by Currency Rate with comparison operators.
- Currency Rate Type ID Filter — Filter shipments by Currency Rate Type ID using string matching operators.
- Currency View State Filter — Filter shipments by Currency View State (boolean equals).
- Customer ID Filter — Filter shipments by Customer ID with string matching operators.
- Create New Shipment For Every Order Filter — Filter shipments by whether Create New Shipment For Every Order is true or false.
- Description Filter — Filter shipments by Description with string matching operators.
- Effective Date Filter — Filter shipments by Effective Date using date comparisons.
- FOB Point Filter — Filter shipments by FOB Point with string matching operators.
- Override Freight Price Filter — Filter shipments by Override Freight Price (boolean equals).
- Freight Price Filter — Filter shipments by Freight Price with numerical comparison operators.
- Freight Cost Filter — Filter shipments by Freight Cost with numerical comparison operators.
- Freight Currency ID Filter — Filter shipments by Freight Currency ID with string matching operators.
- Ground Collect Filter — Filter shipments by Ground Collect (boolean equals).
- Hold Filter — Filter shipments by Hold status (boolean equals).
- Insurance Filter — Filter shipments by Insurance (boolean equals).
- Last Modified Date Time Filter — Filter shipments by Last Modified Date Time using date comparisons.
- Location ID Filter — Filter shipments by Location ID with string matching operators.
- Operation Filter — Filter shipments by Operation with string matching operators.
- Owner Filter — Filter shipments by Owner with string matching operators.
- Package Count Filter — Filter shipments by Package Count with numerical comparison operators.
- Package Weight Filter — Filter shipments by Package Weight with numerical comparison operators.
- Picked Filter — Filter shipments by Picked status (boolean equals).
- Reciprocal Rate Filter — Filter shipments by Reciprocal Rate with numerical comparison operators.
- Residential Delivery Filter — Filter shipments by Residential Delivery (boolean equals).
- Saturday Delivery Filter — Filter shipments by Saturday Delivery (boolean equals).
- Shipment Date Filter — Filter shipments by Shipment Date using date comparisons.
- Shipment Nbr Filter — Filter shipments by Shipment Number with string matching operators.
- Shipped Qty Filter — Filter shipments by Shipped Quantity with numerical comparison operators.
- Shipped Volume Filter — Filter shipments by Shipped Volume with numerical comparison operators.
- Shipped Weight Filter — Filter shipments by Shipped Weight with numerical comparison operators.
- Shipping Terms Filter — Filter shipments by Shipping Terms with string matching operators.
- Shipping Zone ID Filter — Filter shipments by Shipping Zone ID with string matching operators.
- Ship Via Filter — Filter shipments by Ship Via with string matching operators.
- Status Filter — Filter shipments by Status with string matching operators.
- To Warehouse ID Filter — Filter shipments by To Warehouse ID with string matching operators.
- Type Filter — Filter shipments by Type with string matching operators.
- Unlimited Packages Filter — Filter shipments by Unlimited Packages (boolean equals).
- Use Customers Account Filter — Filter shipments by Use Customers Account (boolean equals).
- Warehouse ID Filter — Filter shipments by Warehouse ID with string matching operators.
- Workgroup ID Filter — Filter shipments by Workgroup ID with string matching operators.
- Custom Filter — An advanced OData $filter expression to apply additional filtering (e.g., "CustomerID/value eq 'CUST001'").
Output shape
a list of shipment records matching the specified filters
The results are filtered via OData $filter expressions constructed from the provided filter input fields and any custom filter string. If no filters are set, the full list of shipments is retrieved.
