Customers > Customer Inventory > customerInventoryExport
Commerce APICustomersCustomer InventorycustomerInventoryExport
customerInventoryExport
POST:customer_inventory/export.json

Description

Export customer inventory into CSV format. Launches a task, when complete it will offer a downloadable result.

Permission bit: "customer_inventory.export"

Topic: Customer Inventory

Arguments

data: GenericExport!

Main argument for mutations.


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


type: CustomerInventoryTypeParam

Filter output by inventory type


Data Argument Fields

columns: [String!]


filter_fields: String

A fields specification to filter out data's unused fields (for the filter script)


filter_script: String

A script to filter the export items (JavaScript)

Valid when: filter_script's length doesn't exceed 100000 characters


ids: [String!]


options: ExportOptions


zip: Boolean


Result

ForeignShardedTask

Preview (typescript)

Loading module