RebuildStockOutput

RebuildStockOutput Type

Audience: Programmer

Response type returned by the rebuildInventoryStock mutation indicating whether the stock table rebuild completed successfully.

Fields

Field	Type	Description
success	Boolean!	Whether the stock table was successfully rebuilt

Usage

This type is returned by the rebuildInventoryStock mutation after attempting to rebuild the inventory stock table for the current tenant.

GraphQL Response Example

{
  "data": {
    "rebuildInventoryStock": {
      "success": true
    }
  }
}

Field Details

success

A non-nullable boolean that indicates the outcome of the rebuild operation:

• true -- the stock table was fully recalculated and committed

• The mutation returns an error (rather than false) if the rebuild fails, so a successful response will always contain success: true

Example Usage in Code

const REBUILD_INVENTORY_STOCK = gql`
  mutation RebuildInventoryStock {
    rebuildInventoryStock {
      success
    }
  }
`;

const { data } = await client.mutate({
  mutation: REBUILD_INVENTORY_STOCK,
});

if (data.rebuildInventoryStock.success) {
  console.log('Inventory stock table rebuilt successfully');
}

Service

This type is defined in the Inventory service.

Related

• Mutation: rebuildInventoryStock

• Type: Stock