Documentation/Commerce user guides

Entity identifiers

Use readable IDs while retaining stable UUID relationships.

On this page

Two identifiers, two purposes

Numeric entity_id helps operators identify records. UUID id remains the route, relationship, event and integration key.

Numbers are unique per table per installation. Product 12 and customer 12 differ; include entity type and store context.

Find and communicate a record

  1. Find the Entity ID column or label.
  2. Search supported lists with 123 or #123.
  3. Sort numerically or include IDs in exports.
  4. Use order numbers, ticket numbers or SKUs where the workflow expects them.

Follow the response contract

  • Read-only and database-generated: omit from create/edit inputs.
  • Existing UUID routes and relationships stay UUID-based.
  • Identifiers are immutable; gaps are expected.
  • Allowed range: 1–9,007,199,254,740,991, exactly representable in JavaScript.
  • Historical receipts may omit the number; never substitute zero.

Coverage and reference fields

The initial rollout covers 43 business tables. Sessions, logs, junctions and projections keep existing keys.

Older fields named entity_id in audit, translation or override records may reference UUIDs. Follow each response schema.