Skip to main content

customersExport

Request a background CSV export of one kind of customer record for the current company. Use the returned processId to track progress and retrieve the completed download.

Business Rules​

  • Each kind writes the columns its import reads, in the same order, so an exported file can be edited and imported again.
  • The customers kind adds one custom.<handle> column per customer attribute that has a handle.
  • Every kind includes customers without a handle and products without a SKU. The import matches rows on them, so those rows cannot be imported back until one is set.
  • The configured export row limit applies.

Error Scenarios​

  • **Unauthenticated**: no user is logged in.
  • **Company required**: no company context is provided.
  • **Forbidden**: the user does not hold the export permission.

Permissions Required​

  • customers:export permission
customersExport(
  input: CustomersExportInput!
): AsynchronousActionResponse!

Arguments​

customersExport.input ● CustomersExportInput! non-null input common​

Parameters for CustomersExport

Type​

AsynchronousActionResponse object common​

Asynchronous action response type