Shopware icon

Shopware

Shopware

Actions778

Customer Address → Get Customer Address List

AI-generated

Overview

This node operation retrieves a list of customer addresses from the Shopware platform. It supports pagination and query filtering, allowing users to specify the maximum number of addresses to return per page, the page number to retrieve, and an encoded SwagQL query for advanced filtering. This operation is useful for scenarios where you need to fetch customer address data for analysis, reporting, or integration with other systems.

Use Case Examples

  1. Fetch the first 50 customer addresses to display in a CRM system.
  2. Retrieve customer addresses on page 2 with a specific filter query to process targeted marketing campaigns.

Properties

Name Meaning
Limit Maximum number of customer address resources to be returned in a single page.
Page The page number of the customer address list to be returned.
Query Encoded SwagQL query in JSON format to filter the customer address list.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • data - Array of customer address objects returned from the API.
  • meta - Metadata about the response such as pagination details.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access customer address data.
  • Check the query parameter format for valid JSON-encoded SwagQL to avoid query errors.
  • If using batching, verify batch size and interval settings to prevent request throttling issues.
  • If SSL errors occur, consider enabling the option to ignore SSL certificate validation, but be aware of security risks.

Discussion