GET

Merchant commerce

List products

/api/v2/commerce/products
AUTHENTICATIONBearer token · commerce:readService ownercommerce-serviceContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

List reusable merchant catalog products.

When to use it

List one merchant's reusable catalog products before constructing invoice line items or presenting purchasable terms.

OUTCOME · Discover

What changes

Read-only owner-scoped projection of catalog products; it cannot activate a merchant, publish a product, create checkout, assert payment, settle a wallet, fulfill an order, move value, or grant authority.

WHY IT MATTERS

  • Gives people and agents a contract-backed way to discover products.
  • Connects catalog and invoice operations to payment collection and treasury reconciliation without making presentation state or a reserved address proof of payment.

ISOLATION + AUTHORITY

Tenant, workspace, merchant, product, customer, invoice, checkout, collection wallet, payment, custody, treasury settlement, tax or compliance policy, and finality remain distinct. Merchant configuration or invoice state cannot authorize wallet signing, move funds, prove settlement, or grant publisher, matching, or trading authority.

BEFORE YOU CALL

  • Authenticate at the documented boundary: bearer+scope.
  • Supply the required merchant_uuid (query) exactly as defined by the live contract.

WHAT TO DO NEXT

  • Select one canonical identifier from the response and open its detail operation when the live contract exposes one.
  • Open the canonical merchant, invoice, payment, or rotational-wallet record for the next stage and verify settlement independently before marking the commercial obligation complete.

AGENT GUIDANCE

  • Use products only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Supply the required merchant_uuid (query) exactly as defined by the live contract.
  • Distinguish merchant readiness, product availability, invoice issuance, checkout presentation, payment observation, wallet synchronization, treasury settlement, cancellation, and reconciliation.
  • Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.
Contract reference

Use the deployed OpenAPI for exact parameters, schemas and security requirements. The tables below provide integration guidance.

Open this operation in OpenAPI

Request and response

Make the request

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE
AuthorizationheaderRequired

Bearer tokenCredential containing commerce:read authority.EXAMPLEBearer hc_live_…

merchant_uuidqueryRequired

32-character merchant identifierRequired 32-character owning merchant identifierEXAMPLEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

cursorqueryOptional

32-character hexadecimal cursorCursor returned by the preceding page. Omit it to use the documented default or unfiltered behavior.EXAMPLEeyJvZmZzZXQiOjUwfQ

limitqueryOptional

integer · 1–200Maximum records; defaults to 50. Omit it to use the documented default or unfiltered behavior.Schema range: 0 to unboundedEXAMPLE50

statusqueryOptional

DRAFT | ACTIVE | ARCHIVEDExact product lifecycle filter. Omit it to use the documented default or unfiltered behavior.EXAMPLEACTIVE

qqueryOptional

string · 1–200Name or SKU search, maximum 200 characters. Omit it to use the documented default or unfiltered behavior.EXAMPLEtreasury

X-Request-IDheaderOptional

stringOptional caller correlation identifier. The gateway emits the effective value on the response.

RESPONSES

Status and payload examples

200When promoted, the authenticated workspace receives the owner-scoped Commerce projection and page metadata under no-store; read state grants no checkout, payment, settlement, fulfillment, or authority transition.Read completed · JSON RESPONSE+
{}
INTEGRATION DECISION
CALLER ACTION
Accept the returned representation or receipt, then select one canonical identifier from the response and open its detail operation when the live contract exposes one.
RETRY SAFETY
For another page, send the returned opaque cursor unchanged with the same filters. Restart without a cursor when a new snapshot is required.
STATE RECONCILIATION
Use returned identifiers and versions as the comparison point for later reads. Re-read the merchant or product version, invoice and linked payment-request state, and the exact network-scoped wallet projection before retrying with the same idempotency key and byte-equivalent request. Invoice state alone is not payment, settlement, or fulfillment finality.
400A cursor, limit, filter, identifier, or timestamp boundary is malformed.Request must change · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY
Do not retry the same invalid request. A corrected read may be sent as a new attempt.
STATE RECONCILIATION
Compare the submitted values with the documented constraints before another call. Re-read the merchant or product version, invoice and linked payment-request state, and the exact network-scoped wallet projection before retrying with the same idempotency key and byte-equivalent request. Invoice state alone is not payment, settlement, or fulfillment finality.
ESCALATE WHEN
Escalate when a protected transition remains ambiguous after authoritative Commerce, Payments, and operational-wallet reconciliation. Commerce settlement execution remains frozen; never manufacture value movement by combining invoice, payment, or wallet calls.
401The bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY
Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION
Authentication failed before an authoritative read was returned for workspace-isolated merchant profiles, catalog publication, invoices, linked payment requests, and verify-only rotational-wallet observations.
ESCALATE WHEN
Escalate when a protected transition remains ambiguous after authoritative Commerce, Payments, and operational-wallet reconciliation. Commerce settlement execution remains frozen; never manufacture value movement by combining invoice, payment, or wallet calls.
403The principal lacks commerce:read or access to the selected merchant boundary.Authority or policy denied · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY
Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION
Confirm the caller and resource resolve to the same authority boundary for workspace-isolated merchant profiles, catalog publication, invoices, linked payment requests, and verify-only rotational-wallet observations.
ESCALATE WHEN
Escalate when a protected transition remains ambiguous after authoritative Commerce, Payments, and operational-wallet reconciliation. Commerce settlement execution remains frozen; never manufacture value movement by combining invoice, payment, or wallet calls.
503Commerce, catalog, invoice, checkout, wallet observation, or evidence ownership is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY
Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION
Re-read the merchant or product version, invoice and linked payment-request state, and the exact network-scoped wallet projection before retrying with the same idempotency key and byte-equivalent request. Invoice state alone is not payment, settlement, or fulfillment finality.
ESCALATE WHEN
Escalate when a protected transition remains ambiguous after authoritative Commerce, Payments, and operational-wallet reconciliation. Commerce settlement execution remains frozen; never manufacture value movement by combining invoice, payment, or wallet calls.

OPERATIONAL NOTES

Security and lifecycle guarantees

  • List reusable merchant catalog products. Authoritative owner: commerce-service.
  • The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
  • The tables and examples are derived from the current gateway source OpenAPI. Re-fetch the deployed OpenAPI before execution; deployment status is shown separately on this page.
  • Only parameters present in the OpenAPI operation are accepted; undocumented query keys fail closed with HTTP 422.
Reference version and availability details

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-10-02T23:27:55.510Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation Return to the V2 directory