Skip to content
API Reference
/
/
List product relation typ...

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

List product relation types

Request

Retrieves a paginated list of product relation types with optional filtering.

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

Filter by one or more UUIDs. Accepts multiple values.

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.

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.

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/product-relation-types?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&codes%5Beq%5D=string&code%5Bcontains%5D=string&code%5Bstarts%5D=string&code%5Bends%5D=string&code%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&page=0&size=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved paginated list of product relation types.

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

Unique identifier for this product relation type.

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

Timestamp when this product relation type was created.

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

Timestamp when this product relation type was last modified.

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

Code for this product relation type.

items[].​directionstringrequired

Direction of the relation. OneWay creates a directional relation. TwoWay creates a symmetrical relation visible from both products.

Enum"oneWay""twoWay"
items[].​reverseRelationTypeUuidstring or null(uuid)

For one-way relations, links to another relation type that represents the reverse perspective. Example: 'accessory' links to 'compatible-with' so accessories show compatible products.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json
[
  {
    "uuid": "eee11111-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "code": "cross_sell",
    "direction": "oneWay"
  },
  {
    "uuid": "eee11111-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "code": "up_sell",
    "direction": "oneWay"
  },
  {
    "uuid": "eee11111-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "code": "related",
    "direction": "oneWay"
  }
]

Create product relation type

Request

Creates a new product relation type.

Security
Bearer
Bodyapplication/jsonrequired
codestring[ 1 .. 100 ] charactersrequired

Code for the product relation type.

directionstringrequired

Direction of the relation. OneWay creates a directional relation. TwoWay creates a symmetrical relation visible from both products.

Enum"oneWay""twoWay"
reverseRelationTypeUuidstring or null(uuid)

For one-way relations, links to another relation type that represents the reverse perspective.

curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/product-relation-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "direction": "oneWay",
    "reverseRelationTypeUuid": "60459039-755e-4d4b-83ac-437f5db4f8a6"
  }'

Responses

Product relation type created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product relation type.

createdAtstring(date-time)required

Timestamp when this product relation type was created.

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

Timestamp when this product relation type was last modified.

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

Code for this product relation type.

directionstringrequired

Direction of the relation. OneWay creates a directional relation. TwoWay creates a symmetrical relation visible from both products.

Enum"oneWay""twoWay"
reverseRelationTypeUuidstring or null(uuid)

For one-way relations, links to another relation type that represents the reverse perspective. Example: 'accessory' links to 'compatible-with' so accessories show compatible products.

Response
application/json
{
  "uuid": "eee11111-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "code": "cross_sell",
  "direction": "oneWay"
}

Get product relation type

Request

Retrieves complete details for a single product relation type.

Security
Bearer
Path
productRelationTypeUuidstring(uuid)required

Unique identifier of the product relation type.

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

Responses

Successfully retrieved product relation type.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product relation type.

createdAtstring(date-time)required

Timestamp when this product relation type was created.

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

Timestamp when this product relation type was last modified.

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

Code for this product relation type.

directionstringrequired

Direction of the relation. OneWay creates a directional relation. TwoWay creates a symmetrical relation visible from both products.

Enum"oneWay""twoWay"
reverseRelationTypeUuidstring or null(uuid)

For one-way relations, links to another relation type that represents the reverse perspective. Example: 'accessory' links to 'compatible-with' so accessories show compatible products.

Response
application/json
{
  "uuid": "eee11111-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "code": "cross_sell",
  "direction": "oneWay"
}

Update product relation type

Request

Updates an existing product relation type. Only provided fields are updated.

Security
Bearer
Path
productRelationTypeUuidstring(uuid)required

Unique identifier of the product relation type.

Bodyapplication/jsonrequired
codestring or null[ 1 .. 100 ] characters

Updated code for the product relation type.

directioninteger or null(NullableOfRelationTypeDirection)

Updated direction of the relation.

reverseRelationTypeUuidstring or null(uuid)

Updated reverse relation type UUID.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/product-relation-types/{productRelationTypeUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "direction": 0,
    "reverseRelationTypeUuid": "60459039-755e-4d4b-83ac-437f5db4f8a6"
  }'

Responses

Product relation type updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this product relation type.

createdAtstring(date-time)required

Timestamp when this product relation type was created.

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

Timestamp when this product relation type was last modified.

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

Code for this product relation type.

directionstringrequired

Direction of the relation. OneWay creates a directional relation. TwoWay creates a symmetrical relation visible from both products.

Enum"oneWay""twoWay"
reverseRelationTypeUuidstring or null(uuid)

For one-way relations, links to another relation type that represents the reverse perspective. Example: 'accessory' links to 'compatible-with' so accessories show compatible products.

Response
application/json
{
  "uuid": "eee11111-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "code": "cross_sell_premium",
  "direction": "oneWay"
}

Delete product relation type

Request

Permanently deletes a product relation type. Cannot be undone.

Security
Bearer
Path
productRelationTypeUuidstring(uuid)required

Unique identifier of the product relation type.

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

Responses

Product relation type deleted successfully.

Response
No content

Product Tags

Operations

Product Terms

Operations

Organization Members

Operations

Organizations

Operations

Organization Roles

Operations

Locales

Operations

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