The /commercetools command enables you to manage e-commerce operations with Commercetools. Perfect for:

  • Managing product catalogs
  • Creating and updating products
  • Searching product data
  • Handling product variants
  • Managing categories and pricing

Basic Usage

Use the command to interact with Commercetools:

/commercetools list all products
/commercetools create product "Premium T-Shirt" with price €100
/commercetools search for products containing "shirt"

Key Features

Product Management

  • List all products
  • Create new products
  • Update existing products
  • Manage product variants
  • Handle product types

Search & Filtering

  • Text-based search
  • Query predicates
  • Category filtering
  • SKU-based searches
  • Complex filtering

Product Data

  • Master data management
  • Staged vs current versions
  • Multilingual content
  • Price management
  • Image handling

Categories & Organization

  • Category management
  • Product classification
  • Hierarchical structures
  • Taxonomy organization

Example Commands

List Products

/commercetools show all products with pagination

Create Product

/commercetools create "Premium Tech T-Shirt" in category "clothing" with price €100

Search Products

/commercetools search for products with text "premium shirt"

Filter by SKU

/commercetools find product with SKU "sku_SAPPHIRE_variant1_1374314429721"

Query by Predicate

/commercetools find products where slug equals "super-product"

Product Structure

Basic Properties

  • id: Unique product identifier
  • version: Product version number
  • productType: Product type reference
  • masterData: Current and staged data
  • taxCategory: Tax classification

Master Data

  • current: Published version
  • staged: Draft version
  • published: Publication status
  • hasStagedChanges: Pending changes flag

Product Variants

  • masterVariant: Primary variant
  • variants: Additional variants
  • sku: Stock keeping unit
  • prices: Pricing information
  • images: Product images
  • attributes: Custom attributes

Search Capabilities

/commercetools search products with text "premium" in English

Query Predicates

Use complex filtering with predicates:

  • Field-specific searches
  • Logical operators (and, or)
  • Nested property access
  • Locale-specific queries

Predicate Examples

// Search by slug and name
masterData(current(slug(en="super-product") and name(en="Super Product")))

// Search by variant SKU
masterData(current(variants(sku="SKU123")))

Product Creation

Required Fields

  • productType: Product type reference
  • name: Multilingual name object
  • slug: URL-friendly identifier
  • masterVariant: Primary variant data

Optional Fields

  • description: Product description
  • categories: Category references
  • taxCategory: Tax classification
  • variants: Additional variants

Pricing Structure

Price Objects

  • currencyCode: Currency (EUR, USD, etc.)
  • centAmount: Price in cents
  • country: Country-specific pricing
  • channel: Sales channel

Multiple Currencies

Support for:

  • Multi-currency pricing
  • Regional variations
  • Channel-specific prices
  • Dynamic pricing

Image Management

Image Properties

  • url: Image URL
  • dimensions: Width and height
  • label: Image description
  • variant: Associated variant

Image Handling

  • Multiple images per variant
  • Different sizes/formats
  • CDN integration
  • Optimization support

Localization

Multilingual Support

  • name: Localized names
  • description: Localized descriptions
  • slug: Localized URLs
  • attributes: Localized values

Locale Codes

  • en: English
  • de: German
  • fr: French
  • es: Spanish
  • And many more

Version Management

Current vs Staged

  • current: Live/published version
  • staged: Draft/preview version
  • published: Publication status
  • hasStagedChanges: Pending updates

Publishing Workflow

  1. Create/edit staged version
  2. Review changes
  3. Publish to current
  4. Update live catalog

Query Parameters

Pagination

  • offset: Starting position
  • limit: Results per page
  • count: Returned items
  • total: Total available

Filtering

  • where: Query predicates
  • text: Text search
  • fuzzy: Fuzzy matching
  • sort: Result ordering

Best Practices

  1. Product Data Quality

    • Use descriptive names
    • Include detailed descriptions
    • Provide high-quality images
    • Set appropriate categories
  2. Search Optimization

    • Use relevant keywords
    • Implement proper categorization
    • Maintain clean SKU structure
    • Enable text search
  3. Version Control

    • Use staged versions for drafts
    • Publish only reviewed content
    • Track version changes
    • Maintain data consistency
  4. Performance

    • Use pagination for large datasets
    • Optimize query predicates
    • Cache frequently accessed data
    • Monitor API usage

Common Patterns

Product Catalog

/commercetools list products by category "electronics" with prices
/commercetools find products with available variants

Price Updates

/commercetools update product prices for currency EUR

Category Management

/commercetools organize products by category hierarchy

Tips

  • Always URL-encode query predicates
  • Use specific product types for better organization
  • Leverage staged versions for content review
  • Include multilingual support from the start
  • Use descriptive SKUs for easier management

