Skip to content
/Locales

Apiera REST API (1.0.0)

The Apiera REST API provides programmatic access to the Apiera platform, enabling seamless integration with your existing systems and workflows.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.apiera.io/_mock/openapi
http://localhost:5281

Tag Contents

Operations

Tags

Operations

Skus

Operations

Sku Dimensions

Operations

Sku Weights

Operations

Family Asset Types

Operations

Family Attributes

Operations

Family Categories

Operations

Families

Operations

Family Relation Types

Operations

Product Assets

Operations

Product Asset Types

Operations

Product Attributes

Operations

Product Categories

Operations

Product Contents

Operations

Products

Operations

Product Metadata

Operations

Product Relations

Operations

Product Relation Types

Operations

Product Tags

Operations

Product Terms

Operations

Organization Members

Operations

Organizations

Operations

Organization Roles

Operations

Locales

Operations

List locales

Request

Retrieves a paginated list of locales with optional filtering.

Security
Bearer
Query
uuids[eq]Array of strings(uuid)

Filter by one or more UUIDs. Accepts multiple values.

names[eq]Array of strings

Filter by one or more exact names. Accepts multiple values.

name[contains]string

Filter by partial name match.

name[starts]string

Filter by name prefix.

name[ends]string

Filter by name suffix.

name[order]string

Sort order for name field. Values: asc, desc.

codes[eq]Array of strings

Filter by one or more exact codes. Accepts multiple values.

code[contains]string

Filter by partial code match.

code[starts]string

Filter by code prefix.

code[ends]string

Filter by code suffix.

code[order]string

Sort order for code field. Values: asc, desc.

statuses[eq]Array of strings

Filter by one or more statuses. Accepts multiple values.

Items Enum"draft""active""inactive""removed"
status[order]string

Sort order for status field. Values: asc, desc.

createdAt[eq]string(date-time)

Filter by exact creation timestamp.

Example: createdAt[eq]=2025-11-23T14:15:22.123456Z
createdAt[min]string(date-time)

Filter by minimum creation timestamp.

Example: createdAt[min]=2025-11-23T14:15:22.123456Z
createdAt[max]string(date-time)

Filter by maximum creation timestamp.

Example: createdAt[max]=2025-11-23T14:15:22.123456Z
createdAt[order]string

Sort order for creation timestamp. Values: asc, desc.

updatedAt[eq]string(date-time)

Filter by exact update timestamp.

Example: updatedAt[eq]=2025-11-23T14:15:22.123456Z
updatedAt[min]string(date-time)

Filter by minimum update timestamp.

Example: updatedAt[min]=2025-11-23T14:15:22.123456Z
updatedAt[max]string(date-time)

Filter by maximum update timestamp.

Example: updatedAt[max]=2025-11-23T14:15:22.123456Z
updatedAt[order]string

Sort order for update timestamp. Values: asc, desc.

isDefault[eq]boolean

Filter by default status. Values: true, false.

isRemoved[eq]boolean

Filter by removed status. Values: true, false.

pageinteger(int32)

Page number for pagination. Default is 1.

sizeinteger(int32)

Page size for pagination. Default is 20.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/locales?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&names%5Beq%5D=string&name%5Bcontains%5D=string&name%5Bstarts%5D=string&name%5Bends%5D=string&name%5Border%5D=string&codes%5Beq%5D=string&code%5Bcontains%5D=string&code%5Bstarts%5D=string&code%5Bends%5D=string&code%5Border%5D=string&statuses%5Beq%5D=draft&status%5Border%5D=string&createdAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Border%5D=string&updatedAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Border%5D=string&isDefault%5Beq%5D=true&isRemoved%5Beq%5D=true&page=0&size=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved paginated list of locales.

Bodyapplication/json
itemsArray of objects(LocaleResponse)required
items[].​uuidstring(uuid)required

Unique identifier for this locale.

items[].​createdAtstring(date-time)required

Timestamp when this locale was created.

Example: "2025-11-23T14:15:22.123456Z"
items[].​updatedAtstring(date-time)required

Timestamp when this locale was last modified.

Example: "2025-11-23T14:15:22.123456Z"
items[].​removedAtstring or null(date-time)

Timestamp when this locale was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
items[].​statusstringrequired

Current lifecycle status of this locale.

Enum"draft""active""inactive""removed"
items[].​namestringrequired

Display name for this locale.

