Skip to main content

InventoryExportInput

Parameters to filter an inventory export.

input InventoryExportInput {
  brandId: ID @deprecated
  brandIds: [ID!]
  buildingIds: [ID!]
  depths: [DepthEnum!]
  includeArchived: Boolean
  keyword: String
  locationGranularity: LocationGranularityEnum
  locationIds: [ID!]
  productStatus: StatusEnum
  productType: ProductTypeEnum
  quickSearch: String
  stockDepth: DepthEnum @deprecated
}

Fields​

InventoryExportInput.brandId ● ID deprecated scalar common​

DEPRECATED

Use brand_ids instead.

Filter by inventory's product brand. If omitted, exports inventory for products from all brands in the company.

InventoryExportInput.brandIds ● [ID!] list scalar common​

Filter by product brand IDs. If omitted, exports inventory for all brands in the company.

InventoryExportInput.buildingIds ● [ID!] list scalar common​

Filter by building (warehouse) IDs.

InventoryExportInput.depths ● [DepthEnum!] list enum inventory​

Filter by stock depth.

InventoryExportInput.includeArchived ● Boolean scalar common​

Include archived inventory items in the export.

InventoryExportInput.keyword ● String scalar common​

Keyword to search for in name, SKU, and UPC.

InventoryExportInput.locationGranularity ● LocationGranularityEnum enum inventory​

Controls row grouping: COMBINED (one row per SKU), WAREHOUSE (one row per warehouse per SKU), or WAREHOUSE_LOCATION (one row per location per SKU). Defaults to WAREHOUSE_LOCATION.

InventoryExportInput.locationIds ● [ID!] list scalar common​

Filter by warehouse location IDs.

InventoryExportInput.productStatus ● StatusEnum enum common​

Filter by product status.

InventoryExportInput.productType ● ProductTypeEnum enum products​

Filter by product type.

InventoryExportInput.quickSearch ● String scalar common​

Quick search by SKU prefix or name. Mirrors the inventory list's search box.

InventoryExportInput.stockDepth ● DepthEnum deprecated enum inventory​

DEPRECATED

Use depths instead.

Filter by stock depth.

Member Of​

RequestInventoryExportInput input