The /commercetools command enables you to manage e-commerce operations with Commercetools. Perfect for:

  • Managing product catalogs
  • Creating and updating products
  • Searching product data
  • Handling product variants
  • Managing categories and pricing

Basic Usage

Use the command to interact with Commercetools:

/commercetools list all products
/commercetools create product "Premium T-Shirt" with price €100
/commercetools search for products containing "shirt"

Key Features

Product Management

  • List all products
  • Create new products
  • Update existing products
  • Manage product variants
  • Handle product types

Search & Filtering

  • Text-based search
  • Query predicates
  • Category filtering
  • SKU-based searches
  • Complex filtering

Product Data

  • Master data management
  • Staged vs current versions
  • Multilingual content
  • Price management
  • Image handling

Categories & Organization

  • Category management
  • Product classification
  • Hierarchical structures
  • Taxonomy organization

Example Commands

List Products

/commercetools show all products with pagination

Create Product

/commercetools create "Premium Tech T-Shirt" in category "clothing" with price €100

Search Products

/commercetools search for products with text "premium shirt"

Filter by SKU

/commercetools find product with SKU "sku_SAPPHIRE_variant1_1374314429721"

Query by Predicate

/commercetools find products where slug equals "super-product"

Product Structure

Basic Properties

  • id: Unique product identifier
  • version: Product version number
  • productType: Product type reference
  • masterData: Current and staged data
  • taxCategory: Tax classification

Master Data

  • current: Published version
  • staged: Draft version
  • published: Publication status
  • hasStagedChanges: Pending changes flag

Product Variants

  • masterVariant: Primary variant
  • variants: Additional variants
  • sku: Stock keeping unit
  • prices: Pricing information
  • images: Product images
  • attributes: Custom attributes

Search Capabilities

/commercetools search products with text "premium" in English

Query Predicates

Use complex filtering with predicates:

  • Field-specific searches
  • Logical operators (and, or)
  • Nested property access
  • Locale-specific queries

Predicate Examples

// Search by slug and name
masterData(current(slug(en="super-product") and name(en="Super Product")))

// Search by variant SKU
masterData(current(variants(sku="SKU123")))

Product Creation

Required Fields

  • productType: Product type reference
  • name: Multilingual name object
  • slug: URL-friendly identifier
  • masterVariant: Primary variant data

Optional Fields

  • description: Product description
  • categories: Category references
  • taxCategory: Tax classification
  • variants: Additional variants

Pricing Structure

Price Objects

  • currencyCode: Currency (EUR, USD, etc.)
  • centAmount: Price in cents
  • country: Country-specific pricing
  • channel: Sales channel

Multiple Currencies

Support for:

  • Multi-currency pricing
  • Regional variations
  • Channel-specific prices
  • Dynamic pricing

Image Management

Image Properties

  • url: Image URL
  • dimensions: Width and height
  • label: Image description
  • variant: Associated variant

Image Handling

  • Multiple images per variant
  • Different sizes/formats
  • CDN integration
  • Optimization support

Localization

Multilingual Support

  • name: Localized names
  • description: Localized descriptions
  • slug: Localized URLs
  • attributes: Localized values

Locale Codes

  • en: English
  • de: German
  • fr: French
  • es: Spanish
  • And many more

Version Management

Current vs Staged

  • current: Live/published version
  • staged: Draft/preview version
  • published: Publication status
  • hasStagedChanges: Pending updates

Publishing Workflow

  1. Create/edit staged version
  2. Review changes
  3. Publish to current
  4. Update live catalog

Query Parameters

Pagination

  • offset: Starting position
  • limit: Results per page
  • count: Returned items
  • total: Total available

Filtering

  • where: Query predicates
  • text: Text search
  • fuzzy: Fuzzy matching
  • sort: Result ordering

Best Practices

  1. Product Data Quality

    • Use descriptive names
    • Include detailed descriptions
    • Provide high-quality images
    • Set appropriate categories
  2. Search Optimization

    • Use relevant keywords
    • Implement proper categorization
    • Maintain clean SKU structure
    • Enable text search
  3. Version Control

    • Use staged versions for drafts
    • Publish only reviewed content
    • Track version changes
    • Maintain data consistency
  4. Performance

    • Use pagination for large datasets
    • Optimize query predicates
    • Cache frequently accessed data
    • Monitor API usage

Common Patterns

Product Catalog

/commercetools list products by category "electronics" with prices
/commercetools find products with available variants

Price Updates

/commercetools update product prices for currency EUR

Category Management

/commercetools organize products by category hierarchy

Tips

  • Always URL-encode query predicates
  • Use specific product types for better organization
  • Leverage staged versions for content review
  • Include multilingual support from the start
  • Use descriptive SKUs for easier management