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 filtered by optional criteria.
Inputs
- BaseCurrencyIDFilter — Filter results by Base Currency ID
- ControlQtyFilter — Filter results by Control Qty
- CreatedDateTimeFilter — Filter results by Created Date Time
- CurrencyRateFilter — Filter results by Currency Rate
- CurrencyRateTypeIDFilter — Filter results by Currency Rate Type ID
- CurrencyViewStateFilter — Filter results by Currency View State
- CustomerIDFilter — Filter results by Customer ID
- CreateNewShipmentForEveryOrderFilter — Filter results by Create New Shipment For Every Order
- DescriptionFilter — Filter results by Description
- EffectiveDateFilter — Filter results by Effective Date
- FOBPointFilter — Filter results by FOB Point
- OverrideFreightPriceFilter — Filter results by Override Freight Price
- FreightPriceFilter — Filter results by Freight Price
- FreightCostFilter — Filter results by Freight Cost
- FreightCurrencyIDFilter — Filter results by Freight Currency ID
- GroundCollectFilter — Filter results by Ground Collect
- HoldFilter — Filter results by Hold
- InsuranceFilter — Filter results by Insurance
- LastModifiedDateTimeFilter — Filter results by Last Modified Date Time
- LocationIDFilter — Filter results by Location ID
- OperationFilter — Filter results by Operation
- OwnerFilter — Filter results by Owner
- PackageCountFilter — Filter results by Package Count
- PackageWeightFilter — Filter results by Package Weight
- PickedFilter — Filter results by Picked
- ReciprocalRateFilter — Filter results by Reciprocal Rate
- ResidentialDeliveryFilter — Filter results by Residential Delivery
- SaturdayDeliveryFilter — Filter results by Saturday Delivery
- ShipmentDateFilter — Filter results by Shipment Date
- ShipmentNbrFilter — Filter results by Shipment Nbr
- ShippedQtyFilter — Filter results by Shipped Qty
- ShippedVolumeFilter — Filter results by Shipped Volume
- ShippedWeightFilter — Filter results by Shipped Weight
- ShippingTermsFilter — Filter results by Shipping Terms
- ShippingZoneIDFilter — Filter results by Shipping Zone ID
- ShipViaFilter — Filter results by Ship Via
- StatusFilter — Filter results by Status
- ToWarehouseIDFilter — Filter results by To Warehouse ID
- TypeFilter — Filter results by Type
- UnlimitedPackagesFilter — Filter results by Unlimited Packages
- UseCustomersAccountFilter — Filter results by Use Customers Account
- WarehouseIDFilter — Filter results by Warehouse ID
- WorkgroupIDFilter — Filter results by Workgroup ID
- customFilter — Advanced OData $filter expression (e.g. CustomerID/value eq 'CUST001'). Applied in addition to any filter fields above.
Output shape
a list of Shipment records
May be paginated; all filter fields are optional; response can be an empty array if no matches.
Examples
Example 1: Get shipments that are completed and use customers account
Set StatusFilter eq 'Completed' and UseCustomersAccountFilter eq true