items[].​codestringrequired

ISO language or locale code.

items[].​isDefaultbooleanrequired

Whether this is the default locale for the tenant.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json
{
  "uuid": "456e7890-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "active",
  "name": "English (US)",
  "code": "en-US",
  "isDefault": true
}

Create locale

Request

Creates a new locale for multi-language content support.

Security
Bearer
Bodyapplication/jsonrequired
namestring[ 2 .. 100 ] charactersrequired

Display name for the locale.

codestring[ 2 .. 35 ] charactersrequired

ISO language or locale code.

isDefaultbooleanrequired

Whether this locale should be the default for the tenant.

curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/locales \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "code": "string",
    "isDefault": true
  }'

Responses

Locale created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this locale.

createdAtstring(date-time)required

Timestamp when this locale was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this locale was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this locale was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this locale.

Enum"draft""active""inactive""removed"
namestringrequired

Display name for this locale.

codestringrequired

ISO language or locale code.

isDefaultbooleanrequired

Whether this is the default locale for the tenant.

Response
application/json
{
  "uuid": "456e7890-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "draft",
  "name": "English (US)",
  "code": "en-US",
  "isDefault": true
}

Get locale

Request

Retrieves complete details for a single locale.

Security
Bearer
Path
localeUuidstring(uuid)required

Unique identifier of the locale.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/locales/{localeUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved locale.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this locale.

createdAtstring(date-time)required

Timestamp when this locale was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this locale was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this locale was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this locale.

Enum"draft""active""inactive""removed"
namestringrequired

Display name for this locale.

codestringrequired

ISO language or locale code.

isDefaultbooleanrequired

Whether this is the default locale for the tenant.

Response
application/json
{
  "uuid": "456e7890-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "active",
  "name": "English (US)",
  "code": "en-US",
  "isDefault": true
}

Update locale

Request

Updates an existing locale. Only provided fields are updated.

Security
Bearer
Path
localeUuidstring(uuid)required

Unique identifier of the locale.

Bodyapplication/jsonrequired
namestring or null[ 2 .. 100 ] characters

Updated display name for the locale.

codestring or null[ 2 .. 35 ] characters

Updated ISO language or locale code.

isDefaultboolean or null

Updated default status for this locale.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/locales/{localeUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "code": "string",
    "isDefault": true
  }'

Responses

Locale updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this locale.

createdAtstring(date-time)required

Timestamp when this locale was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this locale was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this locale was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this locale.

Enum"draft""active""inactive""removed"
namestringrequired

Display name for this locale.

codestringrequired

ISO language or locale code.

isDefaultbooleanrequired

Whether this is the default locale for the tenant.

Response
application/json
{
  "uuid": "456e7890-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "active",
  "name": "English (United States)",
  "code": "en-US",
  "isDefault": true
}

Delete locale

Request

Permanently deletes a locale. Cannot be undone.

Security
Bearer
Path
localeUuidstring(uuid)required

Unique identifier of the locale.

curl -i -X DELETE \
  'https://docs.apiera.io/_mock/openapi/v1/locales/{localeUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Locale deleted successfully.

Response
No content

Transition locale lifecycle

Request

Transitions a locale to a different lifecycle state. Valid transitions depend on current status.

Security
Bearer
Path
localeUuidstring(uuid)required

Unique identifier of the locale.

Bodyapplication/jsonrequired
transitionstringrequired

Lifecycle transition to apply. Valid transitions depend on current status.

Enum"draft""activate""deactivate""remove""restore"
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/locales/{localeUuid}/actions/lifecycle' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transition": "draft"
  }'

Responses

Locale transitioned successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this locale.

createdAtstring(date-time)required

Timestamp when this locale was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this locale was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this locale was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this locale.

Enum"draft""active""inactive""removed"
namestringrequired

Display name for this locale.

codestringrequired

ISO language or locale code.

isDefaultbooleanrequired

Whether this is the default locale for the tenant.

Response
application/json
{
  "uuid": "456e7890-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "active",
  "name": "English (US)",
  "code": "en-US",
  "isDefault": true
}

Category Contents

Operations

Categories

Operations

Brand Contents

Operations

Brands

Operations

Attribute Contents

Operations

Attributes

Operations

Attribute Term Contents

Operations

Attribute Terms

Operations

Assets

Operations

Asset Files

Operations

Asset Metadata

Operations
© 2025 Apiera AS