Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceMutations

Inventory__bulk Remove Collections

Deletes several collections on the current tenant in one call. Collections associated with products (or not found) are skipped, not failed — compare requestedCount to affectedCount to see how many were actually deleted. Requires a signed-in staff user. Needs the `inventory__Collection` `delete` permission. Send the `x-tenant` header (the gateway sets it from your API key).

MUTATIONinventory__bulkRemoveCollections(input: BulkRemoveCollectionsInput!): BulkCollectionsMutationResult!

Deletes several collections on the current tenant in one call. Collections associated with products (or not found) are skipped, not failed — compare requestedCount to affectedCount to see how many were actually deleted. Requires a signed-in staff user. Needs the inventory__Collection delete permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

input*

Returns

  1. inventory__bulkRemoveCollections
affectedCount*Int!
requestedCount*Int!
Example Request
mutation Inventory__bulkRemoveCollections($input: BulkRemoveCollectionsInput!) {  inventory__bulkRemoveCollections(input: $input) {    affectedCount    requestedCount  }}
Variables
{  "input": {    "ids": [      "1"    ]  }}
Example Response
{  "data": {    "inventory__bulkRemoveCollections": {      "affectedCount": 10,      "requestedCount": 10    }  }}