Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Customer Location → Get List

AI-generated

Summary

Retrieves customer location records from Acumatica, applying optional OData $filter criteria specified via fixed-collection filter fields.

Inputs

  • filterFields — Zero or more fixed-collection filter parameters, each consisting of an operator (default 'eq', options: eq/contains/startswith) and a value (boolean, string, or dateTime depending on the filter). Filters with empty/default values are skipped. Supported filters include: activeFilter, addressOverrideFilter, calendarFilter, contactOverrideFilter, createdDateTimeFilter, customerFilter, defaultFilter, defaultProjectFilter, entityUsageTypeFilter, fedExGroundCollectFilter, foBPointFilter, insuranceFilter, lastModifiedDateTimeFilter, locationIDFilter, locationNameFilter, priceClassFilter, residentialDeliveryFilter, saturdayDeliveryFilter, shippingBranchFilter, shippingRuleFilter, shippingTermsFilter, shippingZoneFilter, shipViaFilter, statusFilter, taxExemptionNbrFilter, taxRegistrationIDFilter, taxZoneFilter, warehouseFilter, extRefNbrFilter. Additionally, customFilter accepts an advanced OData $filter string for arbitrary filtering.

Output shape

Array of Customer Location record objects as returned by the Acumatica API, containing location-specific fields such as ID, location name, address override, contact override, and other attributes defined by the resource schema.

The operation issues a GET request to the Acumatica Customer Location endpoint. The query string includes any applicable OData $filter parameters built from the provided filter fields. If no filters are supplied, the full list of customer locations is returned.

Examples

Example 1: Get all customer locations

Leave all filter fields at their default values; do not set customFilter.

Example 2: Get active customer locations only

Set activeFilter operator to 'eq' and value to true.

Links

Discussion