Warehousing Module

The warehousing module manages inventory, stock levels, warehousing providers, and tokenized product handling.

Configuration Options

The warehousing module has no configuration options.

Module API

Access via modules.warehousing in the Unchained API context.

Provider Queries

Method	Arguments	Description
findProvider	{ warehousingProviderId }	Get a specific provider
findProviders	query?, options?	List warehousing providers
allProviders	—	Get all active providers (cached)
count	query?	Count providers
providerExists	{ warehousingProviderId }	Check if provider exists

Provider Mutations

Method	Arguments	Description
create	doc	Create a warehousing provider
update	warehousingProviderId, doc	Update provider
delete	providerId	Delete provider

Token Operations

For tokenized products (NFTs, digital assets):

Method	Arguments	Description
findToken	{ tokenId }, options?	Get a specific token
findTokens	selector, options?	List tokens
tokensCount	selector?	Count tokens
findTokensForUser	{ userId, limit?, offset? }	Get user's tokens
createTokens	tokens	Batch create tokens
updateTokenOwnership	tokenId, { userId, originalProductId? }	Transfer token ownership
invalidateToken	tokenId	Revoke a token
buildAccessKeyForToken	tokenId	Generate an access key

Usage

// Create a warehousing provider
await modules.warehousing.create({
  adapterKey: 'shop.unchained.warehousing.store',
  type: 'PHYSICAL',
  configuration: [],
});

// Find tokens for a user
const tokens = await modules.warehousing.findTokensForUser({
  userId: 'user-123',
  limit: 10,
});

// Transfer token ownership
await modules.warehousing.updateTokenOwnership('token-id', {
  userId: 'new-owner-id',
});

Events

Event	Payload	Description
WAREHOUSING_PROVIDER_CREATE	{ warehousingProvider }	Emitted when a warehousing provider is created
WAREHOUSING_PROVIDER_UPDATE	{ warehousingProvider }	Emitted when a warehousing provider is updated
WAREHOUSING_PROVIDER_REMOVE	{ warehousingProvider }	Emitted when a warehousing provider is removed

Related

• Warehousing Plugins - Available warehousing adapters
• ETH Minter - NFT minting plugin