Nexlogiq Commerce OS icon

Nexlogiq Commerce OS

Unified SaaS Engine for Shopify and WooCommerce

Customer → Get Many

AI-generated

Summary

Retrieve a list of customers from either Shopify or WooCommerce platform for a specified store, supporting filters and pagination.

Inputs

  • Platform (required) — Choose the e-commerce platform, either Shopify or WooCommerce.
  • Store URL (required) — The URL of the store to fetch customers from.
  • API Key / Consumer Key (required) — API key or consumer key for authenticating with the store's platform API.
  • API Secret / Consumer Secret — Required only for WooCommerce, this is the API secret or consumer secret for authentication.
  • Return All — For Shopify: whether to return all available customers. For WooCommerce: whether to return all available customers.
  • Limit — For Shopify only and if Return All is false, specifies the maximum number of customer records to return (between 1 and 250).
  • Options — For Shopify: optional filters including a query string to search customers by fields and a comma-separated list of customer IDs. For WooCommerce: optional filters including search text by name or email and customer role (all, administrator, or customer).

Output shape

a list of customer records

Returns multiple customer objects matching the filters and limit; if Return All is true, attempts to fetch all customers available from the specified store platform.

Examples

Example 1: Get first 50 customers from a Shopify store

Set Platform to Shopify, enter Store URL, API Key, and set Return All to false with Limit 50.

Example 2: Get all customers from a WooCommerce store with role 'customer'

Set Platform to WooCommerce, provide Store URL, API Key, API Secret, set Return All to true, and filter Role to 'customer'.

Links

Discussion