Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Big Commerce Stores → Get List

AI-generated

Summary

Retrieves a list of BigCommerce store configurations from the Acumatica API, applying optional filters.

Inputs

  • AccessTokenFilter — Filters stores by Access Token using an operator (Equals, Contains, Starts With).
  • ActiveFilter — Filters stores by Active status (boolean).
  • APIPathFilter — Filters stores by API Path using an operator (Equals, Contains, Starts With).
  • ClientIDFilter — Filters stores by Client ID using an operator (Equals, Contains, Starts With).
  • ConnectorFilter — Filters stores by Connector using an operator (Equals, Contains, Starts With).
  • DefaultFilter — Filters stores by Default status (boolean).
  • StoreAdminPathFilter — Filters stores by Store Admin Path using an operator (Equals, Contains, Starts With).
  • StoreNameFilter — Filters stores by Store Name using an operator (Equals, Contains, Starts With).
  • WebDAVPasswordFilter — Filters stores by Web DAV Password using an operator (Equals, Contains, Starts With).
  • WebDAVPathFilter — Filters stores by Web DAV Path using an operator (Equals, Contains, Starts With).
  • WebDAVUsernameFilter — Filters stores by Web DAV Username using an operator (Equals, Contains, Starts With).
  • customFilter — Advanced OData $filter expression (e.g., CustomerID/value eq 'CUST001') applied in addition to the specific filters above.

Output shape

A list of items, each representing a BigCommerce store configuration.

The specific fields available in the returned items are determined by the Acumatica schema for BigCommerce Stores and are generated dynamically; no fields are hardcoded in the UI.

Examples

Example 1: Retrieve all active BigCommerce stores.

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

Example 2: Find a specific store by its Store Name.

Set StoreNameFilter.operator to 'eq' and StoreNameFilter.value to the target name.

Example 3: Apply an advanced OData filter to list stores with a specific Client ID.

Set ClientIDFilter.operator to 'eq' and ClientIDFilter.value to the ID, or use the customFilter field.

Links

Discussion