Acumatica API - Endpoint Default 24 200 001Install

Summary

Retrieve a list of Shipment records from the Acumatica API, applying optional filters on shipment fields to narrow down the results.

Inputs

• Base Currency ID Filter — Filter shipments by Base Currency ID using operators Equals, Contains, or Starts With.
• Control Qty Filter — Filter by Control Qty with numeric comparison operators.
• Created Date Time Filter — Filter shipments based on Created Date Time using date comparison operators.
• Currency Rate Filter — Filter by Currency Rate with numeric comparison operators.
• Currency Rate Type ID Filter — Filter by Currency Rate Type ID using string operators.
• Currency View State Filter — Filter by Currency View State as a boolean.
• Customer ID Filter — Filter by Customer ID using string comparison operators.
• Create New Shipment For Every Order Filter — Boolean filter to select shipments created for every order.
• Description Filter — Filter by Description using string comparison operators.
• Effective Date Filter — Filter by Effective Date with date comparison operators.
• FOB Point Filter — Filter by FOB Point using string comparison operators.
• Override Freight Price Filter — Boolean filter for Override Freight Price.
• Freight Price Filter — Filter by Freight Price with numeric comparison operators.
• Freight Cost Filter — Filter by Freight Cost with numeric comparison operators.
• Freight Currency ID Filter — Filter by Freight Currency ID using string comparison operators.
• Ground Collect Filter — Boolean filter for Ground Collect.
• Hold Filter — Boolean filter for Hold status.
• Insurance Filter — Boolean filter for Insurance.
• Last Modified Date Time Filter — Filter shipments based on Last Modified Date Time using date comparison operators.
• Location ID Filter — Filter by Location ID using string comparison operators.
• Operation Filter — Filter by Operation using string comparison operators.
• Owner Filter — Filter by Owner using string comparison operators.
• Package Count Filter — Filter by Package Count with numeric comparison operators.
• Package Weight Filter — Filter by Package Weight with numeric comparison operators.
• Picked Filter — Boolean filter for Picked status.
• Reciprocal Rate Filter — Filter by Reciprocal Rate with numeric comparison operators.
• Residential Delivery Filter — Boolean filter for Residential Delivery.
• Saturday Delivery Filter — Boolean filter for Saturday Delivery.
• Shipment Date Filter — Filter by Shipment Date with date comparison operators.
• Shipment Nbr Filter — Filter by Shipment Number using string comparison operators.
• Shipped Qty Filter — Filter by Shipped Quantity with numeric comparison operators.
• Shipped Volume Filter — Filter by Shipped Volume with numeric comparison operators.
• Shipped Weight Filter — Filter by Shipped Weight with numeric comparison operators.
• Shipping Terms Filter — Filter by Shipping Terms using string comparison operators.
• Shipping Zone ID Filter — Filter by Shipping Zone ID using string comparison operators.
• Ship Via Filter — Filter by Ship Via using string comparison operators.
• Status Filter — Filter by Status using string comparison operators.
• To Warehouse ID Filter — Filter by To Warehouse ID using string comparison operators.
• Type Filter — Filter by Type using string comparison operators.
• Unlimited Packages Filter — Boolean filter for Unlimited Packages.
• Use Customers Account Filter — Boolean filter indicating use of customer's account.
• Warehouse ID Filter — Filter by Warehouse ID using string comparison operators.
• Workgroup ID Filter — Filter by Workgroup ID using string comparison operators.
• Custom Filter — Custom OData $filter expression applied in addition to predefined filters.

Output shape

a list of Shipment records represented as JSON objects

The returned data consists of Shipment records matching specified filters. Supports advanced filtering using a custom OData $filter expression in addition to individual filter fields.

Examples

Example 1: Retrieve shipments filtered by Customer ID and Shipment Date after a specific date

Set Customer ID Filter with operator 'Equals' and specific Customer ID, set Shipment Date Filter with operator 'After' and a date value.

Links

• n8n community nodes installation guide