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 → Get List

AI-generated

Summary

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.

Links

Discussion