usersExport Mutation

Description

Exports buyers to a CSV file. If listRef or term is provided, only matching buyers are exported. Otherwise, all buyers and guest buyers from orders are exported. The CSV includes buyer information, addresses, order statistics, and account status. Only accessible to admin users. Returns a signed URL to download the CSV file.

mutation usersExport($listRef: ID, $term: String) {
  usersExport(listRef: $listRef, term: $term)
}

Variables

{
    "listRef": "82a0ca05543e6a218f8d627e",
    "term": "term"
}

Response

{
    "usersExport": "example"
}

Arguments

Name	Type	Description
listRef	ID	Reference ID of a customer list to filter buyers by. If provided, only buyers who are members of this list are exported.
term	String	Search term to filter buyers by. If provided, only buyers matching this term are exported.

Returns

String