Resource Model

API Fundamentals

Resource Model

LCE APIs organize commerce data by business domain. Requests use operation-specific models, while responses commonly wrap the requested resource or result collection in a service response envelope.

Domain-oriented resources

A resource represents a business concept owned by an LCE service. Integrations should follow the model documented for the selected operation instead of assuming that fields are identical across domains.

Catalog

Products and metadata

Products, variants, categories, brands, properties, options and translations.

Commerce

Inventory and orders

SKUs, prices, stock, carts, orders, deliveries, claims and related processes.

Platform

Identity and organization

Users, roles, applications, tenants, organizations, branches and contacts.

Query and command operations

Operation pattern	Purpose	Client guidance
`/query/...`	Retrieves one or more resources using a JSON query model.	Treat as read-only when the operation description confirms query behavior, even if the HTTP method is POST.
`/create`	Creates a new resource or relationship.	Use the exact create model and retain the identifiers returned by the service.
`/update`	Changes an existing resource.	Send only fields supported by that update model; do not substitute a create model.
`/delete`	Removes or deactivates a resource according to domain rules.	Confirm the target identifier and do not automatically retry an uncertain result.
`/process`	Runs a domain workflow or action.	Assume side effects and follow operation-specific validation and retry guidance.

Service response envelope

Many LCE operations return a domain-specific service response. Query responses commonly include the following fields:

{
  "type": "Success",
  "result": [ ... ],
  "resultCount": 20,
  "totalCount": 126,
  "currentPageIndex": 0,
  "code": null,
  "message": null,
  "errors": null,
  "serviceTook": 18,
  "totalTook": 24
}

Field	Meaning
`type`	Service outcome such as `Success`, `Completed`, `Pending`, `Timeout` or `Error`.
`result`	The resource, collection or operation result defined by the endpoint schema.
`resultCount`	Number of records returned in the current response.
`totalCount`	Total number of matching records when supplied by the operation.
`code`, `message`, `errors`	Service-level outcome and diagnostic information.
`serviceTook`, `totalTook`	Timing information when populated by the service.

Common data conventions

Date-time values use the OpenAPI date-time format.
Status and outcome values are represented by the enum defined in the operation schema.
Nullable fields can be absent or null; do not replace them with empty strings or zero unless the API defines that meaning.
Tenant, application and user context can be part of a request model. Supply only values assigned to the target environment.
Relationship expansion is operation-specific and can be requested through includes where supported.