Skip to main content

Orders API & advanced catalog operations

· 4 min read
Albert Tiñena
Albert Tiñena
Chief Technology Officer (CTO)
David Sancho
David Sancho
Principal Engineer & Technical Architect

The OpenTiendas API continues to expand with a new set of capabilities focused on order retrieval and advanced catalog management workflows.

This release introduces Orders endpoints, enabling integrations of order data with external systems, extends the catalog API with new bulk operations, improved filtering, and better integration tools for PIMs and ERPs, and makes the API available in OpenAPI format for use with AI tools and standard API tooling.

Orders API: retrieve and synchronize orders​

OpenTiendas now provides endpoints to retrieve orders from external systems, enabling integrations with ERPs, logistics platforms, and other management tools.

Get Order​

GET /api/v1/orders/{id}

Retrieve a specific order with detailed information, including:

  • Customer data
  • Billing and shipping addresses
  • Product lines
  • Amounts and totals
  • Payment status
  • Fulfillment status

This endpoint is designed for systems that need to consult individual orders in real time.

List Orders​

GET /api/v1/orders

Retrieve a paginated list of orders with support for filtering and sorting.

Supported filters include:

  • Creation date
  • Payment date
  • Fulfillment date
  • Payment status
  • Payment method
  • Delivery method

This enables order synchronization workflows with external systems.

Bulk updates at variant level​

To improve catalog synchronization, a new endpoint allows bulk updates directly on product variants.

POST /api/v1/variants/bulk-update

Key characteristics:

  • Operates directly at variant level
  • Designed for updating price, stock, and variant-specific attributes
  • Supports multiple matching strategies:
    • id
    • internal_id
    • ean
    • sku + supplier

Unlike the product bulk upsert, this endpoint allows updating specific variant data (such as price or stock) without modifying the overall product structure.

As with other bulk operations, processing is asynchronous, generating a background Job.

A new endpoint allows linking existing OpenTiendas catalog products/variants with external systems.

POST /api/v1/catalog/link-ids

This endpoint enables updating the internal_id of products and variants using matching strategies such as:

  • ean
  • sku + supplier

It is especially useful for:

  • Initial ERP or PIM integrations
  • Migrating existing catalogs without recreating products
  • Establishing a persistent mapping between systems

Once linked, external systems can rely on internal_id for future updates.

Improvements in product filtering​

The List Products endpoint now includes enhanced filtering capabilities.

Filter by slug​

Products can now be retrieved using their public identifier:

  • Filter by a single slug
  • Filter by multiple slugs in a single request

This improvement also applies to other resources that support slug filtering, such as categories and brands.

This makes it easier to integrate with systems that rely on public URLs as identifiers.

OpenAPI documentation for AI tools​

The OpenTiendas API documentation can now be downloaded in OpenAPI format, making it easier to use with AI-assisted development tools and standard API tooling.

👉 API Reference

This enables:

  • Using the API specification as context in tools like ChatGPT or Claude to generate code, queries, or integrations
  • Importing the API into tools such as Postman or Insomnia to explore and test endpoints
  • Automatically generating client code

This improvement is designed to accelerate integration development, allowing AI tools and developers to understand the API precisely and generate valid requests based on its specification.

Slug management via API​

It is now possible to modify the base slug (slug_base) via API for:

  • Products
  • Categories
  • Brands

Keep in mind:

Updating the slug will modify the public URL and may impact SEO (existing links and indexed pages).

Background Jobs​

All bulk operations continue to rely on the background Jobs system, ensuring safe processing of large updates without affecting store performance.

Jobs provide:

  • Asynchronous execution
  • Status tracking
  • Logs and result inspection

You can monitor Jobs in the backoffice:

Settings → Advanced Options → Jobs

What's next​

With Orders now available and catalog operations becoming more flexible, upcoming improvements will focus on:

  • Expanding order management capabilities
  • Improving real-time synchronization flows
  • Enhancing bulk operations performance and coverage
  • Continuing to evolve the API as a robust integration platform

👉 API Overview